XXL-JOB二次开发嵌入自己的项目

小草王

已于 2023-01-03 00:06:23 修改

阅读量1.2k

点赞数

文章标签： java

于 2022-12-29 15:18:46 首次发布

本文链接：https://blog.csdn.net/temie/article/details/128468654

版权

1.下载XXL-JOB进行启动

1. 拉取代码Gitee
2.创建数据库

/xxl-job/doc/db/tables_xxl_job.sql

3.调整admin数据库配

/xxl-job/xxl-job-admin/src/main/resources/application.properties

4.启动admin项目 http://localhost:8080/xxl-job-admin 默认登录账号 “admin/123456”
在这里插入图片描述

2.创建一个自己的项目包

1.拷贝admin中的代码
在这里插入图片描述
2.重命名Dao为mapper

3.将model移入entity 删除 old包

4.修改实体类后缀为Entity 并使用lombok的注解

5.移除util中的FtlUtil

6.配置yml 配置说明

spring:
  #邮箱配置
  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的配置 https://www.xuxueli.com/xxl-job/#%E9%85%8D%E7%BD%AE%E5%B1%9E%E6%80%A7%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E%EF%BC%9A
xxl:
  job:
    # 调度中心通讯TOKEN [选填]：非空时启用；
    accessToken: ''
    # 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
    i18n: 'zh_CN'
    #调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
    logretentiondays: 30
    # 调度线程池最大线程配置【必填】
    triggerpool:
      fast:
        max: 200
      slow:
        max: 200

7.拷贝i18n配置
在这里插入图片描述
8.核心controller内容不能修改

	@ResponseBody
	//@Log("XxlJob通信API")
	@RequestMapping("/api/{uri}")
	//@NotDesUrlResponse(msg = "XxlJob通信API禁止加密")
	public ReturnT<String> api(HttpServletRequest request, @PathVariable("uri") String uri, @RequestBody(required = false) String data) {

		// valid
		if (!"POST".equalsIgnoreCase(request.getMethod())) {
			return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, HttpMethod not support.");
		}
		if (uri==null || uri.trim().length()==0) {
			return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, uri-mapping empty.");
		}
		if (XxlJobConfig.getAdminConfig().getAccessToken()!=null
				&& XxlJobConfig.getAdminConfig().getAccessToken().trim().length()>0
				&& !XxlJobConfig.getAdminConfig().getAccessToken().equals(request.getHeader(XxlJobRemotingUtil.XXL_JOB_ACCESS_TOKEN))) {
			return new ReturnT<String>(ReturnT.FAIL_CODE, "The access token is wrong.");
		}

		// services mapping
		if ("callback".equals(uri)) {
			List<HandleCallbackParam> callbackParamList = GsonTool.fromJson(data, List.class, HandleCallbackParam.class);
			return adminBiz.callback(callbackParamList);
		} else if ("registry".equals(uri)) {
			RegistryParam registryParam = GsonTool.fromJson(data, RegistryParam.class);
			return adminBiz.registry(registryParam);
		} else if ("registryRemove".equals(uri)) {
			RegistryParam registryParam = GsonTool.fromJson(data, RegistryParam.class);
			return adminBiz.registryRemove(registryParam);
		} else {
			return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, uri-mapping("+ uri +") not found.");
		}
	}

3.创建执行器

1.创建新执行器
在这里插入图片描述
2.项目配置xxl-job
appname:为执行器名称上方配置的

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

3.创建配置类初始化xxl-job配置

@RefreshScope
@Configuration
public class XxlJobConfig {
    private final 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.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        return xxlJobSpringExecutor;
    }
}

4.创建task

@Component
public class TestTask {
    @XxlJob("testTask")
    public ReturnT<String> pokemonEsKeywordsTask(String param){
        XxlJobHelper.log("XXL-JOB, Hello World.");
        return ReturnT.SUCCESS;
    }
}