Bagaimana SpringBoot menyepadukan platform penjadualan tugas teragih XxlJob

1. Pengenalan kepada XxlJob

XXL-JOB ialah platform penjadualan tugas yang diedarkan. Matlamat reka bentuk terasnya ialah pembangunan pesat, pembelajaran mudah, ringan dan pengembangan yang mudah. Kod sumber kini dibuka dan disambungkan ke barisan produk dalam talian banyak syarikat, sedia untuk digunakan di luar kotak.

Mengapa menggunakan penjadualan tugas teragih? Sama ada untuk projek teragih atau pengimbangan beban nginx, kaedah pelaksanaan tugas berjadual tradisional adalah sangat perlahan, seperti

XxlJob Quick Start

2.1 Muat Turun alamat gudang kod sumber

源码仓库地址	Release Download
https://github.com/xuxueli/xxl-job	Download
http://gitee.com/xuxueli0323/xxl-job	Download

2.2 Langkah pelaksanaan tugas berjadual

1 Jalankan skrip sql dalam projek dalam pangkalan data

2 🎜 >

xxl-job-admin: pusat penghantaran

xxl-job-core: pergantungan awam

xxl-job-executor-samples: executor Sample (pilih versi pelaksana yang sesuai, yang boleh digunakan secara langsung, Anda juga boleh merujuknya dan mengubah projek sedia ada kepada pelaksana)
：xxl-job-executor-sample-springboot: Versi Springboot, uruskan pelaksana melalui Springboot, kaedah ini disyorkan; executor-sample-frameless: versi tanpa bingkai;


3 Ubah suai fail konfigurasi pusat penghantaran

### web

server.port=8080

server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator

management.health.mail.enabled= false

### sumber
spring.mvc.servlet.load-on-startup=0

