xxl-job是一个分布式任务调度平台,本身就算是一个项目,我们可以将xxl-job这个项目引入到自己的业务中,实现自己项目的定时任务的调度,由于xxl-job还带有可视化操作的界面,让定时任务的设置更加直观和简单好用。

xxl-job官网:分布式任务调度平台XXL-JOB

xxl-job作者个人开源社区:XXL开源社区 | 首页

下面是xxl-job的简单示例,首先访问分布式任务调度平台XXL-JOB,可以选择通过github获取
xxl-job的源码或者通过gitee获取

由于国内访问github比较慢,所以我们通过gitee获取源码:https://gitee.com/xuxueli0323/xxl-job或者通过网盘获取链接: https://pan.baidu.com/s/1pXX1QOea11yDlgHlvNVvnw 提取码: gtef 

获取到压缩包将项目压缩包解压缩

文件内容如下 ,打开doc->db可以看见有一个sql文件,我们将这个sql文件用navicat打开并执行

 

-表说明
- xxl_job_group:执行器信息表,用于维护任务执行器的信息
- xxl_job_info:调度扩展信息表,主要是用于保存xxl-job的调度任务的扩展信息,比如说像任务分组、任务名、机器的地址等等
- xxl_job_lock:任务调度锁表
- xxl_job_log:日志表,主要是用在保存xxl-job任务调度历史信息,像调度结果、执行结果、调度入参等等
- xxl_job_log_report:日志报表,会存储xxl-job任务调度的日志报表,会在调度中心里的报表功能里使用到
- xxl_job_logglue:任务的GLUE日志,用于保存GLUE日志的更新历史变化,支持GLUE版本的回溯功能
- xxl_job_registry:执行器的注册表,用在维护在线的执行器与调度中心的地址信息
- xxl_job_user:系统的用户表

接着通过idea打开xxl-job-master项目 

可以看到里面包含了三个项目,我们现在只关注xxl-job-admin这个

打开application.properties配置文件,修改xxl-job-admin配置文件applicationk.properties的数据库链接,设置成你自己的数据库相关信息

修改xxl-job-admin配置文件application.propertiesk中xxl-job的token值,默认值为default_token,可以随意设置比如123456,也可以不设置,使用默认值,但如果设置了,在后面自己的业务中,也需要在配置文件中添加相同的token值

以上操作完成后,启动 xxl-job-admin ,访问地址,http://localhost:8080/xxl-job-admin/toLogin ,账号admin 密码123456

二、自己重新创建一个项目,假设新创建的项目就是你的业务项目

首先打开新创建的项目,引入xxl-job的核心maven配置 项目结构如下

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

在application.properites 文件中添加配置属性,注意这里的xxl.job.accessToken需要和上面xxl-job-admin的配置文件中的值一致。

spring.application.name=xxl-job_demo
server.port=8088

logging.config=classpath:logback.xml
#调度中心部署地址,多个配置逗号分隔 "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

#执行器token,非空时启用 xxl-job, access token
xxl.job.accessToken=default_token

# 执行器app名称,需要和调度中心可视化控制台执行器那边配置一样的名称,不然注册不上去
xxl.job.executor.appname=test-xxl-job

# [选填]执行器注册:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
#从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=

#[选填]执行器IP :默认为空表示自动获取IP(即springboot容器的ip和端口,可以自动获取,也可以指定),多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务",
xxl.job.executor.ip=

# [选填]执行器端口号:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999  

#执行器日志文件存储路径,需要对该路径拥有读写权限;为空则使用默认路径
xxl.job.executor.logpath=/data/logs/xxl-job/executor

#执行器日志保存天数
xxl.job.executor.logretentiondays=30

创建XxlJobConfig 配置类

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;

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

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

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

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

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

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

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

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

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

        return xxlJobSpringExecutor;
    }
}

创建定时任务类 

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.time.LocalTime;

@Component
public class XxlJobTask {

    private Logger log = LoggerFactory.getLogger(XxlJobTask.class);
    //@XxlJob的值demoJobHandler 需要在xxl-job-admin可视化界面的新增任务中配置为JobHandler的值
    //@XxlJob(value = "demoJobHandler", init = "init", destroy = "destroy")
    @XxlJob("demoJobHandler1")
    public void demoJobHandler1() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        System.out.println("定时任务执行了,时间:"+ LocalTime.now());

    }


    //@XxlJob的值demoJobHandler 需要在xxl-job-admin可视化界面的新增任务中配置为JobHandler的值
    @XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
    public void demoJobHandler2() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        System.out.println("定时任务执行了,时间:"+ LocalTime.now());

    }

    private void init() {
        log.info("init 方法调用成功");
    }

    private void destroy() {
        log.info("destroy 方法调用成功");
    }
}

在resource目录下创建日志文件 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="/data/logs/xxl-job/app.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>

 运行新创建的项目

三、新增执行器,打开xxl-job-admin可视化调度中心的页面按照下面的步骤新增执行器,注意AppName填新创建的项目的application.properties中xxl.job.executor.appname设置的值,要保持一致,注册方式选择自动注册如下图,完成后点保存,新增成功

新增任务管理,按下图填写,负责人记得填一下,保存,新增成功  cron表达式:0/5 * * * * ?

 执行定时任务,点击操作,可以选择执行一次,点击执行一次,程序会执行一次,点击启动,程序将按照cron表达式设置的值进行执行

执行一次结果,直接保存不用填值

可以看见idea中的程序执行了一次 

调度日志中出现一条记录 ,就是刚刚执行的记录

 点击启动执行,确定启动,可以看见idea中的定时任务已经按照cron表达式的值每5秒执行一次

调度日志中出现执行记录

最后在任务管理中停止定时任务,任务停止执行 ,至此已完成将xxl-job引入自己业务项目

四、最后打开xxl-job-master项目可以看见xxl-job-executor-sample-springboot的内容和我们刚刚创建的项目结构和代码类似,其实这个就是xxl-job提供的简单示例,xxl-job-executor-sample-springboot这个是使用springboot框架的集成方式,另一个是不使用框架的方式,自己可以研究一下xxl-job提供的示例加深一下理解

Logo

更多推荐