Javaxxl-job，使命调度中央快速上手 - Powered by Discuz! Archiver

用多少眼泪才能让你相信 发表于 2024-12-7 18:21:06

xxl-job，使命调度中央快速上手

前言

XXL-JOB是一个可以在WEB界面配置执行定时使命中心件，支持分布式服务调用，XXL-JOB自身也可以部署多个节点组成集群，本身是一个基于SpringBoot的Java WEB程序，我们可以通过下载GitHub源码进行部署。
一、XXL-JOB 安装教程

进入 xxl-job官网，里面有更具体的教程 XXL-JOB官网
1、下载源码

git clone http://gitee.com/xuxueli0323/xxl-job通过IDEA打开后目录如下：
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207180404360-122040880.png
2、初始化"调度数据库"

“调度数据库初始化SQL脚本” 位置为:
`/xxl-job/doc/db/tables_xxl_job.sql`没错，你得执行这个sql文件到你的数据库中，执行完后会有如下库和表出现在数据库中
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207180503216-1094656224.png
3、项目构造

[*]xxl-job-admin：调度中央
[*]xxl-job-core：公共依赖
[*]xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
[*] ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，本文章以这种方式介绍，官方推荐该方式；
[*] ：xxl-job-executor-sample-frameless：无框架版本；

好了~，到这一步你的XXL—JOB算是装好了，下一步让我们来启动它

二、启动调度中央前的准备

[*]调度中央项目：xxl-job-admin《超关键，起的就是这玩意儿》
[*]作用：统一管理使命调度平台上调度使命，负责触发调度执行，并且提供使命管理平台。
先修改一下调度中央xxl-job-admin的配置文件。
`/xxl-job/xxl-job-admin/src/main/resources/application.properties`主要修改数据库为本身的刚才执行sql的库
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://123.45.678.90:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=xxx用户
spring.datasource.password=xxx密码
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver然后启动项目
`xxl-job-admin/src/main/java/com/xxl/job/admin/XxlJobAdminApplication.java`调度中央访问地址：http://localhost:8080/xxl-job-admin(该地址执行器将会使用到，作为回调地址)
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207180039977-1370540478.png
三、启动执行器项目

1、maven依赖

确认执行器项目标pom文件中引入了 xxl-job-core 的maven依赖；
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${project.parent.version}</version>
</dependency>2、执行器配置

执行器配置，配置文件地址：
/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties执行器配置，配置内容说明：
# web port
server.port=8081
# 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://127.0.0.1:8080/xxl-job-admin

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

### xxl-job executor appname 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
### 执行器分组名称，关系到会注册到哪个组里
xxl.job.executor.appname=learn-xxl-job
### 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
xxl.job.executor.ip=
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主要就是xxl.job.admin.addresses 和 xxl.job.executor.appname 这俩，第一个必须指向正确的调度中央地址
3、创建启动配置文件

因xxl-job没有使用spring-boot-starter，需自行将配置类注入到spring容器中。
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;
}

/**
* 针对多网卡、容器内部署等情况，可借助 "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();
*/

}然后启动执行器，成功注册后，在调度中央可以看到
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207181607588-1123163569.png
四、编写一个定时使命

1、创建一个使命调度

注意@XxlJob(“sendSMS”)注解中的sendSMS，即使命的唯一名称，之后执行使命调度将会使用。
// 显示在调度中心日志的内容
XxlJobHelper.log("无参数执行一个定时/指定任务");
// 获取任务参数
XxlJobHelper.getJobParam();
// 用于在任务执行失败时向调度中心报告失败信息。调度中心会记录任务的失败状态，并可以根据配置进行相应的处理（如重试、告警等）。
XxlJobHelper.handleFail("参数传递异常");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;

/**
* @author Cyf
* @ Date: 2024/12/6 下午5:23
*/
@Component
public class MyJob {
public static final Logger log = LoggerFactory.getLogger(MyJob.class);

//    可使用@Resource/@Autowire注入执行器里中的其他服务
// @Autowired
// private UserService userService;

/**
* 无需参数传递
* @throws Exception
*/
@XxlJob("sendSMS")
public void sendSMS() throws Exception {

   // 记录任务开始的日志
   //只会显示再项目日志中
   log.info("slf4j的框架");
   //只会显示在xxl-job的日志中
   XxlJobHelper.log("无参数执行一个定时/指定任务");

}

/**
* 单个参数传递
* @throws Exception
*/
@XxlJob("oneParameter")
public void sendMessage() throws Exception {
   XxlJobHelper.log("单个任务参数为：" + XxlJobHelper.getJobParam());
}

/**
* 多个参数，应用 , 分割
* @throws Exception
*/
@XxlJob("moreParameters")
public void sendMessage2() throws Exception {
   try {
         // 获取参数
         String param = XxlJobHelper.getJobParam();
         String[] methodParams = param.split(",");

         XxlJobHelper.log("参数1为：" + methodParams + "，参数2为" + methodParams);
   }catch (Exception e){
         XxlJobHelper.handleFail("参数传递异常");
   }
}
}2、 xxl-job-admin中添加使命

