Spring Cloud Zuul添加過濾器過程解析

更新時間：2019年12月04日 08:33:15 作者：SongAlone

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

Zuul作為網(wǎng)關(guān)的其中一個重要功能，就是實現(xiàn)請求的鑒權(quán)。而這個動作我們往往是通過Zuul提供的過濾器來實現(xiàn)的。

一、過濾器方法的作用

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

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

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

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

  /**
   * run：編寫過濾器的具體業(yè)務(wù)邏輯。
   * @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";
  }

  //過濾優(yōu)先級，數(shù)字越小優(yōu)先級越高
  @Override
  public int filterOrder() {
    return 10;
  }

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

  //過濾邏輯代碼
  @Override
  public Object run() throws ZuulException {
    //獲取zuul提供的上下文對象
    RequestContext context = RequestContext.getCurrentContext();
    //獲取request對象
    HttpServletRequest request = context.getRequest();
    //獲取請求參數(shù)
    String token = request.getParameter("username");
    //判斷
    if (StringUtils.isBlank(username)){
      //過濾該請求，不對其進行路由
      context.setSendZuulResponse(false);
      //設(shè)置響應(yīng)碼401
      context.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
      //設(shè)置響應(yīng)體
      context.setResponseBody("request error....");
    }
    // 校驗通過，把登陸信息放入上下文信息，繼續(xù)向后執(zhí)行
    context.set("username",username);
    return null;
  }
}

沒添加過濾功能之前是這樣的 ↓，無論加不加username都可以得到數(shù)據(jù)