乐趣区

关于数据库:干货丨时序数据库DolphinDB代码模块复用教程

jiezi

在软件团队开发我的项目中，要晋升开发效率和品质，代码必然要进行封装和重用。在应用 DolphinDB 的脚本进行开发时，能够应用 module 和use办法，来申明和应用可重用模块。

  1. 模块介绍

在 DolphinDB 中，模块是指只蕴含函数定义的代码包。它具备以下特点：

  • 以.dos 作为模块文件的后缀，dos 是 DolphinDB script 的缩写
  • 模块文件保留在 DolphinDB 节点的[home]/modules 目录下
  • 模块文件第一行以申明模块语句 module moduleName 结尾
  • 模块文件内容仅蕴含函数定义
  1. 定义模块

2.1 创立模块目录

默认状况下，所有的模块定义在 [home]/modules 目录下，[home] 由系统配置参数 home 决定，能够通过 getHomeDir()函数获取。比方 DolphinDB 节点的 home 目录为 /root/DolphinDB/server，那么咱们须要在该目录下创立 modules 子目录来保留模块文件，最终模块目录为 /home/root/DolphinDB/server/modules。

2.2 创立模块文件

在 modules 目录下创立以.dos 为后缀的模块文件，比方 FileLog.dos。模块文件的第一行必须是模块申明语句。模块申明语句的语法如下：

module moduleName

moduleName 必须与模块文件的名称统一，比方在 FileLog.dos 中申明模块：

module FileLog

申明模块后，咱们能够开始编写模块代码。例如，FileLog.dos 的内容如下：

module FileLog
// 向指定日志文件写入日志
def appendLog(filePath, logText){f = file(filePath,"a+")
    f.writeLine(string(now()) + ":" + logText)
    f.close()}

在模块文件中，仅容许封装函数定义，其余非函数定义的代码将被疏忽。

3. 导入模块

在 DolphinDB 中，应用 use 关键字来导入一个模块。留神，use 关键字导入的模块是会话隔离的，仅对以后会话无效。导入模块后，咱们能够通过以下两种形式来应用模块内的自定义函数：

（1）间接应用模块中的函数：

use FileLog
appendLog("mylog.txt", "test my log")

（2）通过残缺门路来调用模块中的函数：

use FileLog
FileLog::appendLog("mylog.txt", "test my log")

4. 布局模块

DolphinDB 引入了命名空间的概念，反对对模块进行分类和布局。

4.1 申明模块命名空间

如果咱们须要对模块进行分类，能够通过多级门路为布局模块的命名空间。例如，现有两个模块 FileLog 和 DateUtil，它们的寄存门路别离为 modules/system/log/FileLog.dos 和 modules/system/temperal/DateUtil.dos，那么这两个模块相应的申明语句如下：

  • modules/system/log/FileLog.dos
module system::log::FileLog
  • modules/system/temperal/DateUtil.dos
module system::temperal::DateUtil

4.2 调用命名空间模块

咱们能够在 use 关键字后加残缺门路来导入命名空间下的模块。例如，导入 FileLog 模块：

use system::log::FileLog
// 全门路调用
system::log::FileLog::appendLog("mylog.txt", "test my log")
// 间接调用已导入模块中的函数
appendLog("mylog.txt", "test my log")

5. 在 GUI 中近程调试模块

当工作机和 DolphinDB 服务器不是同一台机器时，咱们在工作机上编辑的模块代码，不能间接在近程服务器的 DolphinDB 上通过 use 导入，须要先将模块文件上传到 [home]/modules 的对应目录，能力通过use 调用模块。

DolphinDB GUI 从 0.99.2 版本开始提供了近程同步模块的性能，具体用法如下图所示：

此操作会将 Modules 目录下的所有文件和子目录同步到 GUI 连贯的 DolphinDB 节点的 [home]/modules 目录下，同步实现后，就能够间接执行use 导入模块。

6. 注意事项

6.1 同名函数定义规定

不同模块能够定义雷同名字的函数。如果应用全门路调用函数，DolphinDB 能够通过模块命名空间来辨别函数名。如果间接调用函数：

  • 如果已导入的模块中只有一个模块蕴含该函数，DolphinDB 会调用该模块的函数。
  • 如果已导入的模块中有多个模块蕴含该函数，DolphinDB 解析脚本时会以下抛出异样：
Modules [Module1] and [Module2] contain function [functionName]. Please use module name to qualify the function.
  • 如果已导入模块中与自定义函数重名，零碎会默认应用模块中的函数。如果要调用自定义函数，须要申明命名空间。自定义函数和内置函数的默认命名空间为根目录，用两个冒号示意。比方：
// 定义模块
module sys
def myfunc(){return 3}

// 自定义函数
login("admin","123456")
def myfunc(){return 1}
addFunctionView(myfunc)

// 调用
use sys
sys::myfunc() // 调用模块的函数
myfunc() // 调用模块的函数
::myfunc() // 调用自定义函数
  • 如果已导入的模块中不蕴含该函数，DolphinDB 会在零碎内置函数中搜寻该函数。如果内置函数中也没有该函数，将抛出函数为定义的异样。

6.2 刷新模块定义

在开发阶段调试模块代码时，如果须要重复批改模块代码并刷新定义，只需从新执行模块文件中的代码即可，这种办法仅对以后会话无效。

6.3 模块间的相互调用

模块之间能够单向援用，比方模块 a 援用模块 b，模块 b 援用模块 c，不反对穿插援用，比方模块 a 援用模块 b，模块 b 援用模块 a。

欢送下载 DolphinDB database

退出移动版