xxl-job使用指南

xxl-job使用指南

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

一、安装依赖

1.1 基础依赖

说明解释

本文只讲解已部署好的xxl-job如何使用

依赖地址

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

二、配置xxl-job

2.1 目录结构

2.2 配置文件代码

XxlJobConfig

package xx.xx.crawler.supplier.configuration;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Data
@ConfigurationProperties(prefix = "xxl.job")
@Configuration
public class XxlJobConfig {
    /**
     * 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
     */
    private String appname;

    /**
     * 服务注册地址,优先使用该配置作为注册地址 为空时使用内嵌服务 ”IP:PORT“ 作为注册地址 从而更灵活的支持容器类型执行器动态IP和动态映射端口问题
     */
    private String address;

    /**
     * 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP ，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和
     * "调度中心请求并触发任务"
     */
    private String ip;

    /**
     * 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
     */
    private Integer port = 8900;

    /**
     * 执行器通讯TOKEN [选填]：非空时启用；
     */
    private String accessToken;

    /**
     * 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
     */
    private String logPath = "logs/applogs/xxl-job/jobhandler";

    /**
     * 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
     */
    private Integer logRetentionDays = 30;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses("部署地址");
        xxlJobSpringExecutor.setAppname("supplier");
        //xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        //xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        return xxlJobSpringExecutor;
    }
}

可以留意到@ConfigurationProperties(prefix = "xxl.job")这段注解，通过配置类来实现不同环境下的xxl-job地址以及端口号的设置

2.3 注意点

2.3.1.port=8900

本地测试：端口号需要与内网穿透地址的端口号一致，下图红框处要写8900，下图中我写的不对

(本地测试连接需要内网穿透)

内网穿透工具地址：https://natapp.cn/

2.3.2 setAdminAddresses

xxlJobSpringExecutor.setAdminAddresses 设置对应的xxl-job地址（注册到对应地址上的xxl-job)

具体使用地址看自己部署的地址

2.3.3 setAppname

要保证该命名和三、在xxl-job中注册服务中注册的执行器名称相同

三、在xxl-job中注册服务

3.1 登录xxl-job服务中心

地址：找运维要，自己部署的自己知道~

账户密码：找运维要，自己部署的自己知道~

3.2 注册执行器

3.2.1 点击新增

3.2.2 新增执行器

注意点：线上部署使用自动注册，本地调用使用手动录入，录入地址为内网穿透提供的地址（笔记本可用自动注册，宽带用户只能手动录入）【初学，如有大佬知道原因请指正】

确保这里的端口号和二、配置文件代码中相同(这里不同仅做展示)

3.2.3 注册完毕

可以在执行器管理中心查看

3.3 创建调度任务

3.3.1 点击新增

当然我这边是已经有创建好的任务

3.3.2 创建任务

JobHandler在代码中配置，配置方法如下

@XxlJob()  //使用该注解

实例

增加该注解，取消原本的定时服务，将其注册到xxl-job中。" "中的自定义命名即为JobHandler中的命名

四、执行测试，日志查看

4.1 执行

4.2 调度日志

查看日志，没问题就收工~