xxl-job的使用

new_daimond

已于 2022-08-18 15:06:46 修改

阅读量3.1k

点赞数 2

分类专栏： java 文章标签： java spring

于 2022-07-26 20:00:00 首次发布

本文链接：https://blog.csdn.net/new_daimond/article/details/125993932

版权

java 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

1、安装xxl-job

官网地址： https://www.xuxueli.com/xxl-job

1.1 安装步骤

1.1.1初始化数据库

新建数据库并执行脚本

“调度数据库初始化SQL脚本” 位置为:/xxl-job/doc/db/tables_xxl_job.sql

1.1.2编译源码

解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，源码结构如下：

1、xxl-job-admin：调度中心
2、xxl-job-core：公共依赖
3、xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
    ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
    ：xxl-job-executor-sample-frameless：无框架版本；

1.1.3部署调度中心

1.部署调度中心：xxl-job-admin
2.修改配置文件，主要修改如下的数据库部分，文件路径 /xxl-job/xxl-job-admin/src/main/resources/application.properties
### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
注意修改下面的token，保证连接的安全性
 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

1.1.4部署成功示例

调度中心访问地址：http://localhost:8080/xxl-job-admin（ip和port根据你部署服务ip和应用启动的端口决定）
成功示例图片
在这里插入图片描述
备注：默认登录账号 “admin/123456”，密码和账号可以自己在上面的配置文件中设置

1.2 其他安装方式

直接从docker下载

1.// Docker地址：https://hub.docker.com/r/xuxueli/xxl-job-admin/     (建议指定版本号)
2.docker pull xuxueli/xxl-job-admin

2、springboot集成xxl-job

步骤一

pom文件中引入了 “xxl-job-core” 的maven依赖；

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

步骤二

在application文件中设置参数

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=
### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

步骤三

配置configBean

@Configuration
public class XxlJobConfig {
@Bean
	public XxlJobSpringExecutor xxlJobExecutor() {
	    logger.info(">>>>>>>>>>> xxl-job config init.");
	    XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
	    xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
	    xxlJobSpringExecutor.setAppname(appname);
	    xxlJobSpringExecutor.setIp(ip);
	    xxlJobSpringExecutor.setPort(port);
	    xxlJobSpringExecutor.setAccessToken(accessToken);
	    xxlJobSpringExecutor.setLogPath(logPath);
	    xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
	    return xxlJobSpringExecutor;
	}
}

步骤四

示例demo如下：

@Component
public class InitJob {
    private Logger logger = LoggerFactory.getLogger(InitJob .class);
    @Autowired
    private InitStudentDataService initStudentDataService;

    @XxlJob("initStudentDataJob")
    public void initStudentDataJob(){
        logger.info("initStudentDataJob任务开始");
        try{
            initStudentDataService.initStudentData();
        }catch (Exception e){
            logger.info("初始化或者跟新数据异常:{}",e.getMessage());
        }
        logger.info("initStudentDataJob任务结束");
    }

3、使用API调用xxl-job

3.1 直接在linux上面调用xxl-job接口

调用登陆接口
curl -d "userName=admin&password=123456" http://10.75.29.30:18089/xxl-job-admin/login -X POST

3.2 服务器有端口限制是访问思路

1.先在服务器上面配置nginx，通过ng转发求情到后台
2.通过postman进行接口请求
3.具体的接口路径可以下载xxl-job源码查看，查看源码工具jd-gui-1.6.6.jar
4.先通过postman调用登陆接口，后调用其他接口

代码图

4、小技巧

定时任务传参后台获取参数方法：

只能传入string类型的数据，通过下面方法获取数据
 String jobParam = XxlJobHelper.getJobParam();