前言

過濾器是Zuul的核心元件，這篇文章我們來詳細討論Zuul的過濾器。下面話不多說，來看看詳細的介紹吧。

過濾器型別與請求生命週期

Zuul大部分功能都是通過過濾器來實現的。Zuul中定義了四種標準過濾器型別，這些過濾器型別對應於請求的典型生命週期。

(1) PRE：這種過濾器在請求被路由之前呼叫。我們可利用這種過濾器實現身份驗證、在叢集中選擇請求的微服務、記錄除錯資訊等。

(2) ROUTING：這種過濾器將請求路由到微服務。這種過濾器用於構建傳送給微服務的請求，並使用Apache HttpClient或Netfilx Ribbon請求微服務。

(3) POST：這種過濾器在路由到微服務以後執行。這種過濾器可用來為響應新增標準的HTTP Header、收集統計資訊和指標、將響應從微服務傳送給客戶端等。

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

除了預設的過濾器型別，Zuul還允許我們建立自定義的過濾器型別。例如，我們可以定製一種STATIC型別的過濾器，直接在Zuul中生成響應，而不將請求轉發到後端的微服務。

過濾器功能則負責對請求的處理過程進行干預，是實現請求校驗、服務聚合等功能的基礎。然而實際上，路由功能在真正執行時，它的路由對映和請求轉發都是由幾個不同的過濾器完成的。其中，路由對映主要通過pre型別的過濾器完成，它將請求路徑與配置的路由規則進行匹配，以找到需要轉發的目標地址；而請求轉發的部分則是由route型別的過濾器來完成，對pre型別過濾器獲得的路由地址進行轉發。所以，過濾器可以說是Zuul實現API閘道器功能最為核心的部件，每一個進入Zuul的HTTP請求都會經過一系列的過濾器處理鏈得到請求響應並返回給客戶端。

當外部HTTP請求到達API閘道器服務的時候，首先它會進入第一個階段pre，在這裡它會被pre型別的過濾器進行處理，該型別的過濾器主要目的是在進行請求路由之前做一些前置加工，比如請求的校驗等。在完成了pre型別的過濾器處理之後，請求進入第二個階段routing，也就是之前說的路由請求轉發階段，請求將會被routing型別過濾器處理，這裡的具體處理內容就是將外部請求轉發到具體服務例項上去的過程，當服務例項將請求結果都返回之後，routing階段完成，請求進入第三個階段post，此時請求將會被post型別的過濾器進行處理，這些過濾器在處理的時候不僅可以獲取到請求資訊，還能獲取到服務例項的返回資訊，所以在post型別的過濾器中，我們可以對處理結果進行一些加工或轉換等內容。另外，還有一個特殊的階段error，該階段只有在上述三個階段中發生異常的時候才會觸發，但是它的最後流向還是post型別的過濾器，因為它需要通過post過濾器將最終結果返回給請求客戶端

專案結構如下：

EurekaApplication類

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;

@EnableZuulProxy
@SpringBootApplication  //開啟啟動程式入口類
public class EurekaApplication {
  public static void main(String[] args) {
    SpringApplication.run(EurekaApplication.class, args);
  }
  /**
   * 即使其它配置都寫好的話，那麼不新增這個 Bean 的方法的話，還是不會執行任何過濾的方法；
   *
   * @return
   */
  @Bean
  public PreFilter preFilter() {
      return new PreFilter();
  }

PreFilter類

package com.example.demo;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.LoggerFactory;

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

public class PreFilter extends ZuulFilter{

	 private static final org.slf4j.Logger Logger = LoggerFactory.getLogger(PreFilter.class);

	    /**
	     * 前置過濾器。
	     *
	     * 但是在 zuul 中定義了四種不同生命週期的過濾器型別：
	     *
	     *      1、pre：可以在請求被路由之前呼叫；
	     *
	     *      2、route：在路由請求時候被呼叫；
	     *
	     *      3、post：在route和error過濾器之後被呼叫；
	     *
	     *      4、error：處理請求時發生錯誤時被呼叫；
	     *
	     * @return
	     */
	    @Override
	    public String filterType() {
	        return "pre";
	    }

	    /**
	     * 過濾的優先順序，數字越大，優先順序越低。
	     *
	     * @return
	     */
	    @Override
	    public int filterOrder() {
	        return 1;
	    }

	    /**
	     * 是否執行該過濾器。
	     *
	     * true：說明需要過濾；
	     *
	     * false：說明不要過濾；
	     *
	     * @return
	     */
	    @Override
	    public boolean shouldFilter() {
	        return true;
	    }

	    /**
	     * 過濾器的具體邏輯。
	     *
	     * @return
	     */
	    @Override
	    public Object run() {
	        HttpServletRequest request = RequestContext.getCurrentContext().getRequest();
	        String host = request.getRemoteHost();
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        Logger.info("                    請求的host:{}                          ", host);
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        Logger.info("<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
	        return null;
	    }
}

application.yml配置

server:
  port: 8040
spring:
  application:
    name: spring-cloud-zuul-api-gateway-filter
eureka:
  client:
    serviceUrl:
      defaultZone: http://user:[email protected]:8761/eureka
  instance:
    prefer-ip-address: true

zuul: 
  routes:
    users:    #此處可以隨便定義一個，只要唯一就行
      path: /user-path/**     # 一個*號只能匹配一個級別的路徑，比如只能訪問：/user-path/order  而兩個*表示可以匹配多個層級,例如專案訪問路徑為：http://loaclhost:8084/user-path/user/1
      serviceId: spring-cloud-user  #反向代理到這個服務

pom.xml配置

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.example.demo</groupId>
	<artifactId>spring-cloud-zuul-api-gateway-filter</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<name>spring-cloud-zuul-api-gateway-filter</name>
	<description>spring-cloud-zuul-api-gateway-filter</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.4.1.RELEASE</version>
	</parent>

	<properties>
		<!-- 檔案拷貝時的編碼 -->
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<!-- 編譯時的編碼 -->
		<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
		<!-- jdk版本 -->
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
        <!-- API閘道器模組 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

        <!-- 客戶端發現模組，由於文件說 Zuul 的依賴裡面不包括 eureka 客戶端發現模組，所以這裡還得單獨新增進來 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>	
		<!-- 用於熱部署 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
		</dependency>
	</dependencies>
	<dependencyManagement>
		<dependencies>
			<!-- 版本依賴管理，故之後新增依賴無需指定version -->
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>Camden.SR2</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<!-- 用以為integration-test提供支援。 -->
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>