轻量级任务调度平台xqiang-job使用实例

上文中介绍了任务调度平台。本文主要讲解使用。

实现方案

• DB存储任务相关信息
• 基于Quartz实现任务调度
  • 定时器，bean+方法反射方式调用。
• 基于Lauyi的页面后台管理

搭建一个SpringBoot项目

添加依赖

核心依赖

 <dependency>
   <groupId>com.github.xqiangme</groupId>
   <artifactId>xqiang-job-admin</artifactId>
   <version>0.0.2-RELEASE</version>
  </dependency>

全部依赖示例

  <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
    </parent>

    <properties>
        <java.version>1.8</java.version>
        <alibaba.druid.version>1.0.29</alibaba.druid.version>
        <mysql-connector.version>8.0.18</mysql-connector.version>
        <mybatis-spring-boot.version>1.3.1</mybatis-spring-boot.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <!-- 依赖 -->
    <dependencies>

        <dependency>
            <groupId>com.github.xqiangme</groupId>
            <artifactId>xqiang-job-admin</artifactId>
            <version>0.0.2-RELEASE</version>
        </dependency>

        <!-- spring-boot 相关 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis-spring-boot.version}</version>
        </dependency>
        <!-- mysql connector -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql-connector.version}</version>
        </dependency>
        <!-- druid 连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${alibaba.druid.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.5</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.67</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

        <!-- 以下依赖非必须  -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.4</version>
        </dependency>
    </dependencies>

添加配置

server.port=8083

#数据源 >>   配置
##连接地址
spring.datasource.url=jdbc:mysql://localhost:3306/job-admin?useUnicode=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false&serverTimezone=Asia/Shanghai&useSSL=false
#用户名
spring.datasource.username=root
#密码
spring.datasource.password=123456
#驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

#重启后是否初始化任务on|off
job.base.config.start= on
#项目名称key（当前项目唯一key）
job.base.config.project-key = common
#项目名称(例如：xx商城)
job.base.config.platform-name = 小强

#thymelea模板配置（必须）
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
spring.thymeleaf.mode=HTML
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.cache=false

#日志配置（可选）
logging.config=classpath:log4j.xml
logging.level.root=WARN
logging.level.com.example=debug
logging.level.com.xqiang.job.admin=debug

部分配置说明：
1.重启后是否初始化任务
job.base.config.start= on
如果设置了off，项目启动将不会自动启动任务。一般测试环境设置of


2.项目名称key（当前项目唯一key）
job.base.config.project-key = common
不同项目后台配置一个唯一Key,可以公用同一套任务管理表。会通过该属性来隔离。


3.项目名称(例如：xx商城)
job.base.config.platform-name = 小强
项目名称，建议5字以内，会在登录页与首页等展示配置的该名称
注意：数据不共享，如果要建立多个，平台的调度后台，还需要将超级管理员用户，补录对应的project-key

启动类

添加Job-admin扫描包地址配置

@ComponentScans({@ComponentScan(JobAdminOpenConstant.SCAN_PACKAGE)})

数据源配置

• 数据源配置上添加job-admin相关文件的扫描地址
  

示例Job

Demo工程

Demo工程源码地址：传送门

工程结构示例

Demo工程启动后访问：http://localhost:8083/job-admin/login
超级管理员账号：superadmin
管理员账号：admin
密码均为：123456 （可登录后修改）


注：为了防止项目中存在其他外部接口调用，工具中默认只拦截/job-admin下的请求地址。

程序日志

对应脚本来说如果出了问题，排除日志还是比较头疼的，所以在设计上加了logId的概念,在任务开启的时候设置一个logId,可以通过当前logId找到当前任务的执行日志。

关注程序员小强公众号更多编程趣事，知识心得与您分享