Loading...
墨滴

cxytiandi

2021/04/10  阅读:56  主题:极客黑

monkey-api-encrypt又增强了一个实用功能

框架主页:https://github.com/yinjihuan/monkey-api-encrypt

背景

有阵子没更新 monkey-api-encrypt 这个框架了,然后看了下 Github 上一些用户提的问题,挑了一个比较实用的进行了修复。

说问题之前先简单的讲下 monkey-api-encrypt 的原理,目前 monkey-api-encrypt 中核心部分就是用了 javax.servlet.Filter 来对数据进行加解密的处理,实现也比较简单。

唯一要注意的就是在 Filter 中如何知道当前访问的 uri 是否需要加解密,而是否需要加解密可以通过配置的方式指定,也可以通过注解的方式配置在方法上。基于注解的方式,在项目启动的时候会去扫描方法,将 uri 存储起来,这样在 Filter 中就可以判断当前访问的 uri 是否需要加解密了。

uri 匹配的方式存在的问题是对于目前比较流行的 Restful 风格的 API 不支持,因为 uri 不是固定的,无法匹配到,这就是当前版本要解决的问题。

其实最开始的版本用的是 spring 的@ResponseBodyAdvice @RequestBodyAdvice 实现的,后面才改成了 Filter 的方式。如果是之前的实现,那么就不会存在今天的问题了,因为在 Advice 中可以获取到当前访问的 Method 对象。

下面看怎么解决如何在 Filter 中通过当前访问的 uri 判断是否需要加解密的操作。

AntPathMatcher

spring-core 包中提供了一个 AntPathMatcher 类,可以用于路径的匹配。比如我的接口格式是/users/{id},当访问路径是/users/1001 的时候,这个路径应该匹配到/users/{id}才对,如果匹配上了/users/{id},那么就可以通过/users/{id}知道当前接口是不是需要加解密操作。

代码如下:

for (String u : list) {
    boolean match = antPathMatcher.match(u, prefixUri);
    if (match) {
        return true;
    }
}

list 格式:["get:/users/{id}"]

prefixUri:get:/users/1

循环将需要加解密的 uri 模板跟当前请求的 uri 进行匹配,如果匹配成功了,就证明需要加解密操作。

HandlerMapping

在做之前,我也想了下这个问题,可以借鉴 dispatcherServlet 中的代码。当我们的请求需要转发到对应的方法上,dispatcherServlet 就承担了这个工作。

通过获取 HandlerMapping,然后获取具体的 handler 对象,内部逻辑我们完全不需要关心,也不用担心会出 Bug,如果这个出 Bug 了那 Spring MVC 就没法玩了。

try {
    // 支持RestFul风格API
    // 采用Spring MVC内置的匹配方式将当前请求匹配到对应的Controller Method上,获取注解进行匹配是否要加解密
    HandlerExecutionChain handler = getHandler(request);
    if (Objects.isNull(handler)) {
        return false;
    }
    if (Objects.nonNull(handler.getHandler()) && handler.getHandler() instanceof HandlerMethod) {
        HandlerMethod handlerMethod = (HandlerMethod) handler.getHandler();
        String apiUri = RequestUriUtils.getApiUri(handlerMethod.getClass(), handlerMethod.getMethod(), request.getContextPath());
        if (list.contains(apiUri)) {
            return true;
        }
    }
} catch (Exception e) {
    throw new RuntimeException(e);
}
protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
    if (Objects.isNull(dispatcherServlet)) {
        return null;
    }
    if (dispatcherServlet.getHandlerMappings() != null) {
        for (HandlerMapping mapping : dispatcherServlet.getHandlerMappings()) {
            HandlerExecutionChain handler = mapping.getHandler(request);
            if (handler != null) {
                return handler;
            }
        }
    }
    return null;
}

完整参考源码:https://github.com/yinjihuan/monkey-api-encrypt/blob/master/monkey-api-encrypt-core/src/main/java/com/cxytiandi/encrypt/core/EncryptionFilter.java

新版本地址:https://search.maven.org/artifact/com.cxytiandi/monkey-api-encrypt-core/1.2.2.RELEASE/jar

总结

本文看似是在宣传一个新功能,其实我想分享给大家的是 Restful 这种 API 的处理场景,除了本文中的场景,在其他场景下也会遇到类似的问题。比如我们在用 Cat 做埋点的时候,如果不做任何处理,Cat 上的地址信息就是访问的 uri,比如 /users/1, /users/2 这种,其实这 2 个 uri 都是一个接口的请求,没办法归类。所以在埋点之前也需要将请求的 uri 转换下格式。

关于作者:尹吉欢,简单的技术爱好者,《Spring Cloud 微服务-全栈技术与案例解析》, 《Spring Cloud 微服务 入门 实战与进阶》作者, 公众号猿天地发起人。

cxytiandi

2021/04/10  阅读:56  主题:极客黑

作者介绍

cxytiandi