xxl-job手动注册JobHandler

已于 2024-01-05 11:47:26 修改
阅读量6.9k 收藏 4
点赞数 2
分类专栏： # Spring # Java 文章标签： xxl xxl-job JobHandler IJobHandler execute
于 2021-09-29 10:00:34 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wsdhla/article/details/120409044
版权
Java 同时被 2 个专栏收录
27 篇文章 0 订阅
订阅专栏
Spring
20 篇文章 0 订阅
订阅专栏

感兴趣的朋友们可以Follow下：想惑1025。

XXL-JOB官网：分布式任务调度平台XXL-JOB

配置文件

xxl:
  job:
    admin:
      # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      addresses: http://127.0.0.1:8080/xxl-job-admin

    # 执行器通讯TOKEN [选填]：非空时启用；
    accessToken:

    executor:
      # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      appname:
      # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: 9999
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath: /data/applogs/xxl-job/jobhandler
      # 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
      logretentiondays: -1

JobHandler业务实现类

package org.etoak;

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;


@JobHandler(value = "MyJobHandler")
public class MyJobHandler extends IJobHandler {

    @Override
    public ReturnT<String> execute(String taskParam) {
        System.out.println(">>>>>>>>>定时任务begin*********************");
        return SUCCESS;
    }
}

正常向xxl-admin注册jobHandler的方式有两种，官网这样描述

如果已经正确进行上述配置，可将执行器项目编译打部署，系统提供多种执行器Sample示例项目，选择其中一个即可，各自的部署方式如下。

  1. xxl-job-executor-sample-springboot：项目编译打包成springboot类型的可执行JAR包，命令启动即可；
  2. xxl-job-executor-sample-frameless：项目编译打包成JAR包，命令启动即可；

要么是以web容器运行，要么以jar包运行，最终的目的就是要java进程一直保持运行。

其实通过XxlJobSpringExecutor可以自动扫描带@JobHandler的IJobHandler实现类来向xxl-admin进行注册，但是有些业务场景需要手动注册

手动注册代码如下：

// ...
// 配置需要注册的实现类(多个，比如: com.etoak.实现类1,org.etoak.实现类2)
// 反射生成实现类的实例clazz
// ...



// 有@JobHandler的类实例，注册为jobHandler
JobHandler jobHandlerAnnotation = clazz.getAnnotation(JobHandler.class);
if (jobHandlerAnnotation != null) {
    String jobHandlerAnnotationName = jobHandlerAnnotation.value();
    if (StringUtils.hasLength(jobHandlerAnnotationName)) {
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
        //注册Bean
        defaultListableBeanFactory.registerBeanDefinition(jobHandlerAnnotationName, beanDefinitionBuilder.getBeanDefinition());
        IJobHandler handler = (IJobHandler) o;
        if (XxlJobExecutor.loadJobHandler(jobHandlerAnnotationName) != null) {
            logger.error(">>>>>>>>>>>>>>>>>>>>>JobHandler名称【{}】已被注册，请检查！", jobHandlerAnnotationName);
        }
        XxlJobExecutor.registJobHandler(jobHandlerAnnotationName, handler);
        logger.info(">>>>>>>>>>>>>>>>>>>>>注册JobHandler成功【{}】", jobHandlerAnnotationName);
    } else {
        logger.error(">>>>>>>>>>>>>>>>>>>>>【{}】的@JobHandler字段value为空，请检查！", clazzName);
    }
}

===============================================

根据注解获取所有bean

applicationContext.getBeansWithAnnotation(JobHandler.class)

// 自动注册

// ***admin***
// 服务启动时
XxlJobDynamicScheduler.initRpcProvider
XxlJobDynamicScheduler.getExecutorBiz
AdminBizImpl
JobRegistryMonitorHelper
XxlJobServiceImpl

// 客户端启动时
XxlRpcProviderFactory.initConfig
XxlRpcProviderFactory.invokeService



// ***xxl-core***
ExecutorRegistryThread.start
XxlJobExecutor.start
XxlJobExecutor.initAdminBizList


// ***rpc-core***
XxlRpcReferenceBean

// 执行
NettyHttpServerHandler.channelRead0
NettyHttpServerHandler.process
XxlRpcProviderFactory.invokeService

项目上使用的xxl-job版本为2.0.2-SNAPSHOT，依赖的spring-boot版本为1.5.20.RELEASE，有点低。因为需要引入jasypt-spring-boot-starter对配置文件敏感信息加密，需要提高spring-boot版本。

现在打算将spring-boot版本提高至2.7.18，但是报以下异常：

