Idea+maven+spring-cloud项目搭建系列--6整合xxl-job

本文是在项目整合了nacos只上进行的整合，spirng-cloud 整合nacos 可以参考：

1 xxl-job 介绍：

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

2 微服务中增加xxl-job：

2.1 微服务增加xxl-job jar 依赖：
jar 地址：https://mvnrepository.com/search?q=xxl-job-core

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

2.2 nacos 对应微服务的配置文件增加xxl-job 参数配置

xxl: 
  job: 
    admin: 
      addresses: http://localhost:8080/xxl-job-admin
    accessToken: lgx123456
    executor:
      appname: dev-bluegrass-coree-service
      # logpath: /root/xxljob/data/applogs/jobhandler
      logretentiondays: 10

2.3 微服务配置文件增加xxl-job 参数配置：

  job:
    executor:
      ip: 172.28.20.154
      port: 9087

参数含义：

• 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
  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

2.4微服务增加xxljob 配置类：
XxlJobConfig.java

package org.lgx.bluegrass.bluegrasscoree.config;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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
 */
@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.executor.appname}")
    private String appName;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.accessToken}")
    private String accessToken;

    @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;
    }


}

2.5 业务测试类
XxlJobHandlerConfig.java

package org.lgx.bluegrass.bluegrasscoree.config;


import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.lgx.bluegrass.bluegrasscoree.service.xxljob.TaskService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * @Description TODO
 * @Date 2021/1/14 17:23
 * @Author lgx
 * @Version 1.0
 */
@Component
public class XxlJobHandlerConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
    // test
    public static final String taskCal = "taskCal";
    @Autowired
    private TaskService taskService;

    /**
     * @参数[param]

     * @创建时间 2020/3/22
     * @修改人和其他信息
     */
    @XxlJob(taskCal)
    public ReturnT<String> emotionEmotionCal() throws Exception {
        logger.debug("XXL-JOB, taskCal Start.");
        // 执行参数获取
        String param = XxlJobHelper.getJobParam();
        taskService.testTask();
        logger.debug("XXL-JOB, taskCal End.");
        return ReturnT.SUCCESS;
    }
}

TaskService.java

package org.lgx.bluegrass.bluegrasscoree.service.xxljob;

/**
 * @Description TODO
 * @Date 2021/3/3 17:14
 * @Author lgx
 * @Version 1.0
 */
public interface TaskService {
    void testTask();
}

TaskServiceImpl.java

package org.lgx.bluegrass.bluegrasscoree.serviceimp.xxljob;

import org.lgx.bluegrass.bluegrasscoree.service.xxljob.TaskService;
import org.springframework.stereotype.Service;

/**
 * @Description TODO
 * @Date 2021/3/3 17:14
 * @Author lgx
 * @Version 1.0
 */
@Service
public class TaskServiceImpl implements TaskService {
    @Override
    public void testTask() {
        System.out.println("task is sucess！");
    }
}

2.6 增加执行器和任务
增加执行器：

增加任务：

执行一次查看执行结果：

3 通过aop 拦截xxl-job 的rpc 请求：

import com.xxl.job.core.context.XxlJobHelper;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class XxlJobHandlerMonitor {
	// 拦截标记有XxlJob的方法
    @Pointcut("@annotation(com.xxl.job.core.handler.annotation.XxlJob)")
    public void xxlJobCut() {
    }
	// demo 进入方法前的前置处理
    @Before(value = "xxlJobCut()")
    public void permissionCheck(JoinPoint joinPoint){
        String param = XxlJobHelper.getJobParam();
        System.out.println("\"123\" = " + "123");

    }
}

本文参考：
1 xxljob 使用；
2 aop切面的使用；