写点什么

(WebFlux)001、如何自定义注解实现功能

作者:编号94530
  • 2022 年 7 月 30 日
  • 本文字数:2279 字

    阅读完需:约 7 分钟

(WebFlux)001、如何自定义注解实现功能

一、背景

最近在项目又在压测,但基于 Http 请求类型的校验过多,已有想法把 Http 请求换成 Spring 中的 WebClient,但是由于不是原配(SpringWebFlux + WebClient),如果采用 WebClent....block()这样的实现方式,阻塞获取结果,老是觉得别扭,所以就想把 SpringMVC 换成 SpringWebFlux(新手上路),大胆尝试,直接发车。


现在把换的过程中的问题和解决方式列出来,供大家参考。


SpringBoot 版本号: <version>2.6.10</version>

二、正文

在使用 SpringMVC 实现业务逻辑时,我们经常会采用一些自定义注解,通过自定义注解实现访问 URL 过滤、鉴权等一些列功能。但是在 WebFlux 中如何实现呢?

2.1 MVC 实现方案

在 MVC 中,我们一般直接实现HandlerInterceptor,然后实现HandlerInterceptor#preHandle()方法即可,然后在其中实现自己的逻辑。代码如下、


先实现自定义注解:


/** * <p>校验权限</p> * * @author fattycal@qq.com * @since 2022/7/24 */@Target({ElementType.TYPE, ElementType.METHOD}) // 可用于方法和类上@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface CheckPermission {
boolean check() default true;}
复制代码


为什么要标记在方法和类上呢? 那是因为有可能某一个类的方法都需要 CheckPermission 或者都不 check,直接标记在类上就省事了。


接下来是实现拦截器:


/** * <p>拦截器</p> * * @author fattycal@qq.com * @since 2022/7/24 */@Componentpublic class CheckPermissionInterceptor implements HandlerInterceptor {
@Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (handler instanceof HandlerMethod) { HandlerMethod methodHandle = (HandlerMethod) handler; CheckPermission permission = methodHandle.getMethodAnnotation(CheckPermission.class); if (Objects.isNull(permission)) { // handler 所有bean 上面寻找 permission = AnnotationUtils.findAnnotation(methodHandle.getBeanType(), CheckPermission.class); }
if (Objects.nonNull(permission)) { // TODO do something.. } } return true; }}
复制代码


当我们在当前 Handler 上没有找到注解的的时候,我们就去所在类上寻找,判断是否需要校验。偷鸡,减少代码注解标记量(心理美滋滋)。

2.2 WebFlux 实现方案

MVC 的实现方式对我们来说可谓是手到擒来,闭着眼睛也能把代码敲完(吹嘘居多...),这么常见、基础、重要的功能,在 WebFlux 中是如何实现的呢?


我在翻了好多文档后,终于找到了答案,当然要分享给大家了哇,原文采用的 kotlin,我就用 JAVA 了。原文出处


在 WebFlux 中没有HandlerInterceptor,我们需要采用提供的WebFilter实现功能。注解同上,实现的逻辑代码如下。


/** * <p>WebFlux实现方案</p> * * @author fattycal@qq.com * @since 2022/7/24 */@Componentpublic class CheckPermissionWebFilter implements WebFilter {        @Autowired    // 关键,通过RequestMappingHandlerMapping 我们可以获取到MethodHandler    private RequestMappingHandlerMapping handlerMapping;
@Override public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { return handlerMapping.getHandler(exchange).switchIfEmpty(chain.filter(exchange)) .flatMap(handler -> { // 熟悉的味道,将handler转换成HandlerMethod if (handler instanceof HandlerMethod) { HandlerMethod methodHandle = (HandlerMethod) handler; CheckPermission permission = methodHandle.getMethodAnnotation(CheckPermission.class); if (Objects.isNull(permission)) { // handler 所有bean 上面寻找 permission = AnnotationUtils.findAnnotation(methodHandle.getBeanType(), CheckPermission.class); }
if (Objects.nonNull(permission)) { // TODO do something.. } } return chain.filter(exchange); } ); }}
复制代码


可以看到,在实现过程中,最关键的是要知道有org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping这个类,知道之后,我们就可以通过其获取到 Handler。拿到 Handler 后就可以按照我们自己的套路来实现具体的业务逻辑了。

2.3 对比

通过对比 MVC 和 WebFlux 的实现方式来看,Spring 对两种都做了比较好的支持,都是通过获取到 HandlerMethod,然后在对具体的逻辑处理。对比后发现,代码相似度达到 80%~90%。这也要求我们要做的可能是更多的知道其有的 API,这样可以减少我们在对项目做转换时带来的时间成本问题。至于实现,我们可以在熟悉使用时,一步步探索,挖掘实现逻辑,提高知识存储量。

三、总结

尝试新东西的时候是一个不断探索,学习的过程。多看,多搜,多学。

发布于: 刚刚阅读数: 2
用户头像

编号94530

关注

你的每一个点赞,我都当做喜欢 2020.04.29 加入

新时代农民工

评论

发布
暂无评论
(WebFlux)001、如何自定义注解实现功能_spring_编号94530_InfoQ写作社区