[2023] XXL-Job は、Docker を介してコンテナを具体的に構成およびインストールし、springboot を介して登録を実行します。
I. 概要
日常のビジネス シナリオでは、次のようなスケジュールされたタスクの使用が必要なシナリオがよくあります。
- 時間主導のシナリオ: 特定の時点でのクーポンの送信、テキスト メッセージの送信など。
- バッチデータ処理:先月の請求書のバッチ統計、先月の売上データの統計など。
- 固定頻度シナリオ: 5 分ごとに実行する必要があります。
Java では、Timer、Quartz などの従来のスケジュールされたタスク実装ソリューションには多かれ少なかれ問題があります。
- クラスタリング、統計、管理プラットフォーム、障害アラーム、監視などはありません。
また、現在の分散アーキテクチャでは、分散タスク スケジューリングが必要なシナリオがいくつかあります。
- 同じサービスの複数のインスタンスにサービスを提供するタスク間に相互排他がある場合、統合されたスケジューリングが必要です。
- タスクのスケジューリングは、高可用性、監視、および障害アラームをサポートする必要があります。
- 各サービスノードのタスクスケジューリング結果を一元的に管理・追跡し、タスクの属性情報などを記録・保存する必要があります。
明らかに、従来のスケジュールされたタスクは現在の分散アーキテクチャを満たしていないため、分散タスク スケジューリング プラットフォームが必要です。現在、より主流となっているのは elasticjob と xxl-job です。
2. インストール
Dockerを使用してインストール
1.画像をプルします
ocker pull xuxueli/xxl-job-admin:2.3.0
2. データベースの作成
tables_xxl_job.sql
公式 Web サイトからデータベース フォームを取得し、それを独自の mysql にデータベース アドレスに投入します。
3. コンテナを作成して実行する
構成パラメータは公式 Web サイト-e PARAMS
を参照できます。これは Spring の .properties ファイル構成に似ています。
- mysql およびその他の設定をカスタマイズする必要がある場合は、「-e PARAMS」およびパラメータ形式 PARAMS="–key=value --key2=value2" を通じて指定できます。
- 設定項目参照ファイル:/xxl-job/xxl-job-admin/src/main/resources/application.properties
- JVM メモリ パラメータなどの構成をカスタマイズする必要がある場合は、「-e JAVA_OPTS」で指定できます。パラメータの形式は JAVA_OPTS="-Xmx512m" です。
//配置mysql参数
docker run -e PARAMS="--server.port=9051 --spring.datasource.url=jdbc:mysql://192.168.0.146:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=123456" -p 9051:9051 -v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin:2.3.0
!知らせ
- mysql も docker 上にデプロイされている場合は、localhost または 127.0.0.1 を書かず、ip を書きます。
- ユーザー名とパスワードはデータベースのアドレスである必要があります
- xxl_job は公式 Web サイトから取得したデータベースです。名前が変更された場合は、それに応じて更新する必要があります。
- また、設定の途中に改行などのスペースを入れないでください。
3. コンテナとログを表示する
C:\Users>docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS
NAMES
2227fc303594 xuxueli/xxl-job-admin:2.3.0 "sh -c 'java -jar $J…" 17 minutes ago Up 17 minutes 0.0.0.0:9051->9051/tcp
xxl-job-admin
7f6c94285299 consul "docker-entrypoint.s…" 2 months ago Exited (255) 2 months ago 8300-8302/tcp, 8301-8302/udp, 8600/tcp, 8600/udp, 0.0.0.0:8500->8500/tcp
mysql8.0
740eb45a513d redis "docker-entrypoint.s…" 9 months ago Exited (0) 2 days ago
myredis
起動ログに問題がないか確認し、最終的に成功
C:\Users>docker logs -t -f --tail 10f xxl-job-admin
2023-08-04T08:49:28.302253800Z
2023-08-04T08:49:28.302441500Z . ____ _ __ _ _
2023-08-04T08:49:28.302461700Z /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
2023-08-04T08:49:28.302484200Z ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
2023-08-04T08:49:28.302499100Z \\/ ___)| |_)| | | | | || (_| | ) ) ) )
2023-08-04T08:49:28.302512600Z ' |____| .__|_| |_|_| |_\__, | / / / /
2023-08-04T08:49:28.302526000Z =========|_|==============|___/=/_/_/_/
2023-08-04T08:49:28.306031900Z :: Spring Boot :: (v2.4.2)
2023-08-04T08:49:28.306065400Z
2023-08-04T08:49:28.438761800Z 16:49:28.434 logback [main] INFO c.x.job.admin.XxlJobAdminApplication - Starting XxlJobAdminApplication using Java 1.8.0_265 on 2227fc303594 with PID 7 (/app.jar started by root in /)
2023-08-04T08:49:28.440836200Z 16:49:28.440 logback [main] INFO c.x.job.admin.XxlJobAdminApplication - No active profile set, falling back to default profiles: default
2023-08-04T08:49:31.210036000Z 16:49:31.209 logback [main] INFO o.s.b.w.e.tomcat.TomcatWebServer - Tomcat initialized with port(s): 9051 (http)
2023-08-04T08:49:31.226888300Z 16:49:31.226 logback [main] INFO o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-9051"]
2023-08-04T08:49:31.228067500Z 16:49:31.227 logback [main] INFO o.a.catalina.core.StandardService - Starting service [Tomcat]
2023-08-04T08:49:31.228668800Z 16:49:31.228 logback [main] INFO o.a.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/9.0.41]
2023-08-04T08:49:31.302073600Z 16:49:31.301 logback [main] INFO o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring embedded WebApplicationContext
2023-08-04T08:49:31.302455100Z 16:49:31.302 logback [main] INFO o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 2408 ms
2023-08-04T08:49:32.422937800Z 16:49:32.422 logback [main] INFO c.x.j.a.c.scheduler.XxlJobScheduler - >>>>>>>>> init xxl-job admin success.
2023-08-04T08:49:32.464778700Z 16:49:32.462 logback [xxl-job, admin JobRegistryMonitorHelper-registryMonitorThread] INFO com.zaxxer.hikari.HikariDataSource - HikariCP - Starting...
2023-08-04T08:49:32.712904100Z 16:49:32.712 logback [main] INFO o.s.s.c.ThreadPoolTaskExecutor - Initializing ExecutorService 'applicationTaskExecutor'
2023-08-04T08:49:32.931666500Z 16:49:32.931 logback [main] INFO o.s.b.a.w.s.WelcomePageHandlerMapping - Adding welcome page template: index
2023-08-04T08:49:33.198892600Z 16:49:33.198 logback [xxl-job, admin JobRegistryMonitorHelper-registryMonitorThread] INFO com.zaxxer.hikari.HikariDataSource - HikariCP - Start completed.
2023-08-04T08:49:33.854065100Z 16:49:33.853 logback [main] INFO o.s.b.a.e.web.EndpointLinksResolver - Exposing 2 endpoint(s) beneath base path '/actuator'
2023-08-04T08:49:33.916699800Z 16:49:33.916 logback [main] INFO o.a.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-9051"]
2023-08-04T08:49:33.949473300Z 16:49:33.948 logback [main] INFO o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring DispatcherServlet 'dispatcherServlet'
2023-08-04T08:49:33.949971100Z 16:49:33.949 logback [main] INFO o.s.web.servlet.DispatcherServlet - Initializing Servlet 'dispatcherServlet'
2023-08-04T08:49:33.953091200Z 16:49:33.952 logback [main] INFO o.s.web.servlet.DispatcherServlet - Completed initialization in 2 ms
2023-08-04T08:49:33.956208900Z 16:49:33.955 logback [main] INFO o.s.b.w.e.tomcat.TomcatWebServer - Tomcat started on port(s): 9051 (http) with context path '/xxl-job-admin'
2023-08-04T08:49:33.987836700Z 16:49:33.986 logback [main] INFO c.x.job.admin.XxlJobAdminApplication - Started XxlJobAdminApplication in 6.262 seconds (JVM running for 7.286)
2023-08-04T08:49:37.002114700Z 16:49:37.001 logback [xxl-job, admin JobScheduleHelper#scheduleThread] INFO c.x.j.a.c.thread.JobScheduleHelper - >>>>>>>>> init xxl-job admin scheduler success.
4. Web ページ 127.0.0.1:9051/xxl-job-admin/ を開きます。
デフォルトのアカウント/パスワード: admin/123456
3. 登録テストの実施
1. SpringBoot プロジェクトを作成し、依存関係を追加します。
- 好きな名前を付け
て依存関係を追加します
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency><!-- 官网的demo是2.2.1,中央maven仓库还没有,所以就用2.2.0 -->
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
2. 構成の追加
2.1. ymlの追加
server:
port: 8080
spring:
application:
name: xxl-test01
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mycinema?serverTimezone=Asia/Shanghai
username: root
password: 123456
xxl:
job:
admin:
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
addresses: http://localhost:9051/xxl-job-admin
executor:
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appname: xxl-test01
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip: 192.168.0.146
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 3333
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logPath: logs/jeecg/job/jobhandler/
logRetentionDays: 30
2.2. Bean を設定するための設定クラスの追加
/**
* @author zhengfuping
* @version 1.0
* @description: TODO 执行配置,注入到bean容器
*/
@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;
}
}
2.3. 実行タイミングハンドラの追加
/**
* @author zhengfuping
* @version 1.0
* @description: TODO 具体执行测试demo
*/
@Component
@Slf4j
public class XxlJobDemoHandler {
/**
* Bean模式,一个方法为一个任务
*/
@XxlJob("demoJobHandler")
public ReturnT<String> demoJobHandler(String param) throws Exception {
log.info("java, Hello World~~~");
log.info("获取参数:",param);
log.info("----xxl执行成功-----");
return ReturnT.SUCCESS;
}
}
3. クライアントを構成する
- エグゼキューターを構成し、
appname
yml と一貫性を保つ必要がある
- 構成タスク
- 設定が完了したら、手動で起動する必要があり、実行ログを確認したり、手動で実行したりすることができます。