在Cron中配置使命调度的时间周期，可选择CRON或固定速度。JobHandler中需配置@XxlJob注解中的名称。
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207181935332-1730213302.png
3、执行使命

https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207182240837-379071518.png
4、检察执行日志

https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207182438579-1695526650.png
项目日志
18:23:05.259 logback INFOc.x.j.e.service.jobhandler.MyJob - slf4j的框架4、定制化拦截器

可以通过Spring Aop拦截@XxlJob注解，去处置惩罚一些通用业务逻辑。
例如追加TraceId 进行日志定位
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.MDC;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.util.StopWatch;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.time.LocalDateTime;
import java.util.UUID;

/**
* @author 为每个执行器增加traceId
*/
@Slf4j
@Order(1)
@Aspect
@Component
public class XxlJobAspect {

@Pointcut("@annotation(com.xxl.job.core.handler.annotation.XxlJob)")
public void pointCut() {
}

@Around("pointCut() && @annotation(xxlJob)")
public Object doAround(ProceedingJoinPoint point, XxlJob xxlJob) {
   String traceId = UUID.randomUUID().toString();
   MDC.put("traceId", traceId);

   String jobName = xxlJob.value();
   StopWatch sw = new StopWatch();
   sw.start();
   log.info("定时任务[{}]开始，开始时间：{}，输入参数：{}", jobName, LocalDateTime.now(), XxlJobHelper.getJobParam());
   Object proceed;
   try {
         proceed = point.proceed();
   } catch (Throwable e) {
         log.warn("定时任务[{}]执行失败", jobName, e);
         failure(e, traceId);
         return null;
   }
   sw.stop();
   log.info("定时任务[{}]结束！执行时间：{} ms", jobName, sw.getTotalTimeMillis());
   success(traceId);
   return proceed;
}

private void failure(Throwable e, String traceId) {
   //将异常信息输出到xxl-job日志中
   XxlJobHelper.handleFail("traceId=" + traceId + ",
exception=" + getStackTrace(e));
   MDC.remove("traceId");
}

private void success(String traceId) {
   XxlJobHelper.handleSuccess("traceId=" + traceId);
   MDC.remove("traceId");
}

/**
* 该方法来捕获异常的堆栈跟踪信息，并将其转换为字符串
* @param e 异常信息
* @return 堆栈跟踪字符串
*/
private String getStackTrace(Throwable e) {
   StringWriter stringWriter = new StringWriter();
   PrintWriter printWriter = new PrintWriter(stringWriter);
   e.printStackTrace(printWriter);
   return stringWriter.toString();
}

}在日志中添加TraceId，快速定位使命链路
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">

<contextName>logback</contextName>
<property name="log.path" value="/data/applogs/xxl-job/xxl-job-executor-sample-springboot.log"/>

<property name="PATTERN" value="%d{HH:mm:ss.SSS} %contextName [%thread] [%X{traceId}] %-5level %logger{36} - %msg%n" />

<appender name="STDOUT" >
   <encoder>

         <pattern>${PATTERN}</pattern>
   </encoder>
</appender>

<appender name="file" >
   <file>${log.path}</file>
   <rollingPolicy >
         <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="file"/>

   <appender-ref ref="STDOUT"/>
</root>

</configuration>然后重启项目，再次执行使命将打印如下日志
18:23:05.254 logback INFOc.x.j.e.core.config.XxlJobAspect - 定时任务开始，开始时间：2024-12-07T18:23:05.254，输入参数：
18:23:05.259 logback INFOc.x.j.e.service.jobhandler.MyJob - slf4j的框架
18:23:05.260 logback INFOc.x.j.e.core.config.XxlJobAspect - 定时任务结束！执行时间：10 ms 为该次请求中的traceId，在调度日志中也会有：
https://img2024.cnblogs.com/blog/3535509/202412/3535509-20241207183553737-464244059.png
结束语

个人感觉这是个很强大的一款使命调度中央，从0到1帮助小白快速上手，如果此文章对你有帮助，希望留个赞再走 v

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

页: [1]

ToB企服应用市场:ToB评测及商务社交产业平台's Archiver

xxl-job，使命调度中央快速上手