Spring Cloud Zuul添加过滤器过程解析

时间:2021-04-02 人气:0

这篇文章主要介绍了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都可以得到数据