在前面的一些文章中我們有講到，通過攔截器我們可以做很多的事情，包括介面統一的 引數校驗、 登入校驗、許可權校驗等，也可以做一些HTTP響應體寫入邏輯，比如我們另一篇文章所說的《解決跨域問題》，本篇我們也就是講解下，使用攔截器對開放的介面做公共引數校驗功能實現。

下面我以我們實際開發中所遇到的問題，來舉例說明。

需求描述

在對外開放介面的時候，我們的呼叫端是很多的，比如：APP/PC/WECHAT公眾號or小程式 等等，當線上環境某一個使用者出現問題時，如果這個問題僅僅是後端還好，但是如果是前後端需要配合解決的錯誤，我們就需要更多的呼叫客戶端的一些資訊，這個時候你去問客戶app什麼版本、什麼手機這顯然是不妥的，所以我們應該收集更多的呼叫資訊，以便我們做後續業務處理、日誌記錄等等的一些操作，通常需要對客戶端統一收集的資訊比如 呼叫來源、app版本號、api的版本號、安全驗證資訊 等等。

解決方式

我們將這些資訊放入頭資訊（HTTP HEAD中），下面給出在引數命名的例子：

• X-Token 使用者的登入token（用於兌換使用者登入資訊）
• Api-Version api的版本號
• App-Version app版本號
• Call-Source 呼叫來源(IOS、ANDROID、PC、WECHAT、WEB)
• Authorization 安全校驗引數（後面會有文章詳細介紹該如何做安全校驗）

然後我們將該些資訊在攔截器中做統一的引數校驗，下面我們給出響應的程式碼，給大家一個寫法上的參考O(∩_∩)O~

我們為這些請求頭引數變數定義常量類：

package com.zhuma.demo.constant;

import com.zhuma.demo.enums.CallSource;


/**
 * @desc Header的key羅列
 * 
 * @author zhumaer
 * @since 8/31/2017 3:00 PM
 */
public class HeaderConstants {

    /**
     * 使用者的登入token
     */
    public static final String X_TOKEN = "X-Token";

    /**
     * api的版本號
     */
 

    public static final String API_VERSION = "Api-Version";

    /**
     * app版本號
     */
    public static final String APP_VERSION = "App-Version";

    /**
     * 呼叫來源 {@link CallSource}
     */
    public static final String CALL_SOURCE = "Call-Source";

}

對於呼叫的來源我們可以定義一個列舉類：

package com.zhuma.demo.enums;

/**
 * @desc 呼叫來源列舉類
 * 
 * @author zhumaer
 * @since 8/31/2017 3:00 PM
 */
public enum CallSource {
    WEB,
    PC,
    WECHAT,
    IOS,
    ANDROID;

    public static boolean isValid(String name) {
        for (CallSource callSource : CallSource.values()) {
            if (callSource.name().equals(name)) {
                return true;
            }
        }
        return false;
    }

}

攔截器類：

package com.zhuma.demo.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.zhuma.demo.constant.HeaderConstants;
import com.zhuma.demo.enums.CallSource;
import com.zhuma.demo.enums.ResultCode;
import com.zhuma.demo.exception.BusinessException;
import com.zhuma.demo.util.StringUtil;

/**
 * @desc HEADER頭引數校驗
 * 
 * @author zhumaer
 * @since 8/29/2017 3:00 PM
 */
@Component
public class HeaderParamsCheckInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            String callSource = request.getHeader(HeaderConstants.CALL_SOURCE);
            String apiVersion = request.getHeader(HeaderConstants.API_VERSION);
            String appVersion = request.getHeader(HeaderConstants.APP_VERSION);

            if (StringUtil.isAnyBlank(callSource, apiVersion)) {
                throw new BusinessException(ResultCode.PARAM_NOT_COMPLETE);
            }

            try {
                Double.valueOf(apiVersion);
            } catch (NumberFormatException e) {
                throw new BusinessException(ResultCode.PARAM_IS_INVALID);
            }

            if ((CallSource.ANDROID.name().equals(callSource) || CallSource.IOS.name().equals(callSource)) && StringUtil.isEmpty(appVersion)) {
                throw new BusinessException(ResultCode.PARAM_NOT_COMPLETE);
            }

            if (!CallSource.isValid(callSource)) {
                throw new BusinessException(ResultCode.PARAM_IS_INVALID);
            }

        }

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // nothing to do
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // nothing to do
    }

}

說明
上述校驗邏輯其實很簡單，如果校驗不通過直接以一個異常丟擲，交由統一的異常處理器去處理後續事情，對於app版本資訊可能只有android、ios才會有所以我們根據這種特殊情況做了下判斷。

攔截器配置類（以spring boot為例）：

package com.zhuma.demo.config.web;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import com.zhuma.demo.interceptor.HeaderParamsCheckInterceptor;
import com.zhuma.demo.interceptor.LoginedAuthInterceptor;

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {

    @Autowired
    private LoginedAuthInterceptor loginedAuthInterceptor;

    @Autowired
    private HeaderParamsCheckInterceptor headerParamsCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        String apiUri = "/**";
        //請求頭引數校驗
        registry.addInterceptor(headerParamsCheckInterceptor).addPathPatterns(apiUri);
        //登入攔截(這個上一篇文章講過了，這裡說明下兩個攔截器前後呼叫順序就是本配置類程式碼的配置順序)
        registry.addInterceptor(loginedAuthInterceptor).addPathPatterns(apiUri);
    }

}

最後

讀完文章你會發現，文章跟前兩遍文章對攔截器的使用上基本上沒有什麼創新，只是在使用例子也就是業務的邏輯上程式碼的變化，其實是的，攔截器使用起來還是蠻簡單的，但是該在什麼地方去使用它，這個還是要過考慮下的，所以在這篇文章中我們主要是以實際開發中所用到的問題做舉例，這可能引出你對攔截器更好使用的一些想法，希望你在以後的使用中能夠更好的利用攔截器的特性，寫出更美觀、更好維護的程式碼O(∩_∩)O~

歡迎關注我們的公眾號或加群，等你哦！