Quick-Task 动态脚本支持框架整体介绍篇
一个简单的动态脚本调度框架,支持运行时,实时增加,删除和修改动态脚本,可用于后端的进行接口验证、数据订正,执行定时任务或校验脚本
本项目主要涉及到的技术栈:
- groovyEngine (groovy脚本加载执行)
- commons-io (文件变动监听)
I. 使用姿势
1. pom配置
添加仓库地址
<repositories> <repository> <id>yihui-maven-repo</id> <url>https://raw.githubusercontent.com/liuyueyi/maven-repository/master/repository</url> </repository> </repositories> 复制代码
添加项目依赖
<dependency> <groupId>com.git.hui</groupId> <artifactId>task-core</artifactId> <version>0.0.1</version> </dependency> 复制代码
2. 使用demo
a. 源码方式
源码下载之后的使用case,可以参考 com.git.hui.task.AppLaunch
,运行main方法,监听./task-core/src/test/java/com/git/hui/task
目录下脚本的变动即可
b. jar包引用
首先准备一个Groovy脚本,放在指定的目录下,如 /tmp/script/DemoScript.groovy
package com.git.hui.task import com.git.hui.task.api.ITask class DemoScript implements ITask { @Override void run() { println name() + " | now > : >>" + System.currentTimeMillis() } @Override void interrupt() { println "over" } } 复制代码
对应的启动类可以如下
public class AppRunner { // main 方式 public static void main(String[] args) throws Exception { new ScriptExecuteEngine().run("/tmp/script/"); Thread.sleep(24 *60 * 60 * 1000); } // junit 方式启动 @Test public void testTaskRun() { new ScriptExecuteEngine().run("/tmp/script/"); Thread.sleep(24 *60 * 60 * 1000); } } 复制代码
c. 测试
应用启动完毕之后
- 可以修改
/tmp/script/DemoScript.groovy
脚本的内容,保存后查看是否关闭旧的脚本并执行更新后的脚本 - 测试在
/tmp/script
目录下新增脚本 - 测试删除
/tmp/script
目录下的脚本 - 测试异常的case (如非法的groovy文件,内部运行异常等...)
注意 不要在groovy脚本中执行 System.exit(1)
, 会导致整个项目都停止运行
II. 设计原理
基本结构如下图
从图中基本上也可以看出,这个项目的结构属于非常轻量级的,核心角色,有下面几个
- Task : 具体的任务脚本
- TaskContainer: 持有执行任务的容器
- TaskChangeWatcher: 任务观察器,用于查看是否有新增、删除or修改任务,从而卸载旧的任务,并加载新的任务
另外一块属于扩展方面的插件体系,目前并没有给与实现,若将本框架继承在Spring生态体系中运行时,这些插件的支持就特别简单了
- RedisTemplate
- RestTemplate
- AmqpTemplate
- xxxTemplate