使用Spring自定义注解实现任务路由的方法

 更新时间:2017年07月31日 11:41:06   作者:wangyan9110  
本篇文章主要介绍了使用Spring自定义注解实现任务路由的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

在Spring mvc的开发中,我们可以通过RequestMapping来配,当前方法用于处理哪一个URL的请求.同样我们现在有一个需求,有一个任务调度器,可以按照不同的任务类型路由到不同的任务执行器。其本质就是通过外部参数进行一次路由和Spring mvc做的事情类似。简单看了Spring mvc的实现原理之后,决定使用自定义注解的方式来实现以上功能。

自定义TaskHandler注解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface TaskHandler {

  String taskType() default "";
}

以上定义了任务处理器的注解,其中@Component表示在spring 启动过程中,会扫描到并且注入到容器中。taskType表示类型。

任务处理器定义

public abstract class AbstractTaskHandler {

  /**
   * 任务执行器
   *
   * @param task 任务
   * @return 执行结果
   */
   public abstract BaseResult execute(Task task);
}

以上定义了一个任务执行的处理器,其他所有的具体的任务执行器继承实现这个方法。其中Task表示任务的定义,包括任务Id,执行任务需要的参数等。

任务处理器实现

接下来,我们可以实现一个具体的任务处理器。

@TaskHandler(taskType = "UserNameChanged")
public class UserNameChangedSender extends AbstractTaskHandler {
  @Override
  public BaseResult execute(Task task) {
   return new BaseResult();
  }
}

以上我们就实现一个用户名修改通知的任务处理器,具体的业务逻辑这里没有实现。

其中:@TaskHandler(taskType = "UserNameChanged"),这里我们指定这个Handler用于处理用户名变更的任务

任务处理Handler注册

public class TaskHandlerRegister extends ApplicationObjectSupport {

  private final static Map<String, AbstractTaskHandler> TASK_HANDLERS_MAP = new HashMap<>();

  private static final Logger LOGGER = LoggerFactory.getLogger(TaskHandlerRegister.class);

  @Override
  protected void initApplicationContext(ApplicationContext context) throws BeansException {
    super.initApplicationContext(context);
    Map<String, Object> taskBeanMap = context.getBeansWithAnnotation(TaskHandler.class);
    taskBeanMap.keySet().forEach(beanName -> {
      Object bean = taskBeanMap.get(beanName);
      Class clazz = bean.getClass();
      if (bean instanceof AbstractTaskHandler && clazz.getAnnotation(TaskHandler.class) != null) {
        TaskHandler taskHandler = (TaskHandler) clazz.getAnnotation(TaskHandler.class);
        String taskType = taskHandler.taskType();
        if (TASK_HANDLERS_MAP.keySet().contains(taskType)) {
          throw new RuntimeException("TaskType has Exits. TaskType=" + taskType);
        }
        TASK_HANDLERS_MAP.put(taskHandler.taskType(), (AbstractTaskHandler) taskBeanMap.get(beanName));
        LOGGER.info("Task Handler Register. taskType={},beanName={}", taskHandler.taskType(), beanName);
      }
    });
  }

  public static AbstractTaskHandler getTaskHandler(String taskType) {
    return TASK_HANDLERS_MAP.get(taskType);
  }
}

这里继承了Spring的ApplicationObjectSupport类,具体的注册过程如下

  1. Spring完成bean的初始化
  2. 查找spring的容器中,所有带有TaskHandler注解的bean
  3. 校验bean是否为AbstractTaskHandler类型,获取到taskType
  4. 把该bean放到TASK_HANDLERS_MAP容器中,即注册完成

任务执行

接下来我们来看下任务执行

public class TaskExecutor implements Job {

  private static final String TASK_TYPE = "taskType";

  @Override
  public BaseResult execute(Task task){
    String taskType=task.getTaskType();
    if (TaskHandlerRegister.getTaskHandler(taskType) == null) {
      throw new RuntimeException("can't find taskHandler,taskType=" + taskType);
    }
    AbstractTaskHandler abstractHandler = TaskHandlerRegister.getTaskHandler(taskType);
    return abstractHandler.execute(task);
  }
}

这里发起任务执行的是一个Job,具体过程如下

  1. 校验该任务类型,有没有在注册中心注册相关Handler
  2. 从任务注册中心获取到对应的处理的Handelr
  3. 执行该Handelr

以上过程就完成了,可以实现基于注解的一个任务路由过程。其实现思路来自于Spring mvc的RequestMapping的设计思路.希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • springboot项目部署到宝塔的详细图文教程

    springboot项目部署到宝塔的详细图文教程

    网上关于宝塔运行springBoot的东西说有点迷糊,但是有一句话很重要,Spring boot项目只需要JDK环境即可部署成功,下面这篇文章主要给大家介绍了关于springboot项目部署到宝塔的详细图文教程,需要的朋友可以参考下
    2023-05-05
  • MyEclipse开发一个webservice接口

    MyEclipse开发一个webservice接口

    这篇文章主要为大家详细介绍了MyEclipse开发一个webservice接口,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • SpringCloud中使用webclient(get和post)请求微服务接口数据

    SpringCloud中使用webclient(get和post)请求微服务接口数据

    在SpringCloud项目中使用WebClient调用微服务时,涉及配置WebClient、发起get和post请求等操作,如请求头设置、服务地址配置、数据转换处理、异常处理等,避免在循环中使用WebClient请求、路径设置细节以及数据返回处理技巧,本文旨在帮助理解和应用WebClient进行微服务调用
    2024-10-10
  • Spring Security注册过滤器注意事项详解

    Spring Security注册过滤器注意事项详解

    前两天和小伙伴聊了 Spring Security+JWT 实现无状态登录,然后有小伙伴反馈了一个问题,感觉这是一个我们平时写代码容易忽略的问题,所以本文给大家介绍了Spring Security注册过滤器注意事项,需要的朋友可以参考下
    2024-06-06
  • Java 实现对称加密算法

    Java 实现对称加密算法

    这篇文章主要介绍了Java 实现对称加密算法的相关资料,帮助大家更好的理解和学习Java,感兴趣的朋友可以了解下
    2020-11-11
  • springboot应用中使用过滤器的过程详解

    springboot应用中使用过滤器的过程详解

    过滤器通常用于实现跨切面的功能,例如身份验证、日志记录、请求和响应的修改、性能监控等,这篇文章主要介绍了springboot应用中使用过滤器,需要的朋友可以参考下
    2023-06-06
  • idea 打包maven项目忽略test文件的操作

    idea 打包maven项目忽略test文件的操作

    这篇文章主要介绍了idea 打包maven项目忽略test文件的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • 解决J2EE-session在浏览器关闭后失效问题

    解决J2EE-session在浏览器关闭后失效问题

    最近做项目使用的是Spring+SpringMVC+Mybatis框架,maven管理目录的javaweb端系统,对于session的一些问题,在此小编给大家分享到脚本之家平台,需要的朋友参考下吧
    2018-01-01
  • 基于Java protected的深入理解

    基于Java protected的深入理解

    本篇文章是对Java protected进行了详细的分析介绍,需要的朋友参考下
    2013-06-06
  • 微信开发之使用java获取签名signature

    微信开发之使用java获取签名signature

    这篇文章主要为大家详细介绍了微信开发之使用java获取签名signature,感兴趣的小伙伴们可以参考一下
    2016-08-08

最新评论