框架主頁: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://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 微服務 入門 實戰與進階》作者, 公眾號猿天地發起人。