ZuulFilter基礎

Zuul作為整個微服務架構的閘道器實現，是整個後臺系統的入口，因此，經常會有對所有經過閘道器的請求進行操作的場景。這裡，我們可以繼承ZuulFilter類來實現自定義的過濾器。

Zuul定義的四種Filter的型別：

PRE：在請求被路由之前呼叫，可以使用這種過濾器實現身份驗證、在叢集中選擇請求的微服務、記錄除錯Log等。
ROUTE：將請求路由到對應的微服務，用於構建傳送給微服務的請求。
POST：在請求被路由到對應的微服務以後執行，可用來為Response新增HTTP Header、將微服務的Response傳送給客戶端等。
ERROR

：在其他階段發生錯誤時執行該過濾器。

從下圖中可以明確瞭解Zuul中各種Filter執行的順序：

具體實現

LoginFilter.java：

package com.example.filters;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.PRE_DECORATION_FILTER_ORDER;
import
 
 static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.PRE_TYPE;

/**
 * Created by Skye on 2018/1/11.
 */
public class LoginFilter extends ZuulFilter {

    /**
     * 指定該Filter的型別
     * ERROR_TYPE = "error";
     * POST_TYPE = "post";
     * PRE_TYPE = "pre";
     * ROUTE_TYPE = "route";
     */
 

    @Override
    public String filterType() {
        return PRE_TYPE;
    }

    /**
     * 指定該Filter執行的順序（Filter從小到大執行）
     * DEBUG_FILTER_ORDER = 1;
     * FORM_BODY_WRAPPER_FILTER_ORDER = -1;
     * PRE_DECORATION_FILTER_ORDER = 5;
     * RIBBON_ROUTING_FILTER_ORDER = 10;
     * SEND_ERROR_FILTER_ORDER = 0;
     * SEND_FORWARD_FILTER_ORDER = 500;
     * SEND_RESPONSE_FILTER_ORDER = 1000;
     * SIMPLE_HOST_ROUTING_FILTER_ORDER = 100;
     * SERVLET_30_WRAPPER_FILTER_ORDER = -2;
     * SERVLET_DETECTION_FILTER_ORDER = -3;
     */
    @Override
    public int filterOrder() {
        return PRE_DECORATION_FILTER_ORDER - 1;
    }

    /**
     * 指定需要執行該Filter的規則
     * 返回true則執行run()
     * 返回false則不執行run()
     */
    @Override
    public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        String requestUrl = request.getRequestURL().toString();

        // 請求URL內不包含login或join則需要經過該過濾器，即執行run()
        return !requestUrl.contains("login") && !requestUrl.contains("join");
    }

    /**
     * 該Filter具體的執行活動
     */
    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        HttpSession httpSession = request.getSession();

        // 若session中不包含userId，則這次請求視為未登入請求，不給予路由，而提示“請登入”
        if (httpSession.getAttribute("userId") == null) {
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(200);
            // 為使得中文字元不亂碼
            ctx.getResponse().setCharacterEncoding("UTF-8");
            ctx.setResponseBody("請登入");
        }
        return null;
    }
}

SpringcloudZuulApplication.java中需要包含以下程式碼即可使該Filter生效。

@Bean
public LoginFilter loginFilter() {
    return new LoginFilter();
}