xxl-job 分布式调度学习笔记

HainesFreeman

已于 2023-12-19 17:55:22 修改

阅读量150

点赞数

分类专栏： java 文章标签：学习笔记 java spring

于 2023-12-18 16:03:20 首次发布

本文链接：https://blog.csdn.net/weixin_41829196/article/details/135063329

版权

java 专栏收录该内容

58 篇文章 0 订阅

订阅专栏

1.概述

1.1什么是任务调度

业务场景：

上午10点，下午2点发放一批优惠券
银行系统需要在信用卡到期还款日的前三天进行短信提醒
财务系统需要在每天凌晨0:10分结算前一天的财务数据，统计汇总
不同系统间的数据需要保持一致，这时候需要执行数据同步

任务调度是为了自动完成特定的任务，在约定的特定时刻去执行任务的过程。

1.2 为什么需要分布式调度

使用Spring中提供的注解@Scheduled，也能实现调度的功能

在业务类中方法中贴上这个注解,然后在启动类上贴上`@EnableScheduling`注解

@Scheduled(cron = "0/20 * * * * ? ")
 public void doWork(){
 	//doSomething   
 }

感觉SprintBoot提供的注解可以完成任务调度的功能，好像已经完美的解决了问题，为什么还需要分布式调度呢？

主要以下几个原因：

高可用：单机版的定式任务调度只能在一台机器上运行，如果程序或者系统出现异常就会导致功能不可用。
防止重复执行：在单机模式下，定时任务是没什么问题的。但当我们部署了多台服务，同时又每台服务又有定时任务时，若不进行合理的控制在同一时间，只有一个定时任务启动执行，这时，定时执行的结果就可能存在混乱和错误了。
单机处理极限：原本1分钟内需要处理1万个订单，但是现在需要1分钟内处理10万个订单；原来一个统计需要1小时，现在业务方需要10分钟就统计出来。你也许会说，你也可以多线程、单机多进程处理。的确，多线程并行处理可以提高单位时间的处理效率，但是单机能力毕竟有限（主要是CPU、内存和磁盘），始终会有单机处理不过来的情况。

1.3 XXL-JOB介绍

XXL-JOB是大众点评的分布式调度平台，是一个轻量级的分布式任务调度平台，其核心设计目标是：开发迅速、学习简单、轻量级、易扩展。

大众点评目前已经接入xxl-job任务调度平台，该系统已经调度100万次，表现优异。

目前已有多家公司接入xxl-job，包括比较知名的大众点评，京东，优信二手车，360金融 (360)，联想集团 (联想)，易信 (网易)等等

官网地址：https://www.xuxueli.com/xxl-job/

系统架构图：

设计思想：

将调度行为抽象成“调度中心”公共平台，而平台自身并不承担业务逻辑，调度中心负责发起调度请求
将任务抽象成分散的JobHandler,交由“执行器”统一管理，执行器负责接收调度请求并执行对应的JobHandler中的业务逻辑

因此，调度和任务两部分可以相互解耦，提供系统整体的稳定性和扩展性。

链路：调度中心 ----> 执行器 -----> JobHandler

2.快速入门

2.1 下载源码

源码下载地址：

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

2.1 初始化调度数据库

下载源码后，解压源码，sql文件位置：

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

默认的database库名： xxl_job

数据库中表介绍：

xxl_job_group：执行器信息表，维护任务执行器信息；
xxl_job_info：用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
xxl_job_lock：任务调度锁表；
调度日志表：用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
xxl_job_log_report：调度日志报表：用户存储XXL-JOB任务调度日志的报表，调度中心报表功能页面会用到；
xxl_job_logglue：任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
xxl_job_registry：执行器注册表，维护在线的执行器和调度中心机器地址信息；
xxl_job_user：系统用户表；

  数据库中表介绍：

  - 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：系统用户表；

2.2 编译源码

2.2.1 源码目录解释：

doc :文档资料
xxl-job-admin :调度中心，项目源码
xxl-job-core :公共Jar依赖
xxl-job-executor-samples :执行器，Sample示例项目（大家可以在该项目上进行开发，也可以将现有项目改造生成执行器项目）

