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 database引入了命名空间的概念,支持对模块进行分类和规划。
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。