xxl-job 使用方法(SpringBoot)

1 搭建xxl-job

1.1 运行tables_xxl_job.sql导入表结构

• 脚本位置…\xxl-job\doc\db\tables_xxl_job.sql
  

1.2 修改数据库配置信息

1.3 启动xxl-job-admin：调度中心

1.4 启动xxl-job-executor-sample-springboot 执行器

1.5 访问页面

• 进入登录页面 http://localhost:8080/xxl-job-admin
• 用户名密码在 xxl-job-admin 调度中心可以查看。
  

2 设置调度任务

2.1 执行器设置

• 这里的执行器使用的就是Springboot版本，通过Springboot管理执行器。
  
• 新增执行器管理中的AppName与xxl-job-executor-sample-springboot的配置文件的xxl.job.executor.appname保持一致
  也就是下图中的红框内容。
  

2.2 添加调度任务

• 在com.xxl.job.executor.service.jobhandler包下创建一个调度任务，如下举例：

@JobHandler(value="costManagerHandler")
@Component
public class CostManagerHandler extends IJobHandler {
    @Override
    public ReturnT<String> execute(String param) throws Exception {
        System.out.println("接受参数" + param +"\n费用管理");
        return SUCCESS;
    }
}

• 回到页面将刚刚创建的调度任务部署到任务管理模块中，任务管理→新增任务；
  
• 新增任务属性：

• 执行器：每个任务必须绑定一个执行器, 可在 “执行器管理” 进行设置;
• 任务描述：任务的描述信息，便于任务管理；
• 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
  • FIRST（第一个）：固定选择第一个机器；
  • LAST（最后一个）：固定选择最后一个机器；
  • ROUND（轮询）：；
• RANDOM（随机）：随机选择在线的机器；
• CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
  • LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
  • LEAST_RECENTLY_USED（最近最久未使用）：最久为使用的机器优先被选举；
  • FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
  • BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
  • SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
• Cron（这里设置的是每两秒执行）：触发任务执行的Cron表达式；
• 运行模式（这里选择BEAN）：
  • BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 “JobHandler” 属性匹配执行器中任务；
• JobHandler（新创建的CostManagerHandler）：运行模式为 “BEAN模式” 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
• 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
  • 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
  • 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
  • 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
• 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
• 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
• 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；
• 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
• 负责人：任务的负责人；
• 执行参数：任务执行所需的参数；

3 验证结果

3.1 启动执行费用管理任务

• 点击启动按钮，状态修改为Running；
  

3.2 查看业务执行情况

• 控制台按照周期输出任务参数，执行成功；
  

3.3 查看日志文件

• 日志文件的存放位置，在application.properties中的xxl.job.executor.logpath设置；
  
• 找到对应位置查看日志，每执行一次任务就会对应生成一个xx.log文件；
  
• 日志中主要包括 执行时间，执行参数，结束时间、执行结果、业务逻辑中向日志中插入的内容；
  
• 执行日志：需要通过 “XxlJobLogger.log” 打印执行日志；

XxlJobLogger.log("XXL-JOB, Hello World.");

• 打印情况如下；