php剖析办事技巧_SpringCloud四十二集成分布式责任调解平台

文章目录 [+]

下面我们按照步骤来先容，如何结合我们的微做事平台将分布式任务调度平台XXL-JOB集成进来，实现我们须要的定时任务功能。

一、微做事框架整合xxl-job-admin1、XXL-JOB开源网站下载源码，下载地址https://github.com/xuxueli/xxl-job/releases,下载下来的源码如下：

xxl-job-admin：调度中央xxl-job-core：公共依赖xxl-job-executor-samples：实行器Sample示例（选择得当的版本实行器，可直策应用，也可以参考其并将现有项目改造成实行器）：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理实行器，推举这种办法；：xxl-job-executor-sample-frameless：无框架版本；

下载下来的开源包有三个目录：xxl-job-admin、xxl-job-core和xxl-job-executor-samples，顾名思义，xxl-job-admin是分布式任务平台的做事端兼管理台，我们须要支配的也是这个工程，我们可以把全体工程集成到我们的微做事中，统一打包支配；xxl-job-core是公共依赖包，我们其他须要实现定时任务的微做事须要引入这个包来实现定时任务实行器。
xxl-job-executor-samples为定时任务实行器的实例代码。

php剖析办事技巧_SpringCloud四十二集成分布式责任调解平台

2、在根本平台gitegg-platform工程gitegg-platform-bom中引入xxl-job-core核心包，统一版本管理。

......  <xxl-job.version>2.3.1</xxl-job.version>......  <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>${xxl-job.version}</version> </dependency>3、将xxl-job-admin集成到微做事工程中，方便统一打包支配

根据我们的微做事架构设计，gitegg-plugin作为我们系统的插件工程，里面放置我们须要的插件做事。
有些插件是必须的，而有些插件可能会用不到，此时我们就可以根据自己的业务需求去选择支配业务插件。
为和我们的微做事深度集造诣不是解耦的特性，我们须要对xxl-job-admin的配置文件进行适当的修正：

（图片来自网络侵删）

首先修正pom.xml，保持各依赖库版本同等，修正parent标签，使其引用GitEgg工程的根本jar包和微做事配置注册功能，同时打消logback，利用log4j2记录日志

<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"> <parent> <artifactId>gitegg-plugin</artifactId> <groupId>com.gitegg.cloud</groupId> <version>1.0.1.RELEASE</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>gitegg-job</artifactId> <name>${project.artifactId}</name> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <maven.compiler.encoding>UTF-8</maven.compiler.encoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <maven.test.skip>true</maven.test.skip> <netty-all.version>4.1.63.Final</netty-all.version> <gson.version>2.9.0</gson.version> <spring.version>5.3.20</spring.version> <spring-boot.version>2.6.7</spring-boot.version> <mybatis-spring-boot-starter.version>2.2.2</mybatis-spring-boot-starter.version> <mysql-connector-java.version>8.0.29</mysql-connector-java.version> <slf4j-api.version>1.7.36</slf4j-api.version> <junit-jupiter.version>5.8.2</junit-jupiter.version> <javax.annotation-api.version>1.3.2</javax.annotation-api.version> <groovy.version>3.0.10</groovy.version> <maven-source-plugin.version>3.2.1</maven-source-plugin.version> <maven-javadoc-plugin.version>3.4.0</maven-javadoc-plugin.version> <maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version> </properties> <dependencies>  <dependency> <groupId>com.gitegg.platform</groupId> <artifactId>gitegg-platform-boot</artifactId> </dependency>  <dependency> <groupId>com.gitegg.platform</groupId> <artifactId>gitegg-platform-cloud</artifactId> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis-spring-boot-starter.version}</version>  <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope>  <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </exclusion> </exclusions> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId>  <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </exclusion> </exclusions> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId>  <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </exclusion> </exclusions> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId>  <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </exclusion> </exclusions> </dependency>  <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>${mysql-connector-java.version}</version> </dependency>  <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId>  <exclusions> <exclusion> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> </exclusion> </exclusions> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>com.google.cloud.tools</groupId> <artifactId>jib-maven-plugin</artifactId> </plugin> </plugins> </build></project>修正application.properties ，根据我们系统的规范，新增bootstrap.yml、bootstrap-dev.yml、bootstrap-prod.yml、bootstrap-test.yml文件。
将application.properties部分配置，移到bootstrap.yml配置中。
因xxl-job-admin单独数据库，且其默认利用的是Hikari数据库连接池，这里我们不打算改动，仍旧使其保持原有的数据库配置，我们将可配置的内容放置在Nacos微做事配置中央上，同时在bootstrap.yml中添加多yaml文件配置（请把稳，在我们本地利用的是yml结尾的文件，Nacos做事注册中央上利用的是yaml结尾的文件，两者是一样的，只是扩展名的不同）。