spring.mvc.static-path-pattern=/static/**

spring. resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/

spring.freemarker.suffix=.ftl

spring .freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml

#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezonehai=🎜 >spring.datasource.username=root

spring.datasource.password=root

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### sumber data -pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10

spring.datasource.hikari.maximum-pool-size=30

spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max -lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, peti mel penggera e-mel, jika tugas yang dijadualkan gagal dilaksanakan, mesej akan ditolak ke peti mel
spring.mail.host=smtp.qq.com
spring .mail.port= 25

spring.mail.username=XXX@qq.com

spring.mail.from=XXX@qq.com
spring.mail.password=Kod kebenaran
spring. mail.properties.mail .smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties .mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, token akses komunikasi pusat penghantaran TOKEN [pilihan]: didayakan apabila tidak kosong; 🎜>## # Jika token komunikasi dikonfigurasikan, accessToken pusat penghantaran dan perkhidmatan pelaksana mestilah konsisten
xxl.job.accessToken=

### xxl-job, i18n (lalai ialah zh_CN , dan anda boleh memilih "zh_CN", "zh_TC" dan "en")

# Konfigurasi pengantarabangsaan pusat penghantaran [diperlukan]: Lalai ialah "zh_CN"/Chinese Simplified, julat pilihan ialah "zh_CN"/Chinese Simplified, " zh_TC"/Chinese Traditional dan "en"/English;
xxl.job.i18n=zh_CN

## xxl-job, triggerpool saiz maks

# Menjadualkan konfigurasi benang maksimum [diperlukan ] 】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, hari pengekalan log
# Penjadualan Bilangan hari untuk menyimpan data jadual log pusat [diperlukan]: log tamat tempoh dibersihkan secara automatik apabila had melebihi atau sama dengan 7, jika tidak, seperti -1, fungsi pembersihan automatik dimatikan; 🎜>xxl.job.logretentiondays=30

Jika konfigurasi di atas telah dilakukan dengan betul, projek boleh disusun, dibungkus dan digunakan.

Alamat akses pusat penjadualan: http://localhost:8080/xxl-job-admin (Alamat ini akan digunakan oleh pelaksana sebagai alamat panggilan balik)

Akaun log masuk lalai ialah “ admin/ 123456", antara muka yang dijalankan selepas log masuk adalah seperti yang ditunjukkan di bawah.

4 Konfigurasikan projek pelaksana

xxl-job-executor-sample-frameless way (tidak disyorkan)

Projek "Executor" ： xxl-job-executor-sample-springboot (Berbilang versi pelaksana disediakan untuk dipilih. Versi springboot diambil sebagai contoh. Ia boleh digunakan terus, atau anda boleh merujuknya dan mengubah projek sedia ada menjadi pelaksana) Fungsi: Bertanggungjawab untuk menerima dan melaksanakan jadual daripada "Pusat Penjadualan"; pelaksana boleh digunakan secara langsung atau disepadukan ke dalam projek perniagaan sedia ada.

# port web

server.port=8081
# tiada web
#spring.main.web-environment=false

# log config
logging.config=classpath:logback.xml
# Alamat akar penempatan pusat penjadualan [pilihan]: Jika terdapat berbilang alamat untuk penghantaran penempatan kelompok pusat, pisahkan dengan koma. Pelaksana akan menggunakan alamat ini untuk "pendaftaran denyutan jantung pelaksana" dan "panggilan balik hasil tugasan"; jika ia kosong, pendaftaran automatik akan dimatikan; 8080/xxl -job-admin

# TOKEN komunikasi pelaksana [pilihan]: didayakan apabila tidak kosong; Asas pengumpulan untuk pendaftaran degupan jantung pelaksana; jika kosong, pendaftaran automatik akan dimatikan

xxl.job.executor.appname=xxl-job-executor-llp
# Pendaftaran pelaksana [pilihan]: Utamakan menggunakan konfigurasi ini sebagai alamat pendaftaran jika kosong, gunakan perkhidmatan terbenam "IP:PORT" sebagai alamat pendaftaran. Ini memberikan sokongan yang lebih fleksibel untuk IP dinamik pelaksana jenis kontena dan isu port pemetaan dinamik.

xxl.job.executor.address=

# IP Pelaksana [pilihan]: Lalai kosong untuk mendapatkan IP secara automatik Apabila terdapat berbilang kad rangkaian, anda boleh menetapkan IP yang ditentukan secara manual terikat kepada Hos dan hanya digunakan untuk komunikasi Praktikal; nombor [pilihan]: jika kurang daripada atau sama dengan 0, ia akan menjadi automatik Dapatkan port lalai ialah 9999. Apabila menggunakan berbilang pelaksana pada satu mesin, berhati-hati untuk mengkonfigurasi port pelaksana yang berbeza; .executor.port=0
# Pelaksana menjalankan laluan cakera storan fail log [pilihan] [ Pilihan]: Pembersihan automatik log tamat tempoh, berkesan apabila nilai had lebih besar daripada atau sama dengan 3, seperti -1; tutup fungsi pembersihan automatik;
xxl.job.executor.logretentiondays=30


5 .Tambah pelaksana




6 tugas

7 Tulis program ujian

package com.xxl.job.executor.service.jobhandler;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Component
public class TestXxlJob {
    private static Logger logger = LoggerFactory.getLogger(TestXxlJob.class);
    @XxlJob(value = "testJobHandler", init = "init", destroy = "destroy")
    public void testJobHandler() throws Exception {
        logger.info("进入xxlJob定时任务。。。。");
    }
    public void init(){
        logger.info("init");
    }
    public void destroy(){
        logger.info("destroy");
    }
    @XxlJob("testJobHandler02")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        logger.info("进入testJobHandler02定时任务。。。。");
    }
}

8. Lihat log penjadualan

3. SpringBoot menyepadukan XxlJob

3.1 Cipta projek SpringBoot dan perkenalkan dependensi

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${稳定版}</version>
</dependency>

3.2 Tulis fail konfigurasi sifat

# port web

server.port=8081

# tiada web

# spring.main.web-environment=false

# log config

logging.config=classpath:logback.xml

# Alamat akar penempatan pusat penjadualan [pilihan]: Jika penempatan gugusan pusat penghantaran wujud Berbilang alamat dipisahkan dengan koma. Pelaksana akan menggunakan alamat ini untuk "pendaftaran denyutan jantung pelaksana" dan "panggilan balik hasil tugasan"; jika ia kosong, pendaftaran automatik akan dimatikan; 8080/xxl -job-admin

# TOKEN komunikasi pelaksana [pilihan]: didayakan apabila tidak kosong; Dasar pengumpulan degupan jantung pelaksana; jika kosong, pendaftaran automatik dimatikan

xxl.job.executor.appname=xxl-job-executor-llp

# Pendaftaran pelaksana [pilihan]: Utamakan menggunakan konfigurasi ini sebagai alamat pendaftaran , apabila kosong, gunakan perkhidmatan terbenam "IP:PORT" sebagai alamat pendaftaran. Ini memberikan sokongan yang lebih fleksibel untuk IP dinamik pelaksana jenis kontena dan isu port pemetaan dinamik.

xxl.job.executor.address=

# IP Pelaksana [pilihan]: Lalai kosong untuk mendapatkan IP secara automatik Apabila terdapat berbilang kad rangkaian, anda boleh menetapkan IP yang ditentukan secara manual terikat kepada Hos dan hanya digunakan untuk komunikasi Praktikal; # Nombor port pelaksana [pilihan]: kurang daripada atau sama dengan 0 diperoleh secara automatik port lalai ialah 9999. Apabila menggunakan berbilang pelaksana pada satu mesin, berhati-hati untuk mengkonfigurasi port pelaksana yang berbeza; port=9999

# Pelaksana menjalankan laluan cakera storan fail log [Pilihan]: Anda perlu mempunyai kebenaran membaca dan menulis pada laluan itu; jika ia kosong, laluan lalai akan digunakan; .logpath=/data/applogs/xxl-job/jobhandler
# Fail log pelaksana Bilangan hari untuk disimpan [pilihan]: Log tamat tempoh dibersihkan secara automatik dan ia berkuat kuasa apabila nilai had lebih besar daripada atau sama dengan 3 ; jika tidak, seperti -1, fungsi pembersihan automatik dimatikan; dan nama aplikasi yang dikonfigurasikan dalam pelaksana mestilah konsisten; adalah disyorkan bahawa ip dan port pelaksana dikonfigurasikan

3.3 Tulis kelas konfigurasi xxljob

@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;
    }
    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     *      1、引入依赖：
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件，或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: &#39;xxx.xxx.xxx.&#39;
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */
}

