XxIJob入门-示例

一、部署 xxlJob

(一) 下载地址， git clone 到本地。

http://gitee.com/xuxueli0323/xxl-job

https://github.com/xuxueli/xxl-job

(二) 插入 xxl_job 的sql脚本：

在项目的 /xxl-job/doc/db/tables_xxl_job.sql ，找到sql脚本， 在数据库中执行。

执行 sql 后，修改项目的数据库连接信息，在 xxl-job-admin/src/main/resources/application.properties 修改，注意数据库名是 xxl_job， 账号密码不要填错 ：

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=xxx
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

(三) 修改 xxlJob 的日志路径：

在 xxl-job-admin/src/main/resources/logback.xml 修改 log 路径 ：

<property name="log.path" value="/data/applogs/xxl-job/xxl-job-admin.log"/>

(四) 启动 xxl 项目，进入xxl 后台管理系统

在 com.xxl.job.admin.XxlJobAdminApplication 找到启动类，并启动。

登录账号:admin

登录密码:123456

二、项目使用 xxlJob

（一）引入依赖：

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

（二）然后在 resources 目录下新建 logback.xml，并添加如下内容：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">

    <contextName>logback</contextName>
    <property name="log.path" value="./applogs/xxl-job/xxl-job-executor-sample-springboot.log"/>

    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n
            </pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>
</configuration>

(三) 修改 application.properties 文件：

# 启动端口
server.port=8089

# 日志配置
logging.config=classpath:logback.xml

### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

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

(四) 在以下地址，新增 xxlJob 的配置

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

如下：

@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;
    }
}

(五) 新增 jobHandler。

@Component
public class XxlJobDemo {


    @XxlJob("demoHandler")
    public ReturnT<String> demoHandler()  {
        System.out.println("=======================> Hello XXL-JOB!");
        String param = XxlJobHelper.getJobParam();
        XxlJobHelper.log("XXL-JOB, Hello World：{}",param);
        return ReturnT.SUCCESS;
    }

}

(六) 打开配置调度中心，找到执行器管理，点击新增：

(七)找到任务管理，并点击新增：

(八) 查看 调度日志：

三、XxlJob 启动日志报错：

• 报错一： ERROR c.x.job.core.util.XxlJobRemotingUtil - Connection refused: connect
  java.net.ConnectException: Connection refused: connect

解决方法：

要启动的类是 XxlJobAdminApplication ，而不是 XxlJobExecutorApplication 。

• 报错二：>>>>>>>>>>> xxl-job registry fail, registryParam:RegistryParam{registryGroup=‘EXECUTOR’, registryKey=‘xxl-job’, registryValue=‘http://192.168…:9999/’}, registryResult:ReturnT [code=500, msg=The access token is wrong., content=null]

解决方法：

application.properties 配置文件中的 xxl.job.accessToken 在不同的版本值不一样。

如果是 2.3.0 版本，xxl.job.accessToken 的值可以配置为：default_token

xxl.job.accessToken=default_token

如果是低版本，xxl.job.accessToken 需要换成 xxl.job.admin.accessToken，也就是：

xxl.job.admin.accessToken=default_token

XxlJob 管理界面的 调度日志报错：

点击 XxlJob 管理界面的【调度日志】，当【调度结果】为失败时，点击 【调度备注】，查看失败原因。

• 报错：

job handler [demoHandler] not found.

解决方法：

(1) 查看 代码中 @XxlJob 修饰的有没有 demoHandler。如： @XxlJob(“demoHandler”)。

(2) 查看配置的 【JobHandler】 是否正确， 选择的 【执行器】 是否正确。

(3) 查看项目启动日志，有没有以下错误：

xxl-job registry fail, registryParam:RegistryParam{registryGroup='EXECUTOR', registryKey='xxl-job', registryValue='http://192.168..:9999/'}, registryResult:ReturnT [code=500, msg=The access token is wrong., content=null]

如果有，那说明执行器 没有注册成功。

检查下 application.properties 文件的 xxl.job.accessToken 配置。

如果是 2.3.0 版本，xxl.job.accessToken 的值可以配置为：default_token

xxl.job.accessToken=default_token

如果是低版本，xxl.job.accessToken 需要换成 xxl.job.admin.accessToken，也就是：

xxl.job.admin.accessToken=default_token

参考资料：

https://blog.csdn.net/ca1993422/article/details/123723387