bootstrap.yml配置：

server: port: 8007spring: profiles: active: '@spring.profiles.active@' application: name: '@artifactId@' cloud: inetutils: ignored-interfaces: docker0 nacos: discovery: server-addr: ${spring.nacos.addr} config: server-addr: ${spring.nacos.addr} file-extension: yaml extension-configs: # 必须带文件扩展名，此时 file-extension 的配置对自定义扩展配置的 Data Id 文件扩展名没有影响 - data-id: ${spring.nacos.config.prefix}.yaml group: ${spring.nacos.config.group} refresh: true - data-id: ${spring.nacos.config.prefix}-xxl-job.yaml group: ${spring.nacos.config.group} refresh: true ### xxl-job-admin config mvc: servlet: load-on-startup: 0 static-path-pattern: /static/ resources: static-locations: classpath:/static/ ### freemarker freemarker: templateLoaderPath: classpath:/templates/ suffix: .ftl charset: UTF-8 request-context-attribute: request settings.number_format: 0.############# actuatormanagement: server: servlet: context-path: /actuator health: mail: enabled: false### mybatismybatis: mapper-locations: classpath:/mybatis-mapper/Mapper.xml

Nacos上gitegg-cloud-config-xxl-job.yaml配置：

server: servlet: context-path: /xxl-job-adminspring: datasource: url: jdbc:mysql://127.0.0.1/xxl_job?useSSL=false&zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&serverTimezone=GMT%2B8 username: root password: root driver-class-name: com.mysql.cj.jdbc.Driver ### datasource-pool type: com.zaxxer.hikari.HikariDataSource hikari: minimum-idle: 10 maximum-pool-size: 30 auto-commit: true idle-timeout: 30000 pool-name: HikariCP max-lifetime: 900000 connection-timeout: 10000 connection-test-query: SELECT 1 validation-timeout: 1000 ### email mail: host: smtp.qq.com port: 25 username: xxx@qq.com from: xxx@qq.com password: xxx properties: mail: smtp: auth: true starttls: enable: true required: true socketFactory: class: javax.net.ssl.SSLSocketFactory### xxl-job, access tokenxxl: job: accessToken: default_token ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en") i18n: zh_CN ## xxl-job, triggerpool max size triggerpool: fast: max: 200 slow: max: 100 ### xxl-job, log retention days logretentiondays: 304、初始化xxl-job-admin须要的数据库脚本

初始化脚本存放不才载的包目录的\xxl-job-2.3.1\doc\db\tables_xxl_job.sql中，一共须要8张表。
我们将xxl-job-admin的数据库和业务数据库分开，配置不同的数据源，在Nacos配置单独的xxl-job-admin配置文件。

新建xxl_job数据库

打开数据库实行建表语句

5、在GitEgg工程的父级pom.xml下添加静态文件过滤

xxl-job-admin是SpringMVC项目，其前端页面由ftl文件和静态文件组成，默认情形下maven启用分环境读取配置时，会对resource目录下的@进行更换，导致静态文件下的字体文件不能用，以是，这里须要进行和jks文件一样的过滤配置:

<resources>  <resource> <directory>src/main/resources</directory> <filtering>true</filtering> <excludes> <exclude>/.jks</exclude> <exclude>static/</exclude> </excludes> </resource>  <resource> <directory>src/main/resources</directory> <filtering>false</filtering> <includes> <include>/.jks</include> <include>static/</include> </includes> </resource> <resource> <directory>src/main/java</directory> <includes> <include>/.xml</include> </includes> </resource> </resources>6、在Gateway添加xxl-job-admin路由转发

xxl-job-admin路由转发须要添加两方面内容，一个是xxl-job-admin注册到Nacos注册中央上的gitegg-job做事，一个是xxl-job-admin前端页面要求的静态文件转发。
第一个是为了和我们整体微做事保持同等，第二个是为理解决xxl-job-admin前端ftl页面在要求静态文件时，要求的是/xxl-job-admin根路径。
新增Gateway路由转发配置如下：

- id: gitegg-job uri: lb://gitegg-job predicates: - Path=/gitegg-job/ filters: - StripPrefix=1 - id: xxl-job-admin uri: lb://gitegg-job predicates: - Path=/xxl-job-admin/ filters: - StripPrefix=07、增加xxl-job-admin访问白名单

xxl-job-admin有自己的权限访问掌握，我们不在网关对其进行鉴权，以是在Nacos配置中，增加白名单配置：

