前言 在分散式架構中項目部署在多台不同的伺服器上,每台伺服器都有自己的crontab任務很容易造成任務執行衝突且不易於定時任務的統一管理; 此時微服務中就需要1個定時任務任務調度中心,對微服務架構中每1台伺服器里的定時任務,進行集中管理,統一定時任務的執行頻率; 一、xxl-job簡介 xxl-jo ...
前言
在分散式架構中項目部署在多台不同的伺服器上,每台伺服器都有自己的crontab任務很容易造成任務執行衝突且不易於定時任務的統一管理;
此時微服務中就需要1個定時任務任務調度中心,對微服務架構中每1台伺服器里的定時任務,進行集中管理,統一定時任務的執行頻率;
一、xxl-job簡介
xxl-job是出自大眾點評許雪裡(xxl就是作者名字的拼音首字母)的開源項目;
官網上介紹這是一個輕量級分散式任務調度框架,其核心設計目標是開發迅速、學習簡單、輕量級、易擴展。
1.特性
- 簡單靈活 提供Web頁面對任務進行管理,管理系統支持用戶管理、許可權控制; 支持容器部署; 支持通過通用HTTP提供跨平臺任務調度;
- 豐富的任務管理功能 支持頁面對任務CRUD操作; 支持在頁面編寫腳本任務、命令行任務、Java代碼任務並執行; 支持任務級聯編排,父任務執行結束後觸發子任務執行; 支持設置指定任務執行節點路由策略,包括輪詢、隨機、廣播、故障轉移、忙碌轉移等; 支持Cron方式、任務依賴、調度中心API介面方式觸發任務執行
- 高性能 任務調度流程全非同步化設計實現,如非同步調度、非同步運行、非同步回調等,有效對密集調度進行流量削峰;
- 高可用 任務調度中心、任務執行節點均 集群部署,支持動態擴展、故障轉移 支持任務配置路由故障轉移策略,執行器節點不可用是自動轉移到其他節點執行 支持任務超時控制、失敗重試配置 支持任務處理阻塞策略:調度當任務執行節點忙碌時來不及執行任務的處理策略,包括:串列、拋棄、覆蓋策略
- 易於監控運維 支持設置任務失敗郵件告警,預留介面支持簡訊、釘釘告警; 支持實時查看任務執行運行數據統計圖表、任務進度監控數據、任務完整執行日誌;
二、安裝xxl-job
xxl-job就Java開發的,主要把jar包允許起來即可;
1.初始化資料庫
# # XXL-JOB v2.3.0 # Copyright (c) 2015-present, xuxueli. CREATE database if NOT EXISTS `xxl_job` default character set utf8mb4 collate utf8mb4_unicode_ci; use `xxl_job`; SET NAMES utf8mb4; CREATE TABLE `xxl_job_info` ( `id` int(11) NOT NULL AUTO_INCREMENT, `job_group` int(11) NOT NULL COMMENT '執行器主鍵ID', `job_desc` varchar(255) NOT NULL, `add_time` datetime DEFAULT NULL, `update_time` datetime DEFAULT NULL, `author` varchar(64) DEFAULT NULL COMMENT '作者', `alarm_email` varchar(255) DEFAULT NULL COMMENT '報警郵件', `schedule_type` varchar(50) NOT NULL DEFAULT 'NONE' COMMENT '調度類型', `schedule_conf` varchar(128) DEFAULT NULL COMMENT '調度配置,值含義取決於調度類型', `misfire_strategy` varchar(50) NOT NULL DEFAULT 'DO_NOTHING' COMMENT '調度過期策略', `executor_route_strategy` varchar(50) DEFAULT NULL COMMENT '執行器路由策略', `executor_handler` varchar(255) DEFAULT NULL COMMENT '執行器任務handler', `executor_param` varchar(512) DEFAULT NULL COMMENT '執行器任務參數', `executor_block_strategy` varchar(50) DEFAULT NULL COMMENT '阻塞處理策略', `executor_timeout` int(11) NOT NULL DEFAULT '0' COMMENT '任務執行超時時間,單位秒', `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失敗重試次數', `glue_type` varchar(50) NOT NULL COMMENT 'GLUE類型', `glue_source` mediumtext COMMENT 'GLUE源代碼', `glue_remark` varchar(128) DEFAULT NULL COMMENT 'GLUE備註', `glue_updatetime` datetime DEFAULT NULL COMMENT 'GLUE更新時間', `child_jobid` varchar(255) DEFAULT NULL COMMENT '子任務ID,多個逗號分隔', `trigger_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '調度狀態:0-停止,1-運行', `trigger_last_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '上次調度時間', `trigger_next_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '下次調度時間', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_log` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `job_group` int(11) NOT NULL COMMENT '執行器主鍵ID', `job_id` int(11) NOT NULL COMMENT '任務,主鍵ID', `executor_address` varchar(255) DEFAULT NULL COMMENT '執行器地址,本次執行的地址', `executor_handler` varchar(255) DEFAULT NULL COMMENT '執行器任務handler', `executor_param` varchar(512) DEFAULT NULL COMMENT '執行器任務參數', `executor_sharding_param` varchar(20) DEFAULT NULL COMMENT '執行器任務分片參數,格式如 1/2', `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失敗重試次數', `trigger_time` datetime DEFAULT NULL COMMENT '調度-時間', `trigger_code` int(11) NOT NULL COMMENT '調度-結果', `trigger_msg` text COMMENT '調度-日誌', `handle_time` datetime DEFAULT NULL COMMENT '執行-時間', `handle_code` int(11) NOT NULL COMMENT '執行-狀態', `handle_msg` text COMMENT '執行-日誌', `alarm_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '告警狀態:0-預設、1-無需告警、2-告警成功、3-告警失敗', PRIMARY KEY (`id`), KEY `I_trigger_time` (`trigger_time`), KEY `I_handle_code` (`handle_code`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_log_report` ( `id` int(11) NOT NULL AUTO_INCREMENT, `trigger_day` datetime DEFAULT NULL COMMENT '調度-時間', `running_count` int(11) NOT NULL DEFAULT '0' COMMENT '運行中-日誌數量', `suc_count` int(11) NOT NULL DEFAULT '0' COMMENT '執行成功-日誌數量', `fail_count` int(11) NOT NULL DEFAULT '0' COMMENT '執行失敗-日誌數量', `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`), UNIQUE KEY `i_trigger_day` (`trigger_day`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_logglue` ( `id` int(11) NOT NULL AUTO_INCREMENT, `job_id` int(11) NOT NULL COMMENT '任務,主鍵ID', `glue_type` varchar(50) DEFAULT NULL COMMENT 'GLUE類型', `glue_source` mediumtext COMMENT 'GLUE源代碼', `glue_remark` varchar(128) NOT NULL COMMENT 'GLUE備註', `add_time` datetime DEFAULT NULL, `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_registry` ( `id` int(11) NOT NULL AUTO_INCREMENT, `registry_group` varchar(50) NOT NULL, `registry_key` varchar(255) NOT NULL, `registry_value` varchar(255) NOT NULL, `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`), KEY `i_g_k_v` (`registry_group`,`registry_key`,`registry_value`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_group` ( `id` int(11) NOT NULL AUTO_INCREMENT, `app_name` varchar(64) NOT NULL COMMENT '執行器AppName', `title` varchar(12) NOT NULL COMMENT '執行器名稱', `address_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '執行器地址類型:0=自動註冊、1=手動錄入', `address_list` text COMMENT '執行器地址列表,多地址逗號分隔', `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `username` varchar(50) NOT NULL COMMENT '賬號', `password` varchar(50) NOT NULL COMMENT '密碼', `role` tinyint(4) NOT NULL COMMENT '角色:0-普通用戶、1-管理員', `permission` varchar(255) DEFAULT NULL COMMENT '許可權:執行器ID列表,多個逗號分割', PRIMARY KEY (`id`), UNIQUE KEY `i_username` (`username`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_lock` ( `lock_name` varchar(50) NOT NULL COMMENT '鎖名稱', PRIMARY KEY (`lock_name`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; INSERT INTO `xxl_job_group`(`id`, `app_name`, `title`, `address_type`, `address_list`, `update_time`) VALUES (1, 'xxl-job-executor-sample', '示例執行器', 0, NULL, '2018-11-03 22:21:31' ); INSERT INTO `xxl_job_info`(`id`, `job_group`, `job_desc`, `add_time`, `update_time`, `author`, `alarm_email`, `schedule_type`, `schedule_conf`, `misfire_strategy`, `executor_route_strategy`, `executor_handler`, `executor_param`, `executor_block_strategy`, `executor_timeout`, `executor_fail_retry_count`, `glue_type`, `glue_source`, `glue_remark`, `glue_updatetime`, `child_jobid`) VALUES (1, 1, '測試任務1', '2018-11-03 22:21:31', '2018-11-03 22:21:31', 'XXL', '', 'CRON', '0 0 0 * * ? *', 'DO_NOTHING', 'FIRST', 'demoJobHandler', '', 'SERIAL_EXECUTION', 0, 0, 'BEAN', '', 'GLUE代碼初始化', '2018-11-03 22:21:31', ''); INSERT INTO `xxl_job_user`(`id`, `username`, `password`, `role`, `permission`) VALUES (1, 'admin', 'e10adc3949ba59abbe56e057f20f883e', 1, NULL); INSERT INTO `xxl_job_lock` ( `lock_name`) VALUES ( 'schedule_lock'); commit;xxl_job.sql
初始化成功
2.配置文件
application.properties
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 spring.datasource.username=root spring.datasource.password=root server.port=8888
3.啟動xxl服務
D:\workspace\software>java -jar xxl-job-admin-2.3.0.jar --server.port=8888
三、使用xxl-job
SpringBoot項目配合xxl-job實現定時任務配置中心;
1.登錄
http://127.0.0.1:8888/xxl-job-admin/toLogin
動調度中心預設登錄賬號admin
預設密碼123456
登錄後運行界面如下圖所示。
2.新增定時任務
---------------------------------------------------------------------
3.SpringBoot項目配置
當SpringBoot項目啟動時會讀取application.yml配置文件中配置的executor.appname地址,把當前項目註冊到xxl-job的執行器中;
xxl-job的執行器記錄當前SpringBoot項目的IP地址和埠;
任務在SpringBoot項目啟動時找到對應的執行器,根據執行器設置的頻率執行任務;
1.配置類
package com.heima.xxljob.config; 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 zhanggen */ @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.port}") private int port; @Bean public XxlJobSpringExecutor xxlJobExecutor() { logger.info(">>>>>>>>>>> xxl-job config init."); XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses); xxlJobSpringExecutor.setAppname(appname); xxlJobSpringExecutor.setPort(port); return xxlJobSpringExecutor; } }XxlJobConfig.java
2.application.yml
server:
port: 8881
xxl:
job:
admin:
#xxl的地址
addresses: http://localhost:8888/xxl-job-admin
executor:
#xxl執行器的名稱
appname: xxl-job-executor-01
port: 9999
application.yml
3.啟動類
package com.heima.xxljob; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; /** * @author zhanggen * @since 2022-07-20 */ @SpringBootApplication(exclude = DataSourceAutoConfiguration.class) public class XxlJobApplication { public static void main(String[] args) { SpringApplication.run(XxlJobApplication.class, args); } }XxlJobApplication.java
4.要執行的任務
package com.heima.xxljob.job; import com.xxl.job.core.handler.annotation.XxlJob; import org.springframework.stereotype.Component; @Component public class HelloJob { @XxlJob("JobHandler-01") public void helloJob(){ System.out.println("簡單任務執行了。。。。"); System.out.println("等等我會被XXLJOB遠程調用"); } }HelloJob.java
5.任務執行效果