文章目录
前言
我们已经熟悉并使用了xxl-job 进行任务调度，作为服务端的xxl-job 的工作过程是怎样的，本文进行介绍。
一、xxl-job-服务端作用：
xxl-job-admin 是 xxl-job 的后台管理系统，主要负责任务的调度、监控和管理。以下是 xxl-job-admin 的主要作用：
-
任务管理：xxl-job-admin 提供了任务的添加、编辑、删除等功能，可以方便地管理任务的调度信息、执行器配置、任务定时触发规则等。
-
. 任务监控：xxl-job-admin 可以查看任务的运行状态、执行日志、执行情况统计等，帮助管理员实时监控任务的执行情况。
-
. 任务调度：xxl-job-admin 负责根据任务的触发规则和调度策略，将任务分发给执行器执行，确保任务按时执行。
-
. 任务报警：xxl-job-admin 支持配置任务执行超时报警、失败重试等功能，及时通知管理员任务执行状态异常。
-
. 任务日志管理：xxl-job-admin 可以查看、搜索和导出任务的执行日志，方便排查和分析任务执行问题。
-
. 执行器管理：xxl-job-admin 可以管理执行器的注册、心跳监控等，确保执行器正常运行并可接收任务分发。
-
. 集群管理：xxl-job-admin 支持多台 xxl-job-admin 的集群部署，管理员可以管理多个 xxl-job-admin 实例间的任务调度和数据同步。
总的来说，xxl-job-admin 在 xxl-job 系统中起着核心的管理和监控作用，帮助用户管理任务、监控任务执行情况、处理异常情况，保障任务的准确、稳定和高效执行。
二、启动过程：
2.1.拦截器加载：
服务端启动 在WebMvcConfig 中会加载两个拦截器：
package com.xxl.job.admin.controller.interceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.annotation.Resource;
/**
* web mvc config
*
* @author xuxueli 2018-04-02 20:48:20
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Resource
private PermissionInterceptor permissionInterceptor;
@Resource
private CookieInterceptor cookieInterceptor;
/**
* 多个拦截器 按照addInterceptor 的先后顺序进入
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 权限拦截器 对所有请求进行拦截，判断登录以及 人员权限的访问
registry.addInterceptor(permissionInterceptor).addPathPatterns("/**");
// cookie 拦截器对所有请求进行拦截 放入cookie 信息
registry.addInterceptor(cookieInterceptor).addPathPatterns("/**");
}
}
PermissionInterceptor 和 CookieInterceptor 拦截器的内容这里不在具体展开，相信大家都是有经验的开发人员；
2.2. 配置初始化XxlJobAdminConfig：
2.2.1 XxlJobAdminConfig 配置文件介绍：
XxlJobAdminConfig 是 xxl-job-admin 的配置类，用于配置 xxl-job-admin 的相关参数和属性，以实现对 xxl-job-admin 的自定义配置和定制。具体作用如下：
-
配置注册中心：通过 XxlJobAdminConfig 可以配置 xxl-job-admin 的注册中心，包括注册中心的地址、端口、用户名、密码等，用于管理 xxl-job 的执行器和任务。
-
配置调度中心：XxlJobAdminConfig 可对 xxl-job-admin 的调度中心进行配置，包括调度中心的地址、端口、心跳时间间隔等，用于任务的调度、分发和监控。
-
配置任务执行器：可以配置 xxl-job-admin 需要管理的执行器的信息，包括执行器的配置、注册信息、心跳间隔等，以便正确管理执行器的注册和心跳监控。
-
配置日志存储：XxlJobAdminConfig 还可以配置任务执行日志的存储策略，包括日志保存的路径、保留时间、清理规则等，以便管理任务执行日志。
-
其他相关配置：XxlJobAdminConfig 中还可能包含其他相关的配置项，如任务线程池配置、报警配置、集群配置等，用于定制化管理 xxl-job-admin 的各项功能和特性。
总的来说，XxlJobAdminConfig 是 xxl-job-admin 的配置类，通过对该类进行配置，可以实现对 xxl-job-admin 的不同功能和属性进行自定义和调整，以满足用户对 xxl-job-admin 的特定需求。
以下部分是其源码，我们进行每行的注释
package com.xxl.job.admin.core.conf;
import com.xxl.job.admin.core.alarm.JobAlarmer;
import com.xxl.job.admin.core.scheduler.XxlJobScheduler;
import com.xxl.job.admin.dao.*;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import javax.sql.DataSource;
import java.util.Arrays;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
/** Component 告诉spring 这是一个bean 项目启动初始化bean 容器后也需要实例化
* XxlJobAdminConfig 为一个单例bean
* 实现 InitializingBean 接口，意味着 XxlJobAdminConfig 被实例化话和属性注入后，
* 调用afterPropertiesSet 方法完成一些初始化工作
* 实现 DisposableBean 接口，意味着 当项目关闭时候 调用 destroy()方法，执行一些销毁逻辑，释放资源
*
**/
@Component
public class XxlJobAdminConfig implements InitializingBean, DisposableBean {
private static XxlJobAdminConfig adminConfig = null;
public static XxlJobAdminConfig getAdminConfig() {
return adminConfig;
}
// ---------------------- XxlJobScheduler ----------------------
private XxlJobScheduler xxlJobScheduler;
@Override
public void afterPropertiesSet() throws Exception {
adminConfig = this;
xxlJobScheduler = new XxlJobScheduler();
// 初始化工作在此完成 重要部分
xxlJobScheduler.init();
}
@Override
public void destroy() throws Exception {
xxlJobScheduler.destroy();
}
// ---------------------- XxlJobScheduler ----------------------
// conf
/**
* 读取 resources 目录下的application.properties 配置的键值对
* 这些配置key 含义 基本都可以在 https://www.xuxueli.com/xxl-job/ 官网找到
**/
@Value("${xxl.job.i18n}")
private String i18n;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${spring.mail.from}")
private String emailFrom;
@Value("${xxl.job.triggerpool.fast.max}")
private int triggerPoolFastMax;
@Value("${xxl.job.triggerpool.slow.max}")
private int triggerPoolSlowMax;
@Value("${xxl.job.logretentiondays}")
private int logretentiondays;
// dao, service
/**
* dao 层 和我们的mapper 层相同，使用其进行数据库 sql 语句的CRUD
**/
@Resource
private XxlJobLogDao xxlJobLogDao;
@Resource
private XxlJobInfoDao xxlJobInfoDao;
@Resource
private XxlJobRegistryDao xxlJobRegistryDao;
@Resource
private XxlJobGroupDao xxlJobGroupDao;
@Resource
private XxlJobLogReportDao xxlJobLogReportDao;
@Resource
private JavaMailSender mailSender;
@Resource
private DataSource dataSource;
@Resource
private JobAlarmer jobAlarmer;
public String getI18n() {
if (!Arrays.asList("zh_CN", "zh_TC", "en").contains(i18n)) {
return "zh_CN";
}
return i18n;
}
public String getAccessToken() {
return accessToken;
}
public String getEmailFrom() {
return emailFrom;
}
public int getTriggerPoolFastMax() {
if (triggerPoolFastMax < 200) {
return 200;
}
return triggerPoolFastMax;
}
public int getTriggerPoolSlowMax() {
if (triggerPoolSlowMax < 100) {
return 100;
}
return triggerPoolSlowMax;
}
public int getLogretentiondays() {
if (logretentiondays < 7) {
return -1; // Limit greater than or equal to 7, otherwise close
}
return logretentiondays;
}
public XxlJobLogDao getXxlJobLogDao() {
return xxlJobLogDao;
}
public XxlJobInfoDao getXxlJobInfoDao() {
return xxlJobInfoDao;
}
public XxlJobRegistryDao getXxlJobRegistryDao() {
return xxlJobRegistryDao;
}
public XxlJobGroupDao getXxlJobGroupDao() {
return xxlJobGroupDao;
}
public XxlJobLogReportDao getXxlJobLogReportDao() {
return xxlJobLogReportDao;
}
public JavaMailSender getMailSender() {
return mailSender;
}
public DataSource getDataSource() {
return dataSource;
}
public JobAlarmer getJobAlarmer() {
return jobAlarmer;
}
}
2.2.2 初始化工作xxlJobScheduler.init()：
xxlJobScheduler.init() 方法 承接了 配置文件的解析，任务触发TriggerPool 的创建，对执行器地址的更新；失败任务的重试；对不在线的执行器的任务进行标记清理；日志文件的清理；定时任务的调度；下面是其源码部分：
package com.xxl.job.admin.core.scheduler;
import com.xxl.job.admin.core.conf.XxlJobAdminConfig;
import com.xxl.job.admin.core.thread.*;
import com.xxl.job.admin.core.util.I18nUtil;
import com.xxl.job.core.biz.ExecutorBiz;
import com.xxl.job.core.biz.client.ExecutorBizClient;
import com.xxl.job.core.enums.ExecutorBlockStrategyEnum;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
/**
* @author xuxueli 2018-10-28 00:18:17
*/
public class XxlJobScheduler {
// log 日志对象的创建
private static final Logger logger = LoggerFactory.getLogger(XxlJobScheduler.class);
public void init() throws Exception {
// init i18n
// 配置文件的解析
initI18n();
// admin trigger pool start
// 任务触发TriggerPool 的创建，后续触发的任务会被放入到 TriggerPool 进行任务的执行
JobTriggerPoolHelper.toStart();
// admin registry monitor run
// 对自动注册的执行器地址更新，确保获取到的自动注册执行器地址 是有效的
JobRegistryHelper.getInstance().start();
// admin fail-monitor run
// 失败任务的重试，如果设置了失败重试次数，其中的线程会重试一定次数，并发送告警邮件
JobFailMonitorHelper.getInstance().start();
// admin lose-monitor run ( depend on JobTriggerPoolHelper )
// 对不在线的执行器的任务进行标记清理，清除僵尸任务，执行器都掉线了，则直接将任务标记为执行失败
JobCompleteHelper.getInstance().start();
// admin log report start
// 日志文件的清理，对超过一定天数的日志完成清理工作
JobLogReportHelper.getInstance().start();
// start-schedule ( depend on JobTriggerPoolHelper )
// 定时任务的调度，scheduleThread 线程 和ringData 时间轮 合作完成任务的调度
JobScheduleHelper.getInstance().start();
logger.info(">>>>>>>>> init xxl-job admin success.");
}
// spirng 容器关闭时 XxlJobAdminConfig destroy() 回调用 改destroy() 方法 进行资源释放
public void destroy() throws Exception {
// stop-schedule
JobScheduleHelper.getInstance().toStop();
// admin log report stop
JobLogReportHelper.getInstance().toStop();
// admin lose-monitor stop
JobCompleteHelper.getInstance().toStop();
// admin fail-monitor stop
JobFailMonitorHelper.getInstance().toStop();
// admin registry stop
JobRegistryHelper.getInstance().toStop();
// admin trigger pool stop
JobTriggerPoolHelper.toStop();
}
// ---------------------- I18n ----------------------
// 加载配置文件，并对阻塞处理策略 的title 进行设置
private void initI18n(){
for (ExecutorBlockStrategyEnum item:ExecutorBlockStrategyEnum.values()) {
item.setTitle(I18nUtil.getString("jobconf_block_".concat(item.name())));
}
}
// ---------------------- executor-client ----------------------
// 封装执行器客户端，后续向执行器所在服务 发送信息 可以通过 执行器的地址 获取到包装好的对象 对接口进行调用
// ExecutorBiz 封装了 心态，执行任务，杀掉任务，任职记录的接口
private static ConcurrentMap<String, ExecutorBiz> executorBizRepository = new ConcurrentHashMap<String, ExecutorBiz>();
public static ExecutorBiz getExecutorBiz(String address) throws Exception {
// valid
if (address==null || address.trim().length()==0) {
return null;
}
// load-cache
address = address.trim();
ExecutorBiz executorBiz = executorBizRepository.get(address);
if (executorBiz != null) {
return executorBiz;
}
// set-cache
executorBiz = new ExecutorBizClient(address, XxlJobAdminConfig.getAdminConfig().getAccessToken());
executorBizRepository.put(address, executorBiz);
return executorBiz;
}
}
总结
本篇对xxl-job 服务端启动做的初始工作进行介绍，后续文章会对每部初始的做介绍。
1776
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