# 网关放行设置 1、whiteUrls不须要鉴权的公共url，白名单，配置白名单路径 2、authUrls须要鉴权的公共urloauth-list:...... whiteUrls:...... - "/gitegg-job/" - "/xxl-job-admin/"......8、启动xxl-job-admin微做事，查看是否启动成功，默认用户名密码: admin/123456

二、测试XXL-JOB定时任务功能

我们在上面的第一步中，完成了xxl-job-admin的整合和启动，xxl-job-admin可以看做是分布式任务的做事注册中央和管理台，如果我们须要实现定时任务，还须要详细实现实行器让xxl-job-admin调用实行。
XXL-JOB支持多种办法的定时任务调用，可以将定时任务实行器写在业务代码中，也可以写在xxl-job-admin做事端：

BEAN模式（类形式）: Bean模式任务，支持基于类的开拓办法，每个任务对应一个Java类。
BEAN模式（方法形式）: Bean模式任务，支持基于方法的开拓办法，每个任务对应一个方法。
GLUE模式(Java/Shell/Python/NodeJS/PHP/PowerShell) ：任务以源码办法掩护在调度中央，支持通过Web IDE在线更新，实时编译和生效，因此不须要指定JobHandler。
1、增加xxl-job通用配置

新增gitegg-platform-xxl-job工程，增加通用配置XxlJobConfig.java通用配置，这样在须要利用定时任务的微做事中，只须要引入一次即可，不须要重复配置。

XxlJobConfig.java:

package com.gitegg.platform.xxl.job.config;import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;/ xxl-job config @author xuxueli 2017-04-28 /@Slf4j@Configurationpublic class XxlJobConfig { @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() { log.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: 'xxx.xxx.xxx.' 3、获取IP String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress(); /}

Nacos配置中央：

xxl: job: admin: addresses: http://127.0.0.1/xxl-job-admin accessToken: 'default_token' executor: appname: ${spring.application.name} address: ip: port: 9999 logpath: D:\\log4j2_nacos\\xxl-job\\jobhandler logretentiondays: 302、实现定时任务测试代码

我们在gitegg-service-system中测试定时任务实行器，先在pom.xml中添加gitegg-platform-xxl-job依赖，然后新增SystemJobHandler.java测试类

SystemJobHandler.java：

package com.gitegg.service.system.jobhandler;import com.xxl.job.core.biz.model.ReturnT;import com.xxl.job.core.context.XxlJobHelper;import com.xxl.job.core.handler.annotation.XxlJob;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Component;import java.util.concurrent.TimeUnit;/ 定时任务示例代码，其他更多示例请查看 https://www.xuxueli.com/xxl-job @author GitEgg /@Slf4j@Componentpublic class SystemJobHandler { / 1、大略任务示例（Bean模式）不带返回值 / @XxlJob("systemJobHandler") public void systemJobHandler() throws Exception { XxlJobHelper.log("不带返回值：XXL-JOB, Hello World."); for (int i = 0; i < 5; i++) { XxlJobHelper.log("beat at:" + i); TimeUnit.SECONDS.sleep(2); } } / 2、大略任务示例（Bean模式）带成功或失落败返回值 / @XxlJob("userJobHandler") public ReturnT<String> userJobHandler() throws Exception { XxlJobHelper.log("带返回值：XXL-JOB, Hello World."); for (int i = 0; i < 5; i++) { XxlJobHelper.log("beat at:" + i); TimeUnit.SECONDS.sleep(2); } return ReturnT.SUCCESS; }}3、配置xxl-job-admin新增实行器新增时：gitegg-service-system做事启动后，自动注册：4、新增xxl-job-admin任务

实行器可以看做是一组微做事，而任务是微做事详细实行的方法。
任务新增后，默认是STOP状态，须要手动启动，当列表显示RUNNING时，表示该任务是运行状态，会根据配置的韶光实行。

5、查看实行器是否实行

在本地开拓环境查看任务实行的办法有多种，直接Debug也可以，生产环境我们可以查看xxl-job日志，在测试代码中记录的log，在xxl-job-admin管理台都可以详细查看。

通过以上操作步骤，我们将xxl-job和xxl-job-admin整合到了我们的微做事架构中，只须要在有任务调度需求的微做事中实现实行器就可以知足我们的需求了。

源码地址:

GitEgg: GitEgg 是一款开源免费的企业级微做事运用开拓框架，旨在整合目前主流稳定的开源技能框架，集成常用的最佳项目办理方案，实现可直策应用的微做事快速开拓框架。

GitHub - wmz1930/GitEgg: GitEgg 是一款开源免费的企业级微做事运用开拓框架，旨在整合目前主流稳定的开源技能框架，集成常用的最佳项目办理方案，实现可直策应用的微做事快速开拓框架。