3.4 Tulis kelas kerja untuk ujian

@Component
public class TestXxlJob {
    private static Logger logger = LoggerFactory.getLogger(TestXxlJob.class);
    @XxlJob(value = "testJobHandler", init = "init", destroy = "destroy")
    public void testJobHandler() throws Exception {
        logger.info("进入xxlJob定时任务。。。。");
    }
    public void init(){
        logger.info("init");
    }
    public void destroy(){
        logger.info("destroy");
    }
    @XxlJob("testJobHandler02")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        logger.info("进入testJobHandler02定时任务。。。。");
    }
}

Buat pelaksana

Buat tugas

查看后台执行日志

如果需要xxlJob邮件报警功能，则需要在xxl-job-admin中进行配置邮件信息，并在创建任务时指定配置的邮箱地址

### xxl-job, email报警邮箱，如果定时任务执行失败会推送消息给该邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=XXX@qq.com
spring.mail.from=XXX@qq.com
spring.mail.password=授权码
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

ps:如果定时任务执行频率很高，频繁失败的话，那收邮件就是一个噩梦~

4.XxlJob部署

4.1 jar包部署方式

jar包部署的方式比较简单，将项目编译打包部署到服务器上，其他服务和xxljob调度器之间网络、接口相通即可

4.2 Docker 镜像方式搭建调度中心

下载镜像

# Docker地址：https://hub.docker.com/r/xuxueli/xxl-job-admin/     (建议指定版本号)
docker pull xuxueli/xxl-job-admin
# 如需自定义 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" ；
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}

Atas ialah kandungan terperinci Bagaimana SpringBoot menyepadukan platform penjadualan tugas teragih XxlJob. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!