springcloud：快速上手定时任务框架xxl-job（十五）

0. 引言

实际开发中，我们常常遇到需要定时执行的任务，我们可以利用定时线程池或schedule框架等来实现定时任务，但这些方式都有效率、性能上的缺陷，在微服务框架下，我们期望一种更加规整、轻量、可靠的定时任务框架来帮助我们实现定时任务，以及可视化的管理定时任务。

在这样的需求下，国产定时任务框架xxl-job应运而生。

1. xxl-job简介

xxl-job是分布式的任务调度平台，以作者名字命名，以其轻量、可视、易上手迅速在微服务框架下站稳脚跟。xxl-job分为服务端和客户端，客户端也就是我们的定时任务方法实现，也称为执行器，而服务端用来管理定时任务配置以及记录执行情况，也称为调度器

官方文档：https://www.xuxueli.com/xxl-job/

2. xxl-job安装

1、在xxl-job github仓库](https://github.com/xuxueli/xxl-job/releases)，下载源码，我这里直接选择最新版下载

2、在idea中以maven形式打开该项目，其中的xxl-job-admin就是我们要安装的服务端，可以看到该服务端其实就是一个springboot项目，xxl-job-core是公共依赖，xxl-job-executor-samples是客户端的示例代码

3、在doc文件夹下找到tables_xxl_job.sql文件

利用该文件创建数据库xxl-job

4、在xxl-job-admin项目中的resource文件夹下的application.properties配置文件，修改其数据库地址、服务端口号、数据库连接池、预警发送邮箱等信息

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

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

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.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
[email protected]
[email protected]
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
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

5、logback.xml是日志配置文件，如果要修改日志保存路径，可以在此配置，启动项目时如果没有配置的日志文件夹会报错，所以提前修改好日志路径

6、本地启动服务端的话，只需要运行该xxl-job项目即可，如果要将服务端发布到服务器上，将其打包，然后放到服务器上运行即可

这里为了照顾部分初学者，详细讲解下打包发布流程，如果掌握的同学，可直接跳过

2.1 发布xxl-job-admin到服务器

1、修改配置文件数据库地址

2、修改预警发送邮箱，如果不知道如何获取邮箱授权码的可以参考我这篇文章：https://wu55555.blog.csdn.net/article/details/127156042

不需要预警可不用配置

3、修改日志路径

4、打包xxl-job-admin

5、将打包出来的jar包上传到目标服务器（因为是java项目，请提前在服务器上安装jdk）

6、创建日志文件夹

mkdir -p /data/logs/xxl-job-2.4.0/log

7、因为我们配置的默认的8080端口，所以需要开启8080端口，如果没有开启防火墙则不用开启端口

firewall-cmd --add-port=8080/tcp --permanent
firewall-cmd --reload

8、启动xxl-job-admin

# 前台启动，关闭窗口或者ctrl+c会关闭项目
java -jar xxl-job-admin-2.4.0.jar
# 后台启动，关闭窗口或者ctrl+c不会关闭项目
nohup java -jar xxl-job-admin-2.4.0.jar & 

9、访问项目：服务器ip:8080/xxl-job-admin，默认登陆账号密码：admin/123456

3. 客户端定时任务书写

1、这里我们创建一个springboot项目，用来书写定时任务

2、引入依赖，版本与服务端版本保持一致

<dependency>
            <groupId>com.xuxueligroupId>
            <artifactId>xxl-job-coreartifactId>
            <version>2.4.0version>
dependency>

3、修改配置文件

# 服务端地址
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=job-server
# 执行器注册地址，默认使用address，否则使用ip:port，这是注册到服务端的地址
xxl.job.executor.address=
# 执行器ip
xxl.job.executor.ip=
# 执行器端口
xxl.job.executor.port=9998
### xxl-job executor log-path
xxl.job.executor.logpath=/data/logs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

4、创建配置类XxlJobConfig

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.accessToken}")
    private String accessToken;

    @Value("${xxl.job.executor.appname}")
    private String appname;

    @Value("${xxl.job.executor.address}")
    private String address;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appname);
        xxlJobSpringExecutor.setAddress(address);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }

    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     *      1、引入依赖：
     *          
     *             org.springframework.cloud
     *             spring-cloud-commons
     *             ${version}
     *         
     *
     *      2、配置文件，或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */


}

