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

 更新时间:2019年12月04日 08:33:15   作者:SongAlone  
这篇文章主要介绍了Spring Cloud Zuul添加过滤器过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

这篇文章主要介绍了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过滤器了。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • SpringMVC中的DispatcherServlet初始化流程详解

    SpringMVC中的DispatcherServlet初始化流程详解

    这篇文章主要介绍了SpringMVC中的DispatcherServlet初始化流程详解,DispatcherServlet这个前端控制器是一个Servlet,所以生命周期和普通的Servlet是差不多的,在一个Servlet初始化的时候都会调用该Servlet的init()方法,需要的朋友可以参考下
    2023-12-12
  • SpringBoot实现简单的日志链路追踪

    SpringBoot实现简单的日志链路追踪

    随着分布式应用的普及,现在的一些应用系统不再像以前,所有的文件(前后端程序)都打包在一个包中,本文通过一个简单的SpringBoot应用来总结,我们如何将日志串联起来,文中有详细的代码示例,需要的朋友可以参考下
    2023-10-10
  • java interface的两个经典用法

    java interface的两个经典用法

    这篇文章主要为大家详细介绍了java interface的两个经典用法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-09-09
  • 如何在不使用spring框架中使用aop的功能

    如何在不使用spring框架中使用aop的功能

    这篇文章主要介绍了如何在不使用spring框架中使用aop的功能,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • MyBatis中的ResultMap的association和collection标签详解

    MyBatis中的ResultMap的association和collection标签详解

    这篇文章主要介绍了MyBatis中的ResultMap的association和collection标签详解,主要包括association标签常用参数及id & result标签参数详解,本文给大家介绍的非常详细,需要的朋友可以参考下
    2022-10-10
  • java中url任意跳转漏洞的解决

    java中url任意跳转漏洞的解决

    URL任意跳转漏洞是一种安全漏洞,它发生在应用程序没有正确地验证目标URL,允许攻击者将用户重定向到恶意网站,本文就来介绍一下漏洞的解决修复方案,感兴趣的可以了解一下
    2024-06-06
  • Java中Map循环遍历的五种方法实现

    Java中Map循环遍历的五种方法实现

    本文主要介绍了Java中Map循环遍历的五种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • SpringBoot激活profiles的几种方式

    SpringBoot激活profiles的几种方式

    多环境是最常见的配置隔离方式之一,可以根据不同的运行环境提供不同的配置信息来应对不同的业务场景,这篇文章主要介绍了SpringBoot激活profiles的几种方式,需要的朋友可以参考下
    2019-10-10
  • SpringBoot中WebClient的实践

    SpringBoot中WebClient的实践

    SpringBoot中的WebClient是一个用于与RESTful服务交互的非阻塞、响应式HTTP客户端,本文就来介绍一下SpringBoot中WebClient的实践,感兴趣的可以了解一下
    2024-12-12
  • java使用poi读取ppt文件和poi读取excel、word示例

    java使用poi读取ppt文件和poi读取excel、word示例

    这篇文章主要介绍了java使用poi读取ppt文件和poi读取excel、word示例,需要的朋友可以参考下
    2014-03-03

最新评论