安裝xxl-job客戶端一般有很多方式,我這里給大家提供兩種安裝方式,包含里面的各項配置等等。
前期需要準備好MySQL數據庫。復制SQL到數據庫里面。
#
# XXL-JOB v2.4.2-SNAPSHOT
# 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;
docker服務器安裝xxl-job集成xxl-job
拉取指定版本:
docker pull xuxueli/xxl-job-admin:2.4.0
在根目錄創建data文件夾,然后創建xxl-job文件夾,啟用docker鏡像,注意修改里面MySQL的賬號密碼,以及?xxl.job.accessToken,這個我們隨機定義一串長字符串,主要用于調度時交互使用
docker run -di -e PARAMS="--spring.datasource.url=jdbc:mysql://172.17.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=1111 --xxl.job.accessToken=aaaaaaaaaaaa.ddss.cccc" \-p 9001:8080 \-v /data/xxl-job:/data/applogs \--name xxl-job \--privileged=true \xuxueli/xxl-job-admin:2.4.0
完成以后我們開放服務器端口9001,然后使用http://服務器ip:9001/xxl-job-admin 進行訪問,輸入賬號admin? ?密碼 123456 即可
集成SpringBoot: 我們在本地搭建一個SpringBoot項目,使用本地項目連接服務器xxl-job進行調度。
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.4.1</version> </dependency>
xxl.job:admin:#這個是我們的服務器xxl-job后臺訪問地址 addresses: http://服務器ip:9001/xxl-job-admin#這個就是服務器創建鏡像時設置的 xxl.job.accessTokenaccessToken: aaaaaaaaaaaa.ddss.ccccexecutor:#這個是xxl-job管理后臺(執行器管理)里面的AppName 名稱appname: web-server#不填就是使用默認的自動錄入 address: ""#不填就是使用默認的 ip: ""#指定使用9990進行調度任務通信port: 9990logpath: ""#日志只保存5天的 logretentiondays: 5
在項目里面創建一個類,使用xxlJob注解
package com.app.web.task;import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;@Component
@Slf4j
public class MyJobHandler{@XxlJob("demoJobHandler")public void execute(){log.info("任務調用成功啦,哈哈哈哈哈哈哈哈哈哈哈哈哈");}
}
由于我們是本地服務器連接測試服務器上面的xxl-job,所以這里的注入方式我們需要改成一個服務器能訪問到我們本地端口9990的服務,我們將注冊方式改為手動錄入,并填入能訪問我們本地服務的鏈接
點擊任務管理,添加如下:
然后本地項目啟動,點擊執行任務,任務調度成功。。。。。。。。。。。
搭建xxl-job系統
本地搭建xxl-job項目本地服務啟動,下載項目源碼:https://github.com/xuxueli/xxl-job/,下載完成以后主要也是修改admin模塊下面配置文件application.properties。修改里面數據庫連接方式以及xxl.job.accessToken,打包項目然后啟動服務即可。啟動成功以后訪問?http://127.0.0.1:9001/xxl-job-admin,注意端口一定要和本地xxl-job項目端口一致。
xxl.job:
? ? admin:
? ? ? #這個是我們的服務器xxl-job后臺訪問地址 ?
? ? ? addresses: http://服務器ip:9001/xxl-job-admin
? ? #這個就是服務器創建鏡像時設置的 xxl.job.accessToken
? ? accessToken: aaaaaaaaaaaa.ddss.cccc
? ? executor:
? ? ? #這個是xxl-job管理后臺(執行器管理)里面的AppName 名稱
? ? ? appname: web-server
? ? ? #不填就是使用默認的自動錄入?
? ? ? address: ""
? ? ? #不填就是使用默認的 ? ?
? ? ? ip: ""
? ? ? #小于等于0則自動獲取;默認端口為9999,單機部署多個執行器時,注意要配置不同執行器端口
? ? ? port: 0
? ? ? logpath: ""
? ? ? #日志只保存5天的 ? ?
? ? ? logretentiondays: 5
最后各個參數詳細解釋如下,不明白的可以在看一下具體的
-
admin: addresses
- 含義: 這是 XxlJob Admin 的地址,用于 XxlJob Executor 連接到 XxlJob Admin 進行注冊和任務調度通信。
- 示例:
http://服務器ip:9001/xxl-job-admin
- 作用: Executor 通過這個地址向 XxlJob Admin 注冊,并從 Admin 處接收任務調度信息。
-
accessToken
- 含義: 這是用于 Executor 與 Admin 之間通信的令牌,用來進行身份驗證。
- 示例:
aaaaaaaaaaaa.ddss.cccc
- 作用: 確保通信安全,只有持有正確令牌的 Executor 才能注冊和與 Admin 通信。
-
executor: appname
- 含義: 執行器的應用名稱,通常在 XxlJob Admin 中用于區分不同的執行器實例。
- 示例:
web-server
- 作用: 在 XxlJob Admin 中識別和管理該 Executor 實例。
-
executor: address
- 含義: 手動指定 Executor 的地址。通常情況下可以留空,由系統自動獲取。
- 示例:
""
- 作用: 允許手動指定 Executor 的地址,便于在某些特定網絡環境下進行特殊配置。
-
executor: ip
- 含義: 手動指定 Executor 的 IP 地址。通常情況下可以留空,由系統自動獲取。
- 示例:
""
- 作用: 允許手動指定 Executor 的 IP 地址,便于在某些特定網絡環境下進行特殊配置。
-
executor: port
- 含義: Executor 監聽的端口號。如果設置為 0 或不設置,則會自動選擇一個端口(默認是 9999)。
- 示例:
0
- 作用: 在同一臺機器上運行多個 Executor 實例時,需要設置不同的端口號避免沖突。
-
executor: logpath
- 含義: 執行器日志的存放路徑。
- 示例:
""
- 作用: 指定 Executor 生成的日志文件存放的目錄。如果不設置,系統會使用默認路徑。
-
executor: logretentiondays
- 含義: 日志保留的天數。
- 示例:
5
- 作用: 指定日志文件保留的天數,超過這個天數的日志文件會被自動清理,避免日志文件占用過多磁盤空間。