xxl-job

最新推荐文章于 2024-05-29 20:05:54 发布

置顶 java开发日记

最新推荐文章于 2024-05-29 20:05:54 发布

阅读量6.8k

点赞数 4

分类专栏：分布式组件文章标签： xxl-job springboot xxl-job 分布式定时任务方案 boot xxljob 案例

本文链接：https://blog.csdn.net/jzx937345232/article/details/99292049

版权

分布式组件专栏收录该内容

3 篇文章 0 订阅

订阅专栏

xxl-job 定时任务分析:

XXL-JOB是一个轻量级分布式任务调度平台,调度采用中心式设计，“调度中心”基于集群Quartz实现并支持集群部署。任务分布式执行，任务"执行器"支持集群部署。

xxl-job 设计分两个模块 调度模块 , 执行模块（执行器）

调度模块 : 负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。调度系统
执行模块: 负责接收调度请求并执行任务逻辑.

所有展示案例全部采用springboot

xxl-job github 地址:https://github.com/xuxueli/xxl-job 将项目拉下来后面调度模块要用到

xxl-job 学习文档:http://www.xuxueli.com/xxl-job

拉下来的项目结构如下

里面的admin模块是我们要用到的最下面的samples 可以参考学习;

1.1: 执行sql脚本

执行doc 文件夹下面的mysql 脚本

1.2 修改admin的配置文件

1:修改端口号

2:修改数据库连接配置

修改为配置后启动项目访问地址:http://localhost:7001/xxl-job-admin/ 账户/密码 : admin/123456

这块有点小问题 sql脚本提供的密码登录不进去很尴尬... 只能手动修改
xxl_job_qrtz_user 修改admin 用户密码:e10adc3949ba59abbe56e057f20f883e 然后用123456就可以登录了

管理中心相关配置已经结束,下来介绍下

2 执行模块

项目结构图

2.1添加依赖xxl-job依赖

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

2.2 application.properties 配置文件

server.port=8084

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

###执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
#执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=192.168.112.227
xxl.job.executor.port=9999
xxl.job.login.username=admin
xxl.job.login.password=123456

xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
#执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
xxl.job.executor.logretentiondays=-1
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

2.3配置类展示XxlJobConfig.java

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 logger = 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 String 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(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.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;
    }

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


}

到此xxl-job handler 模块相关配置已经结束, 如何引用附下图

2.4 配置类

import com.dream.service.UserService;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import com.xxl.job.core.log.XxlJobLogger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * @author 单字j
 * @email:
 * @Date: 2019-05-06 15:30
 */
@Component
@JobHandler(value = "firstJobHandler")
public class TestJob extends IJobHandler {

    Logger logger = LoggerFactory.getLogger(TestJob.class);

    @Autowired
    private UserService userService;

    @Override
    public ReturnT<String> execute(String s) throws Exception {
        logger.info("job begin.................");
        //XxlJobLogger 这个日志类是xxl提供 用于在admin管理服务控制台查看先关job执行日志
        XxlJobLogger.log("log start");
        userService.getString( s);
        XxlJobLogger.log("log end");
        return new ReturnT("install success");

    }
}

代码层面编写已经结束。下面是调度中心相关配置

3 启动项目,并在调度中心创建对应执行器

简单解释下 appName 对应你的配置中的appName 注册方式就用自动的他会去mysql (xxl_job_qrtz_trigger_registry)表中去找

保存 5s后刷新下即可结果如下

3.2 创建玩执行器后进入任务管理页面创建对应的任务

说明下运行模式

  BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
    GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
    GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
    GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
    GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
    GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
    GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
- JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；