10:09:02.722 logback [main] INFO  org.quartz.impl.StdSchedulerFactory - Using default implementation for ThreadExecutor
10:09:02.735 logback [main] INFO  o.quartz.core.SchedulerSignalerImpl - Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
10:09:02.735 logback [main] INFO  org.quartz.core.QuartzScheduler - Quartz Scheduler v.2.3.1 created.
10:09:02.737 logback [main] INFO  org.quartz.core.QuartzScheduler - Scheduler DefaultQuartzScheduler_$_tian001704420542724 shutting down.
10:09:02.738 logback [main] INFO  org.quartz.core.QuartzScheduler - Scheduler DefaultQuartzScheduler_$_tian001704420542724 paused.
10:09:02.742 logback [main] WARN  o.q.impl.jdbcjobstore.JobStoreTX - Database connection shutdown unsuccessful.
java.sql.SQLException: There is no DataSource named 'null'
	at org.quartz.utils.DBConnectionManager.shutdown(DBConnectionManager.java:135)
	at org.quartz.impl.jdbcjobstore.JobStoreSupport.shutdown(JobStoreSupport.java:746)
	at org.quartz.core.QuartzScheduler.shutdown(QuartzScheduler.java:732)
	at org.quartz.impl.StdSchedulerFactory.shutdownFromInstantiateException(StdSchedulerFactory.java:1419)
	at org.quartz.impl.StdSchedulerFactory.instantiate(StdSchedulerFactory.java:1379)
	at org.quartz.impl.StdSchedulerFactory.getScheduler(StdSchedulerFactory.java:1567)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.createScheduler(SchedulerFactoryBean.java:679)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.prepareScheduler(SchedulerFactoryBean.java:616)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.afterPropertiesSet(SchedulerFactoryBean.java:504)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1863)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1800)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:620)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542)
	at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335)
	at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:936)
	at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:929)
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:591)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147)
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:732)
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:409)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:308)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1300)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1289)
	at com.xxl.job.admin.XxlJobAdminApplication.main(XxlJobAdminApplication.java:13)
10:09:02.743 logback [main] INFO  org.quartz.core.QuartzScheduler - Scheduler DefaultQuartzScheduler_$_tian001704420542724 shutdown complete.
10:09:02.746 logback [main] WARN  o.s.b.w.s.c.AnnotationConfigServletWebServerApplicationContext - Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'getSchedulerFactoryBean' defined in class path resource [com/xxl/job/admin/core/conf/XxlJobDynamicSchedulerConfig.class]: Invocation of init method failed; nested exception is org.quartz.SchedulerConfigException: DataSource name not set.
10:09:02.750 logback [main] INFO  o.a.catalina.core.StandardService - Stopping service [Tomcat]
10:09:02.770 logback [main] INFO  o.s.b.a.l.ConditionEvaluationReportLoggingListener - 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
10:09:02.810 logback [main] ERROR o.s.boot.SpringApplication - Application run failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'getSchedulerFactoryBean' defined in class path resource [com/xxl/job/admin/core/conf/XxlJobDynamicSchedulerConfig.class]: Invocation of init method failed; nested exception is org.quartz.SchedulerConfigException: DataSource name not set.
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1804)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:620)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542)
	at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335)
	at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:936)
	at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:929)
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:591)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147)
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:732)
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:409)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:308)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1300)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1289)
	at com.xxl.job.admin.XxlJobAdminApplication.main(XxlJobAdminApplication.java:13)
Caused by: org.quartz.SchedulerConfigException: DataSource name not set.
	at org.quartz.impl.jdbcjobstore.JobStoreSupport.initialize(JobStoreSupport.java:643)
	at org.quartz.impl.jdbcjobstore.JobStoreTX.initialize(JobStoreTX.java:57)
	at org.quartz.impl.StdSchedulerFactory.instantiate(StdSchedulerFactory.java:1356)
	at org.quartz.impl.StdSchedulerFactory.getScheduler(StdSchedulerFactory.java:1567)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.createScheduler(SchedulerFactoryBean.java:679)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.prepareScheduler(SchedulerFactoryBean.java:616)
	at org.springframework.scheduling.quartz.SchedulerFactoryBean.afterPropertiesSet(SchedulerFactoryBean.java:504)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1863)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1800)
	... 16 common frames omitted

解决方式一：将spring-boot版本降至2.5.6或以下

解决方式二：修改quatz.propeties文件

# org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX

# 将上面配置改为此配置
org.quartz.jobStore.class: org.springframework.scheduling.quartz.LocalDataSourceJobStore

另外，升级spring-boot版本，数据源也由org.apache.tomcat.jdbc.pool.DataSource改为com.zaxxer.hikari.HikariDataSource

#spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
#spring.datasource.tomcat.max-wait=10000
#spring.datasource.tomcat.max-active=30
#spring.datasource.tomcat.test-on-borrow=true
#spring.datasource.tomcat.validation-interval=30000

spring.datasource.hikari.pool-name=xxl-pool
spring.datasource.hikari.connection-timeout=30000
spring.datasource.hikari.max-lifetime=60000
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.maximum-pool-size=100
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.connection-test-query=SELECT 1

另外还有一个问题，会发现所有的资源都找不到：

11:40:41.083 logback [http-nio-8181-exec-3] WARN  o.s.web.servlet.PageNotFound - No mapping for GET /xxl-job-admin/jobinfo
11:40:41.859 logback [http-nio-8181-exec-1] WARN  o.s.web.servlet.PageNotFound - No mapping for GET /xxl-job-admin/jobinfo
11:40:44.927 logback [http-nio-8181-exec-4] WARN  o.s.web.servlet.PageNotFound - No mapping for GET /xxl-job-admin
11:40:45.320 logback [http-nio-8181-exec-5] WARN  o.s.web.servlet.PageNotFound - No mapping for GET /xxl-job-admin

如果用的模板引擎是freemarker，还需要主要springboot版本升级之后默认的模板文件后缀名变化，由ftl变为ftlh，继续使用ftl，需增加配置

spring.freemarker.suffix=.ftl

原因在这：

# server.context-path=/xxl-job-admin
server.servlet.context-path=/xxl-job-admin

# spring.resources.static-locations=classpath:/static/
spring.web.resources.static-locations=classpath:/static/

wsdhla
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

wsdhla

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值