docs: 添加第一版文档.

添加基本文档, 包括 Readme, 安装使用等.
This commit is contained in:
2021-08-16 00:40:19 +08:00
parent e317b07913
commit 712ce9df4a
10 changed files with 122 additions and 0 deletions

View File

@ -0,0 +1,47 @@
## Groovy 脚本编写
### 基本格式
Groovy 语言的脚本基本格式如下:
```groovy
info {
// 脚本信息, 遵循 Java 的 GAV 规则.
// 脚本英文名
artifact 'demo'
// 所属组(如果有域名, 就是自己的域名的倒序, 例如 tieba.baidu.com 就是 com.baidu.tieba)
// 如果没有, 也可以用 github 的.
group 'org.example'
// 脚本版本号.
version '0.0.1'
}
// 注册触发器.
// 目前触发器有两种选择
// once 单次触发器: 只会运行一次.
// timer 定时器触发器: 根据设定的 cron 表达式定时运行.
trigger("once") {
// once 触发器没有参数.
// 运行代码块, 要执行的东西都在这个代码块里.
run {
// 在这里做些什么, 比如
println "From script."
}
}
// 在外面可以定义一些全局变量.
def formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")
// 这里注册定时器触发器.
trigger("timer") {
// time 参数指定 Cron 表达式, 像这样设置表达式字符串后就可以了.
time "0 0/1 * * * ? "
run {
// 在这里做些什么, 比如
println "当前时间: ${formatter.format(LocalDateTime.now())}"
}
}
```
Groovy 语言比较贴近 Java实际开发与 Java 没什么区别(相比于 Java 多了不少语法糖,但还是兼容 Java 的)。