5、我们创建一个定时方法，可以看到只需要在需要定时执行的方法上加一个@XxlJob注解即可，其属性值是这个定时方法的名称，后续会在服务端配置，要保证唯一

同时注意定时任务类要声明为bean，即加上@Component

@Component
public class JobService {

    @XxlJob("testJob")
    public void testJob() throws Exception {
        String param = XxlJobHelper.getJobParam();
     
        System.out.println("执行定时任务，参数为："+param);

    }
}

4. 服务端配置

xxl-job-admin服务端有如下几个菜单

运行报表：定时任务运行情况统计
任务管理：配置的定时任务
调度日志：每个定时任务的具体执行日志
用户管理：账号管理，可针对执行器配置权限
执行器管理：执行器就是客户端，也就是后台的定时任务方法

1、首先我们需要新增一个执行器，这里选择自动注册，有时我们要进行联调，需要指定执行器为我们本地的执行器，这时可以用手动录入ip的注册形式，地址就是我们之前配置的xxl.job.executor.address或xxl.job.executor.ip+xxl.job.executor.port

注意：这里的appName要与客户端中配置的xxl.job.executor.appname保持一致

手动录入形式：

2、启动执行器项目，即上述创建的job-server项目

3、进入任务管理，执行器切换为我们刚新建的执行器，然后新建一个任务

4、配置任务名，cron表达式（这里我配置的每秒执行一次），JobHandler就是我们之前在客户端书写的定时任务名称，即@XxlJob注解的值

其中各项配置说明如下：

• 调度类型：

支持3种调度模式corn表达式
cron: 自由配置定时间隔；无：手动触发执行；固定：固定周期执行，比如30s执行一次

• 运行模式

默认为BEAN，从执行器调度方法，还可以配置GLUE模式，配置后在列表页会出现一个GULE按钮，点击可以进入在线书写对应语言的代码，相当于一个在线书写的执行器方法，也就是客户端任务以源码的方式维护在调度中心，支持java,shell,python等语言

• 任务参数

可以设置固定的任务参数，或者留空，也可以在手动执行的时候填写任务参数，比如一些按照日期执行的定时任务，想要回去执行历史日期的，就可以将参数定为日期，不填就默认为当天

• 路由策略

当存在多个执行器时就需要配置路由策略，也就是负载均衡策略，比较常用的就是轮询

• 子任务ID

如果需要在当前任务执行完成后，联动触发下一个任务，则可配置子任务，ID在列表中可查看到

• 调度过期策略

支持两种策略，为什么会出现过期，我们将在后续单独讲解
忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；

• 阻塞处理策略

对于任务太多太密集，导致执行器来不及执行时，所采取的策略，支持如下三种
单机串行（默认）：进入等待队列，先进先出，等着执行；
丢弃后续调度：丢弃，不管了
覆盖之前调度：终止正在运行的调度任务，并清空等待队列，然后运行当前任务

• 任务超时时间

任务运行超过超时时间就会直接中断

• 失败重试次数

任务失败后进行重试的次数

对于没有掌握cron表达式的同学，可以通过这个网站来帮我们书写cron表达式，通过勾选即可生成想要的cron表达式

https://cron.qqe2.com/

5、创建好的任务默认是关闭的，还需要启动任务，如果任务只需要执行一次，可以选择不启动，手动点击执行一次即可

6、启动好的项目状态为running

7、我们查看job-server就能看到任务正在执行了

8、可以看到这里参数为空，这是因为我们在服务端配置任务时没有配置参数，我们通过手动执行一次，执行参数给大家看下效果

总结

至此，咱们针对定时任务框架xxl-job的讲解就结束了，自己搭建起来试下吧