xxl-job简单介绍以及集成在SpringBoot

xxl介绍

XXL-JOB 是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

设计思想是将调度行为抽象形成调度中心平台，平台本身不承担业务逻辑，而是负责发起调度请求后，由执行器接收调度请求并执行任务，这里的任务抽象为分散的 JobHandler。通过这种方式即可实现调度与任务相互解耦，从而提高系统整体的稳定性和拓展性。官方文档官方git

简单使用

admin模块

克隆 git项目在本地

使用idea打开会发现三个模块

模块名称	模块说明
xxl-job-admin	调度中心,提供管理平台UI界面,真实开发场景中一般将其进行单独打包部署
xxl-job-core	公共依赖模块，项目整合xxl-job时,需要导入该依赖
xxl-job-executor-samples	demo案例

在mysql数据库中导入sql文件,在项目目录的doc/db路径下

表名	说明
xxl_job_group	保存执行器信息,新添加的执行器均在此表中保存
xxl_job_info	用户保存任务信息，包括任务所属执行器，执行频次，过期策略等
xxl_job_lock	任务调度锁
xxl_job_log	保存调度结果、执行结果、调度入参、调度机器和执行器
xxl_job_log_report	用于记录任务执行的成功次数，失败次数，一般以天为维度
xxl_job_logglue	任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能
xxl_job_registry	执行器注册表，维护在线的执行器和调度中心机器地址信息
xxl_job_user	系统用户表，用于登录admin控制台，使用MD5加密

进入admin模块修改application中的配置信息将表名修改成数据库地址和账号密码改成自己的实例

yml
### web
server.port=8080
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.base-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.web.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=false
spring.mail.properties.mail.smtp.starttls.enable=false
spring.mail.properties.mail.smtp.starttls.required=false
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, access token
xxl.job.accessToken=default_token

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

访问管理界面 http://localhost:配置文件端口号/xxl-job-admin/

executor模块

配置application文件示例

yml
# web port
server.port=8081
# no web
#spring.main.web-environment=false

# log config
logging.config=classpath:logback.xml


### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

### xxl-job, access token
xxl.job.accessToken=default_token

### xxl-job executor appname
xxl.job.executor.appname=xxl-job-executor-sample
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

在service\jobhandler目录下创建testjob类,用最简单的Bean任务来说明

java


@Component
public class TestXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);


    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
    }

调度中心使用

输入上面的管理页面地址,默认密码是


admin 123456

进入执行器管理

添加执行器,appname就是在executor模块application中配置的appname,名称可以自定义,机器地址是这个executor模块运行的ip地址和端口信息,可以选择自动注册,不需要填写机器地址

配置任务管理

添加任务,执行器选择我们刚刚添加的那个,JobHanlder名称就是我们写的任务时,方法名上注解里的名称其他选项根据要求调整

引入项目

有两种方式第一种就是直接用官方的项目打包,admin调度中心使用官方的,自己的项目只需要引入core依赖,以及executor-sample模块中的XxlConfig文件,写个任务就可以开始使用了

或者将admin模块搬到自己项目,根据需要调整下,比如官方的mysql的数据库,公司使用oracle的话就很不方便,不可能再搭建一个数据库,将admin搬过去进行数据库改造以及方便管理,excutor可以独立出来专门来作为写任务的地方,使用openFeign调用其他模块的内容

我举个例子微服务框架是eureka,那么我的excutor就需要引入依赖

xml

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

application中配置eureka注册中心的信息

yml
# web port
server:
  port: 8081
spring:
  application:
    name: rec-xxl-executor

eureka:
  client:
    service-url:
      defaultZone: http://localhost:7777/eureka
xxl:
  job:
    admin:
      # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。
      # 执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      addresses: http://127.0.0.1:8080/xxl-job-admin
    # 执行器通讯TOKEN [选填]：非空时启用；
    accessToken: default_token
    executor:
      # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      appname: xxl-job-executor-mileage
      # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
      #从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；
      # 地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: 8088
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath: /data/applogs/xxl-job/jobhandler
      # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logretentiondays: 30
logging:
  config: classpath:logback.xml

启动类上开启


@EnableFeignClients

创建调用服务类

java


@Service
@FeignClient("test-mode")
public interface MedicalRecordService {
   @GetMapping("/api/stampJob/getList?num={i}")
   List<testEntity> getList(@PathVariable("i") int i);

   @PostMapping("/api/stampJob/test1")
   String test1(@RequestBody testEntity e);

   @PostMapping("/api/stampJob/test2")
   String test2(@RequestParam String  data);

   @PostMapping("/api/stampJob/test3")
   Map<String, Object> test3(@RequestBody testEntity entity, @RequestParam  String fileStr);

   @PostMapping("/api/stampJob/test4")
   boolean updateDetailIndex(@RequestBody List<testEntity> updateList);
}

jobhandler 直接使用这个服务类的接口就好了