xxl-job客户端使用方式


xxl-job客户端使用方式

1. 引入maven依赖


            com.xuxueli
            xxl-job-core

2. 编写配置类

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

        return xxlJobSpringExecutor;
    }

    /**
     * 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
     *
     *      1、引入依赖:
     *          
     *             org.springframework.cloud
     *             spring-cloud-commons
     *             ${version}
     *         
     *
     *      2、配置文件,或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */


}

3. 配置文件application.properties中配置config类依赖的属性值

xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

### xxl-job, access token
xxl.job.accessToken=

### xxl-job executor appname
xxl.job.executor.appname=omega-job
### 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=F:\logs
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

4. 编写job任务,方法上添加注解,识别名为alartTicketHandler的handler

@Component
public class AutoAlertJob {

    private static final String TICKET_ALERT_MSG_TEMPLATE = "您今天还有%s个任务未及时处理,请及时登陆平台中心进行任务处理。其中:特急任务%s个;紧急任务%s个;一般任务%s个";
    private static final Logger logger = LoggerFactory.getLogger(AutoAlertJob.class);

    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("alartTicketHandler")
    public void alartTicketHandler() throws Exception {
        // 获取任务参数
        String param = XxlJobHelper.getJobParam();
        logger.info("XXL-JOB, Hello World:{}",param);
        logger.info("!!!!!OE工单自动提醒任务,开始执行");
        logger.error("!!!!!OE工单自动提醒任务,结束执行");
    }

}