這篇文章主要介紹了Spring Cloud Zuul新增過濾器過程解析,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

Zuul作為閘道器的其中一個重要功能，就是實現請求的鑑權。而這個動作我們往往是通過Zuul提供的過濾器來實現的。

一、過濾器方法的作用

想要使用Zuul實現過濾功能，我們需要自定義一個類繼承ZuulFilter類，並實現其中的四個方法，我們先看一下這四個方法的作用是什麼

public class MyFilter extends ZuulFilter {
  /**
   * filterType：返回字串，代表過濾器的型別。包含以下4種：
   * -- pre：請求在被路由之前執行
   * -- route：在路由請求時呼叫
   * -- post：在route和errror過濾器之後呼叫
   * -- error：處理請求時發生錯誤呼叫
   * @return 返回以上四個型別的名稱
   */
  @Override
  public String filterType() {
    return null;
  }

  /**
   * filterOrder：通過返回的int值來定義過濾器的執行順序，數字越小優先順序越高。
   * @return
   */
  @Override
  public int filterOrder() {
    return 0;
  }

  /**
   * shouldFilter：返回一個Boolean值，判斷該過濾器是否需要執行。返回true執行，返回false不執行。
   * @return
   */
  @Override
  public boolean shouldFilter() {
    return false;
  }

  /**
   * run：編寫過濾器的具體業務邏輯。
   * @return
   * @throws ZuulException
   */
  @Override
  public Object run() throws ZuulException {
    return null;
  }
}

二、自定義過濾器

我這裡以pre型別演示

@Component
public class LoginFilter extends ZuulFilter {

  //過濾型別 pre route post error
  @Override
  public String filterType() {
    return "pre";
  }

  //過濾優先順序，數字越小優先順序越高
  @Override
  public int filterOrder() {
    return 10;
  }

  //是否執行run方法
  @Override
  public boolean shouldFilter() {
    return true;
  }

  //過濾邏輯程式碼
  @Override
  public Object run() throws ZuulException {
    //獲取zuul提供的上下文物件
    RequestContext context = RequestContext.getCurrentContext();
    //獲取request物件
    HttpServletRequest request = context.getRequest();
    //獲取請求引數
    String token = request.getParameter("username");
    //判斷
    if (StringUtils.isBlank(username)){
      //過濾該請求，不對其進行路由
      context.setSendZuulResponse(false);
      //設定響應碼401
      context.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
      //設定響應體
      context.setResponseBody("request error....");
    }
    // 校驗通過，把登陸資訊放入上下文資訊，繼續向後執行
    context.set("username",username);
    return null;
  }
}

沒新增過濾功能之前是這樣的 ↓，無論加不加username都可以得到資料

添加了過濾功能之後是這樣的 ↓，只有加了username才能訪問

F12開啟控制檯，發現響應了401

三、過濾器執行的宣告週期

過濾器執行的宣告週期

正常流程：

請求到達首先會經過pre型別過濾器，而後到達route型別，進行路由，請求就到達真正的服務提供者，執行請求，返回結果後，會到達post過濾器。而後返回響應。

異常流程：

整個過程中，pre或者route過濾器出現異常，都會直接進入error過濾器，在error處理完畢後，會將請求交給POST過濾器，最後返回給使用者。

如果是error過濾器自己出現異常，最終也會進入POST過濾器，將最終結果返回給請求客戶端。

如果是POST過濾器出現異常，會跳轉到error過濾器，但是與pre和route不同的是，請求不會再到達POST過濾器了。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支援我們。