2.2.2 源码需要改动的点：

application.properties修改数据库连接信息，用户信息和密码
```
jdbc:mysql://127.0.0.1:3306/xxl-job2
```
logback.xml修改日志路径信息：/data/applogs/xxl-job/xxl-job-admin.log-->./data/applogs/xxl-job/xxl-job-admin.log

2.2.3 启动成功后，访问：http://localhost:8080/xxl-job-admin/

2.3 配置部署调度中心

2.3.1 调度中心项目配置（xxl-job-admin）

修改xxl-job-admin项目中的application.properties中的数据库及密码，完整配置如下：

(也可以在里面修改通知邮箱的地址)

### web
server.port=8080
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl-job2?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=jhh123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=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

### xxl-job, access token
xxl.job.accessToken=default_token

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

2.3.2 调度中心项目运行

1、运行`XxlJobAdminApplication`程序即可

2、调度中心访问地址: http://localhost:8080/xxl-job-admin

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

2.4 配置部署执行器项目

使用idea编辑器，新建一个sprintboot项目，然后进行如下修改：

2.4.1 添加Maven依赖

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

2.4.2 执行器配置

修改application.properties文件：

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
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=127.0.0.1
### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

2.4.3 添加执行器配置类

创建XxlJobConfig配置对象:

@Configuration
public class XxlJobConfig {
    @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() {
        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;
    }
}

2.4.4 添加任务处理类

添加任务处理类，交给Spring容器管理，在处理方法上贴上`@XxlJob`注解

@Component
public class HelloJobHandler {
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception{
        System.out.println("执行定时任务，执行时间："+ new Date());
    }
}

2.5 运行HelloWorld程序

2.5.1 任务配置&触发执行

登录调度中心,在任务管理中新增任务,配置内容如下:

点击保存：

2.5.2 查看日志

在调度中心的调度日志中就可以看到，任务的执行结果：

也可以在idea控制台查看日志，还可以在xxl-job生成的日志目录查看日志。

2.6 GLUE模式(Java)

任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。

（ “GLUE模式(Java)” 运行模式的任务实际上是一段继承自IJobHandler的Java类代码，它在执行器项目中运行，可使用[@Resource](https://github.com/Resource)/[@Autowire](https://github.com/Autowire)注入执行器里中的其他服务

添加Service

@Service

public class HelloService {

public void methodA(){

System.out.println("执行MethodA的方法");

}

public void methodB(){

System.out.println("执行MethodB的方法");

}

}

编写内容如下：

package com.xxl.job.service.handler;

import cn.wolfcode.xxljobdemo.service.HelloService;
import com.xxl.job.core.handler.IJobHandler;
import org.springframework.beans.factory.annotation.Autowired;

public class DemoGlueJobHandler extends IJobHandler {
    @Autowired
    private HelloService helloService;
    @Override
    public void execute() throws Exception {
        helloService.methodA();
    }
}

2.7 执行器集群

2.7.1 集群环境搭建

2.7.2 调度路由算法讲解

3. 分片功能讲解

3.1 案例需求讲解

3.1.1 初始化数据

3.1.2 集成Druid&MyBatis

3.1.3 业务功能实现

3.2 分片概念讲解

3.3 案例改造成任务分片

HainesFreeman

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
xxl-job 分布式调度学习笔记

上午10点，下午2点发放一批优惠券银行系统需要在信用卡到期还款日的前三天进行短信提醒财务系统需要在每天凌晨0:10分结算前一天的财务数据，统计汇总不同系统间的数据需要保持一致，这时候需要执行数据同步任务调度是为了自动完成特定的任务，在约定的特定时刻去执行任务的过程。XXL-JOB是大众点评的分布式调度平台，是一个轻量级的分布式任务调度平台，其核心设计目标是：开发迅速、学习简单、轻量级、易扩展。大众点评目前已经接入xxl-job任务调度平台，该系统已经调度100万次，表现优异。
复制链接

扫一扫

专栏目录