文档章节

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

wangyan9110
 wangyan9110
发布于 2017/07/31 09:52
字数 734
阅读 7.9K
收藏 217

#程序员薪资揭榜#你做程序员几年了?月薪多少?发量还在么?>>>

在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的设计思路.

关注公众号

输入图片说明

© 著作权归作者所有

wangyan9110

wangyan9110

粉丝 39
博文 10
码字总数 13360
作品 2
杭州
程序员
私信 提问
加载中

评论(8)

wangyan9110
wangyan9110 博主

引用来自“joshuazhan”的评论

从任务注册中心获取到对应的处理的Handelr
执行该Handelr

有点拼写上的问题

@joshuazhan 多谢指正
wpfc
wpfc

引用来自“wangyan9110”的评论

引用来自“wpfc”的评论

实现job接口,默认实现execute方法,但是自带参数JobExecutionContext类型,请问下job用的是哪个包下的job对象

@wpfc 内部接口
你好,我想问下你这个job对象是如何处理的?做了一定的封装吗?谢谢
joshuazhan
joshuazhan
从任务注册中心获取到对应的处理的Handelr
执行该Handelr

有点拼写上的问题
happut
happut
以前尝试过,在AbstractTaskHandler中增加getName(),每个类实现该方法 返回处理类的名称
还是这个方法好,使用也比以前那种方便
wangyan9110
wangyan9110 博主

引用来自“月夜筱风”的评论

不错,简单明了

@月夜筱风 多谢支持
wangyan9110
wangyan9110 博主

引用来自“wpfc”的评论

实现job接口,默认实现execute方法,但是自带参数JobExecutionContext类型,请问下job用的是哪个包下的job对象

@wpfc 内部接口
月夜筱风
月夜筱风
不错,简单明了
wpfc
wpfc
实现job接口,默认实现execute方法,但是自带参数JobExecutionContext类型,请问下job用的是哪个包下的job对象
使用Spring自定义注解实现任务路由的方法

在Spring mvc的开发中,我们可以通过RequestMapping来配,当前方法用于处理哪一个URL的请求.同样我们现在有一个需求,有一个任务调度器,可以按照不同的任务类型路由到不同的任务执行器。其本...

osc_0m4ypdo1
2018/07/11
1
0
SpringBoot中Async异步方法和定时任务介绍

1.功能说明 Spring提供了Async注解来实现方法的异步调用。即当调用Async标识的方法时,调用线程不会等待被调用方法执行完成即返回继续执行以下操作,而被调用的方法则会启动一个独立线程来执...

osc_o1mwzw8v
2018/06/25
11
0
Spring Boot实践--定时任务两种(Schedule与Quartz整合)

Spring Boot实践--定时任务两种(Schedule与Quartz整合) 最近在项目中使用到定时任务,之前一直都是使用Quartz 来实现,最近看Spring 基础发现其实Spring 提供 Spring Schedule 可以帮助我们实...

spinachgit
2018/02/11
859
0
Spring Boot 2 Webflux的全局异常处理

本文首先将会回顾Spring 5之前的SpringMVC异常处理机制,然后主要讲解Spring Boot 2 Webflux的全局异常处理机制。 SpringMVC的异常处理 Spring 统一异常处理有 3 种方式,分别为: 使用 注解...

aoho
2018/12/20
0
0
Spring注解方式实现任务调度

原文:http://docs.spring.io/spring/docs/4.0.1.BUILD-SNAPSHOT/javadoc-api/ 注解类型:EnableScheduling @Target(value=TYPE) @Retention(value=RUNTIME)@Import(value=SchedulingConfigu......

Mr_Tank_
2014/01/04
1.9W
1

没有更多内容

加载失败,请刷新页面

加载更多

如何在Windows上安装pip? - How to install pip on Windows?

问题: pip is a replacement for easy_install . pip替代了easy_install 。 But should I install pip using easy_install on Windows? 但是我应该在Windows上使用easy_install安装pip吗? ......

fyin1314
今天
21
0
gitlit二级目录访问

由于我们只有一个域名暴露,特殊需求,所以需要二级目录访问 配置文件在 defaults.properties 第1985行 contextPath 改掉就好了 # Context path for the GO application. You might want to...

shzwork
今天
24
0
OSChina 周一乱弹 —— 我电脑传染了新冠脚气

@性感码农 :不结婚,被老爸说,回村里别人都瞧不起你,及即使你赚了很多钱,不结婚,永远没有人瞧得起你。挺纳闷的,要别人瞧得起我干嘛 又不回村里, 跟他们生活也没什么交集啊, 用得着他...

小小编辑
今天
24
0
类加载的过程

加载->链接->初始化; 其中链接又分为:验证->准备->解析。

曦鱼violet
今天
21
0
Linux下几个与磁盘空间和文件尺寸相关的命令

硬盘是计算机非常重要的一个部件,不管是代码,还是 UI 、声音、文档,抑或是没人时偷偷看的小视频,都需要保存在硬盘里。 对于很多 Linux 服务器,会进行很多的编译操作。而编译操作在很多情...

Linux就该这么学
今天
10
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部