(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)
@Documented
public @interface CheckPermission {

    boolean check() default true;
}

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

接下来是实现拦截器:

/**
 * <p>拦截器</p>
 *
 * @author fattycal@qq.com
 * @since 2022/7/24
 */
@Component
public 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
 */
@Component
public 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,这样可以减少我们在对项目做转换时带来的时间成本问题。至于实现,我们可以在熟悉使用时,一步步探索,挖掘实现逻辑,提高知识存储量。

三、总结

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,264评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,549评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,389评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,616评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,461评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,351评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,776评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,414评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,722评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,760评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,537评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,381评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,787评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,030评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,304评论 1 252
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,734评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,943评论 2 336

推荐阅读更多精彩内容