本文介绍: XXL-JOB是一个分布式任务调度平台,其核心设计目标开发迅速、学习简单轻量级、易扩展。现已开放源代码接入多家公司线上产品线,开箱即用。本篇文章主要是对xuxuelixxljob一个简单配置,以及将其添加自己已有的项目中进行api调用

简介

XXL-JOB是一个分布式任务调度平台,其核心设计目标开发迅速、学习简单轻量级、易扩展。现已开放源代码接入多家公司线上产品线,开箱即用。

篇文章主要是对xuxuelixxljob做一个简单的配置,以及将其添加到自己已有的项目中进行api调用

xxljob安装与配置

一、xxljob安装

1、首先访问Gitee克隆/下载xxl-job源码

https://gitee.com/xuxueli0323/xxl-job

2、下载解压,在源码文件夹xxl-jobmasterxxl-jobmasterdocdb里先导入SQL文件数据库

3、在IDEA中打开下载好的项目文件使用maven进行编译即可

xxl-jobadmin调度中心
xxl-jobcore公共依赖
xxl-jobexecutorsamples执行器Sample示例选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器
xxl-jobexecutorsamplespringboot:Springboot版本通过Springboot管理执行器推荐这种方式
xxl-jobexecutorsampleframeless:无框架版本

二、xxl-job的配置

首先配置调度中心

### web
server.port=9527
server.servlet.context-path=/xxl-job-admin
### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false
### resources
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://192.168.3.140:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
### datasource-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, 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=xxx
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, access token
xxl.job.accessToken=default_token
### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN
## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### xxl-job, log retention days
xxl.job.logretentiondays=30

这块我设置任务调度中心admin端口是9527(端口号可以自定义),spring.datasource.url地址填你导入sql文件的数据库

接着设置xxl-job-executorsample-springboot配置文件

# web port
server.port=9528
# no web
#spring.main.web-environment=false
# log config
logging.config=classpath:logback.xml
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:9527/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=default_token
### xxl-job executor appname
xxl.job.executor.appname=test
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

xxl-job-executor-sample-springboot端口号为了方便区分我设置了9528(端口号不能与其他端口重复

到此xxl-job的基本配置就设置好了

三、启动项目

分别启动xxl-job-admin调度中心和xxl-job-executor-sample-springboot的启动命令

打开链接http://localhost:9527/xxl-job-admin/

执行器管理新增执行器

配置执行器时,有几个注意的地方

执行器的AppName必须与xxl.job.executor.appname保持一致

这里新增执行器建议手动录入自动注册可能存在断开连接问题机器地址后的端口号要与xxl.job.executor.port端口号保持一致,且要加前缀https://

配置好执行器就可以编写定时任务

这里使用xuxueli提供定时任务示例,具体位置如下

注解中的值就是任务配置中的JobHandler

回到任务调度中心打开任务管理执行选择刚才新建测试执行器,点击右侧新增任务

这里以BEAN运行模式为例,JobHandler中的值填方法上注解@XxlJob的值,Cron表达式可以根据需求生成,下面贴一个cron链接,可以根据需要编写获取这里以两秒钟执行一次为例,配置完后点击保存

在线Cron表达式生成器

回到任务管理找到配置好的任务点击操作—-启动

定时任务就开始启动了,具体效果可以打开IDEA的9528服务效果

以此xxl-job的安装与配置结束,现在开始引入我们的springboot项目

xxl-job添加到已有项目

一、引入POM文件

<!-- xxl-job-core -->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.3.0</version>
        </dependency>

二、编写XxlJob的配置文件

因为上面用过properties了,这里展示一下使用YML来进行配置

xxl:
  job:
    accessToken: default_token
    admin:
      addresses: http://192.168.3.27:9527/xxl-job-admin
    executor:
      appname: fnTest
      address:
      ip:
      port: 9999
      logpath: D:Worklogs
      logretentiondays: 30

三、编写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配置类
 *
 * @author 单程车票
 */
@Slf4j
@Configuration
public 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;
	}
}

四、配置任务调度

还是需要打开xxl-job-admin任务调度中心服务

这里还是以上文说的9527为例

同样新增执行器

五、编写自己的定时任务

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.util.Date;

@Component
@Slf4j
public class TestJob {
	@XxlJob("FnHandler")
	public ReturnT<String> wechatActivityJobHandler(String param) {
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);
		log.info(">>>定时任务开始出发<<<param:{}", param);

		return ReturnT.SUCCESS;
	}
}

同样再回到任务调度中心,任务管理—新增任务

JobHandler填写注解@XxlJob中的值,Cron按自身要求编写保存

执行定时任务

至此,xxl-job已经添加到项目中了,可以去任务调度中心查看任务日志

篇文章就先分享到这里了,感谢浏览最后,有问题的话,欢迎大家留言

原文地址:https://blog.csdn.net/fannan521/article/details/132707242

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任

如若转载,请注明出处:http://www.7code.cn/show_39218.html

如若内容造成侵权/违法违规/事实不符,请联系代码007邮箱suwngjj01@126.com进行投诉反馈,一经查实,立即删除

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注