使用攔截器統一處理通用檢查

時間 2020-04-24

標籤使用攔截統一處理通用檢查简体版

原文原文鏈接

繁瑣的檢查

在平時的業務開發中，相信你們都有不少這樣的代碼：java

public void login(Parameter parameter) {
  if (!validateXXX(parameter)) {
    throw new BizException(ErrCode.PAMRM_ERROR);
  }
  
  // 真正的邏輯代碼
}

那麼，若是代碼還有其餘通用的校驗，並且每加一個接口都要加這些校驗邏輯，長此以往，代碼會顯得較臃腫，看起來會有不少重複的代碼，那麼有沒有辦法精簡這部分代碼呢？有！編程

Spring的HandlerInterceptor

先上代碼數組

攔截器定義

public class CheckXXXHandlerInterceptor extends HandlerInterceptorAdapter {

    final Map<Method, Boolean> methodCache = new IdentityHashMap<>();

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        HandlerMethod handlerMethod = (HandlerMethod) handler;

        /**
        這個是雙重判斷鎖單例
        外層的判斷，爲了不在實例已經建立好的狀況下再次加鎖獲取，影響性能；
        裏層的判斷，考慮在多線程環境下，多個線程同時過掉外層判斷，也就是都已經判斷變量爲空，若是不加一重判斷，仍是有可能重複建立。
        */
        Method method = handlerMethod.getMethod();
        if (!methodCache.containsKey(method)) {
            synchronized (methodCache) {
                if (!methodCache.containsKey(method)) {
                    boolean check = false;
                    if (method.isAnnotationPresent(CheckXXX.class)) {
                        check = method.getAnnotation(CheckXXX.class).value();
                    } else if (method.getDeclaringClass().isAnnotationPresent(CheckXXX.class)) {
                        check = method.getDeclaringClass().getAnnotation(CheckXXX.class).value();
                    }
                    methodCache.put(method, check);
                }
            }
        }
        if (methodCache.get(method)) {
            // do check
        }

        return true;
    }
}

註解定義

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface CheckXXX {
    boolean value() default true;
}

註解使用

@CheckXXX
public class XXXController {

    public void login(Parameter parameter) {
      // 真正的邏輯代碼
    }
}

這樣，就能抽離出通用的邏輯，精簡通用的代碼。那麼，這個攔截器是何時執行的呢？它的實現原理是什麼？安全

執行時機

經過查看自定義攔截器的UML類圖關係，能夠看出來，實際上是實現了HandlerInterceptor的preHandle方法，經過追蹤HandlerInterceptor的調用鏈路，最終是在請求進入分發器，執行doDispatch方法用的，而處理器是在初始化的時候就加載好。多線程

總體的流程以下：app

核心代碼：ide

if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    return;
}


boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HandlerInterceptor[] interceptors = getInterceptors();
    if (!ObjectUtils.isEmpty(interceptors)) {
        for (int i = 0; i < interceptors.length; i++) {
            HandlerInterceptor interceptor = interceptors[i];
            if (!interceptor.preHandle(request, response, this.handler)) {
                triggerAfterCompletion(request, response, null);
                return false;
            }
            this.interceptorIndex = i;
        }
    }
    return true;
}

攔截器數組interceptors是在Spring容器啓動的時候初始化好的，實現原理比較簡單，就是取出請求處理器的map，遍歷調用註冊好的攔截器。性能