• SpringBoot 整合 xxl-job 指导手册

    分布式任务调度平台 xxl-job 安装与部署

    1、下载项目

    源码仓库地址：https://github.com/xuxueli/xxl-job

    2、初始化数据库

    “调度数据库初始化SQL脚本” 位置为:

    /xxl-job/doc/db/tables_xxl_job.sql

    调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;

    如果mysql做主从,调度中心集群节点务必强制走主库;

    3、 编译源码

    解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，源码结构如下：

    xxl-job-admin：调度中心
xxl-job-core：公共依赖
xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
    ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
    ：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用；
    ：xxl-job-executor-sample-frameless：无框架版本；
    ：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器；
    ：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器；
    ：xxl-job-executor-sample-jboot：jboot版本，通过jboot管理执行器；

    4、 配置部署“调度中心”

    调度中心项目：xxl-job-admin
作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

    步骤一：调度中心配置：

    调度中心配置文件地址：

    /xxl-job/xxl-job-admin/src/main/resources/application.properties

    调度中心配置内容说明：

    ### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
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
### 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN
## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

    步骤二：部署项目：

    如果已经正确进行上述配置，可将项目编译打包部署。

    调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

    默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

    ![输入图片说明](F:博客发布生产力工具SpringBoot 整合 xxx-job 指导手册img_6yC0.png)

    至此“调度中心”项目已经部署成功。

    SpringBoot 整合 xxl-job

    可参考 xxl-job 源码中的 xxl-job-executor-sample-springboot

    1、新建项目 springboot-xxl-job

    2、添加 maven 依赖

    <!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<!-- https://github.com/xuxueli/xxl-job/releases -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${最新稳定版本}</version>
</dependency>

    3、修改 application.properties 配置文件

    注意

    • xxl.job.executor.appname 在配置执行器是用到的名称, 执行器可以根据此名称自动获取机器地址
    ### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 执行器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=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

    4、创建执行器配置文件

    @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、引入依赖：
     *          <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();
     */


}

    5、创建任务JobHandler

    新建TestJobHandler执行器，仅打印几行日志，如下

    @Component
public class TestJobHandler {

    @XxlJob(value = "testJobHandler")
    public ReturnT<String> execute(String param) throws Exception {
        XxlJobLogger.log("===my TestJobHandler===");

        for (int i = 0; i < 5; i++) {
            System.out.println("=== : " + i);
            XxlJobLogger.log("=== : " + i);
        }
        return ReturnT.SUCCESS;
    }
}

    6、启动执行器

    @SpringBootApplication
public class SpringbootXxlJobApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootXxlJobApplication.class, args);
    }

}

    7、在调度中心中配置执行器

    前面已启动xxl-job-admin调度中心，进入http://localhost:8080/xxl-job-admin 管理界面

    7.1 点击 执行器管理--->新增执行器--->如下界面，然后填充此表格，点击保存

    image-20200809232714620

    参数介绍：

    　　AppName：是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;

    　　名称：执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;

    　　排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;

    　　注册方式：调度中心获取执行器地址的方式，

    　　　　自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；

    　　　　手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；

    　　机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

    在之前的 application.properties 文件中，配置 xxl.job.executor.appname=my-xxl-job-executor，如下图所示

    image-20200809232609330

    填写执行器信息

    image-20200809233043564

    填写完成后，刷新 执行器管理 页面，可以看到 xxl-job 已经自动关联机器地址

    image-20200809233018390

    8、在调度中心添加执行任务

    8.1 创建任务，点击 任务管理--->新增任务--->如下界面，然后填充此表格，点击保存

    image-20200809233356789

    参数介绍：

    　　执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置。

    　　任务描述：任务的描述信息，便于任务管理；

    　　路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
    　　　　　　FIRST（第一个）：固定选择第一个机器；
    　　　　　　LAST（最后一个）：固定选择最后一个机器；
    　　　　　　ROUND（轮询）：；
    　　　　　　RANDOM（随机）：随机选择在线的机器；
    　　　　　　CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
    　　　　　　LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
    　　　　　　LEAST_RECENTLY_USED（最近最久未使用）：最久为使用的机器优先被选举；
    　　　　　　FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
    　　　　　　BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
    　　　　　　SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
    　　Cron：触发任务执行的Cron表达式；
    　　运行模式：
    　　　　　　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值；
    　　阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
    　　　　　　单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
    　　　　　　丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
    　　　　　　覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
    　　子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
    　　任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
    　　失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；
    　　报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
    　　负责人：任务的负责人；
    　　执行参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入；

    9、启动任务及查看日志

    9.1 启动任务

    在任务管理界面，找到刚才创建的任务，启动定时任务

    image-20200809233543393

    启动后，定时任务的状态变为 RUNNING

    image-20200809233730035

    9.2 查看日志

    image-20200809233947212

    点击查看，获取执行信息

    image-20200809234010036

    9.3 点击"操作"列的"执行日志"按钮，显示如下

    image-20200809234240508

    image-20200809234149591

    参考资料

    https://www.xuxueli.com/xxl-job/
  • 相关阅读:
    最全Pycharm教程
    Django系列:（1）PyCharm下创建并运行我们的第一个Django工程
    用pycharm+django开发web项目
    python在不同层级目录import模块的方法
    Android GetTimeAgo(时间戳转换几天前，几分钟前，刚刚等)
    Fresco简单的使用—SimpleDraweeView
    django常用命令
    Android 浅谈 RxAndroid + Retrofit + Databinding
    云计算之路-阿里云上：负载均衡从七层换成四层后的意外发现团队
    云计算之路-阿里云上：因为网络问题，物理机换回虚拟机团队
  • 原文地址：https://www.cnblogs.com/dtdx/p/13467178.html
Copyright © 2020-2023  润新知