説明:分散タスク スケジューリング プラットフォーム XXL-JOBの主な設計目標は、迅速な開発、簡単な学習、軽量、簡単な拡張です。ソース コードは現在公開されており、多くの企業のオンライン製品ラインに接続されており、すぐに使用できるようになりました (公式言語)。
この記事では、XXL-JOB を使用してスケジュールされた実行コードを実装する方法を紹介します。これは、プロジェクトで定期的に実行する必要があるタスク コードに使用できます。
インストール
ステップ 1: イメージをプルする
サーバー上で次のコマンドを入力して、XXL-JOB イメージをプルします。
docker pull xuxueli/xxl-job-admin:2.4.0
バージョン番号を追加する必要があることに注意してください。追加しない場合、プルは失敗します。
さらに、バージョン番号は非常に特殊です。イメージのバージョンとコードビハインドの Maven バージョンの一貫性を保つようにしてください。バージョン 2.4.0 をプルすることをお勧めします。;
ステップ 2: データベースを作成する
XXL-JOB で使用するデータベースを作成する必要があるため、XXL-JOB は、次のように、MySQL 公式 Web サイトによって提供される圧縮パッケージ内の SQL ファイルに依存します。
内容は以下の通りです。
#
# XXL-JOB v2.4.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;
MySQL コンテナを起動し、コンテナに入り、クライアントに入ります。
上記の SQL ステートメントをコピーして、データベースとテーブルを作成します。
作成が完了しました。
ステップ 3: コンテナーを開始する
次のコマンドを入力して、XXL-JOB コンテナを開始します。
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://数据库IP:3306/xxl_job?Unicode=true&characterEncoding=UTF-8&useSSL=false --spring.datasource.username=root --spring.datasource.password=123456 --xxl.admin.login=false" -p 9090:8080 --name xxl-job-admin -d xuxueli/xxl-job-admin:2.4.0
カスタマイズが必要な部分は以下のとおりです。
起動が完了しました。
ステップ 4: ログイン
ブラウザを開き、「http://server IP:9090/xxl-job-admin」と入力して、タスク スケジュール プラットフォームにアクセスします。デフォルトのアカウントはadmin、パスワードは123456です。、クラウド サーバーの場合は、このポートを開く必要があります。
ログイン成功;
ログイン後に次のウィンドウが表示された場合は、データベース XXL-JOB に必要なデータベースが作成されていないことを意味します。
使用
コードで XXL-JOB を使用する場合は、まずスケジューリング プラットフォームでいくつかの作業を行う必要があります。
ステップ 1: エグゼキュータを作成する
エグゼキュータ管理で、「追加」をクリックしてエグゼキュータを作成します。
正常に追加されました。
「保存」をクリックすると、次のウィンドウがポップアップ表示され、データベースにリモート制御権限があることが示されます。
この記事を参照して問題を解決してください (http://t.csdn.cn/JZxQ2)。mysql コンテナーに入り、次のコマンドを実行します。変更後は忘れずに mysql コンテナーを再起動してください。
ステップ 2: タスクを作成する
対応するエグゼキューターでタスクを作成します。次のように、タスクの実行期間を表す Cron 式をタスク内に記述することができます。
さらに、タスクには非常に重要な設定が 2 つあります。
- ルーティング戦略: クラスター環境でのルーティング戦略 公式ドキュメントは次のとおりです。
- ブロッキング処理戦略: タスクが大量にある場合の実行戦略。たとえば、タスクの実行には 10 秒かかりますが、タイマーは 5 秒ごとに設定されます。詳細な説明は次のとおりです。
ステップ 3: プロジェクトを作成する
次の pom ファイルを使用して、単純な SpringBoot プロジェクトを作成します。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>xxl-job-essay</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.12</version>
<relativePath/>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--xxl-job依赖,注意版本号-->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.4.0</version>
</dependency>
</dependencies>
<!--打包插件,后面打包时使用-->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
次のように、XXL-JOB に必要な構成と Bean オブジェクトを構成する構成パッケージを作成します。
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;
@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.port}")
private int port;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setAppname(appName);
xxlJobSpringExecutor.setPort(port);
return xxlJobSpringExecutor;
}
}
application.yml ファイルを作成し、XXL-JOB 関連の構成を追加します。
xxl:
job:
admin:
addresses: http://XXL-JOB服务IP:9090/xxl-job-admin
executor:
appname: simple
port: 9999
accessToken: default_token
appname に入力される値は、スケジュール内に新しく作成されたエグゼキュータの名前です。
ステップ 4: スケジュールされたタスクを追加する
プロジェクトで、次のようにジョブ パッケージを作成し、スケジュール (段落の印刷) が必要なタスク コードを追加します。
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;
@Component
public class XXLJOBTest {
@XxlJob("hello")
public void test() {
System.out.println("Hello XXL Job!");
}
}
@XxlJob アノテーションには、ディスパッチ センターで設定されたタスク名が入力されることに注意してください。
ステップ5: 梱包する
XXL-JOB サービスはクラウド サーバー上にあり、プロジェクトはパーソナル コンピューター上で作成されているため、パブリック ネットワークから IP にアクセスできないため、プロジェクトをパッケージ化してクラウド サービス上で実行する必要があります。
もちろん、パッケージ化する前にプロジェクトを開始して、実行できるかどうかを確認します。
右側で Maven を選択し、Test コマンドをスキップして、Package コマンドをクリックしてパッケージ化します。
プロジェクトのターゲット ディレクトリで jar パッケージを見つけます。
ターゲット ディレクトリがない場合は、これを選択して表示します。
ステップ 6: 実行する
jar パッケージをクラウド サーバーに配置して実行します。もちろん、クラウド サーバーは JDK で構成されている必要があります。http://t.csdn.cn/MUDnw を参照してください。
次のコマンドを入力してプロジェクトを開始します。
java -jar jar包名
正常に実行されました
ステップ 7: タスクを開始する
スケジューリング プラットフォームを開き、ノードが登録されているかどうかを確認します。
この時点で、タスクを開始し、SpringBoot コンソールをチェックして、タスクが実行されるようにスケジュールされているかどうかを確認できます。
オンにする;
コンソールを見ると、タスクが定期的に実行されていることがわかります。
スケジュール ログでは、タスクが正常に実行されたことがわかります。
この時点で、XXL-JOB を使用したスケジュールされたタスクの完了は完了です。
要約する
XXL-JOB はバージョンに依存します。Docker イメージで使用されるバージョンが、プロジェクトに導入された依存関係と一致することをお勧めします。「アクセス トークンが間違っています」というメッセージが表示された場合は、バージョンの問題である可能性があります。