XXL-JOB(2)-使用

167 阅读2分钟

xxl-job给出了springboot集合xxljob的执行器demo,例如:xxl-job-executor-sample-springboot, 以xxl-job-executor-sample-springboot项目中的配置为例,可以写自己的执行器项目。 这里以xxl-job-executor-sample-springboot项目为例,梳理下springboot整合xxljob。

执行器服务配置(xxl-job-executor-sample-springboot)

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

application.properties

# web port
server.port=8083
# 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://10.211.55.6:8082/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=
### 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
### 执行器的ip
xxl.job.executor.ip=10.211.55.6
### 执行器的端口号
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

XxxljobConfig.java

package com.xxl.job.executor.core.config;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * xxl-job config
 *
 * @author xuxueli 2017-04-28
 */
@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;
    }
}

任务处理类

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


    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        String param = XxlJobHelper.getJobParam();
        logger.info("\ndemoJobHandler {}", param);
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }
}

启动执行器服务,查看日志,

13:00:37.261 logback [Thread-5] INFO  com.xxl.job.core.server.EmbedServer - >>>>>>>>>>> xxl-job remoting server start success, nettype = class com.xxl.job.core.server.EmbedServer, port = 9999
[root@10-211-55-6 executor]# netstat -auntpl|grep 9999
tcp6       0      0 :::9999                 :::*                    LISTEN      2220952/java        
[root@10-211-55-6 executor]# ps -ef | grep 2220952
root     2220952    6557  0 13:00 pts/2    00:00:09 java -jar xxl-job-executor-sample-springboot-2.3.0.jar
root     2341368  341594  0 13:55 pts/4    00:00:00 grep --color=auto 2220952
[root@10-211-55-6 executor]# netstat -auntpl|grep 8083
tcp6       0      0 :::8083                 :::*                    LISTEN      2220952/java        
[root@10-211-55-6 executor]# ps -ef | grep 2220952

查看9999/8083端口号可以看出,执行器xxl-job-executor-sample-springboot占用了两个端口号。

任务流转

  1. 调度中心启动
  2. 执行器注册到调度中心 通过启动执行器项目,把配置的执行器ip和执行器端口注册到调度中心,执行器可以有多个执行节点,注册地址:xxl-job-admin项目的api相关接口。如下图所示。

执行器中的注册节点

会利用netty 开启一个server, port: 9999,该server执行任务处理bean。 还会开启有一个ExecutorRegistryThread线程,不断地注册自己

  1. 在调度中心配置执行器的任务

配置执行任务

  1. 手动/定时执行任务,

2021-08-25-13-04-16.png