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过滤器了。

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

相关文章

  • Java实现雪花算法的示例代码

    Java实现雪花算法的示例代码

    SnowFlow算法是Twitter推出的分布式id生成算法,主要核心思想就是利用64bit的long类型的数字作为全局的id。本文将用Java语言实现雪花算法,感兴趣的可以学习一下
    2022-03-03
  • Java源码解析HashMap的keySet()方法

    Java源码解析HashMap的keySet()方法

    今天小编就为大家分享一篇关于Java源码解析HashMap的keySet()方法,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • 简单易用的Spring Boot邮件发送demo

    简单易用的Spring Boot邮件发送demo

    本文将介绍如何使用Spring Boot发送邮件,我们将演示如何配置SMTP邮件服务器,创建一个邮件模板,以及如何使用JavaMailSender发送邮件,我们还将介绍如何测试我们的邮件发送代码
    2023-12-12
  • Java JConsole远程连接配置案例详解

    Java JConsole远程连接配置案例详解

    这篇文章主要介绍了Java JConsole远程连接配置案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • SpringBoot配置MongoDB多数据源的方法步骤

    SpringBoot配置MongoDB多数据源的方法步骤

    这篇文章主要介绍了SpringBoot配置MongoDB多数据源的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • 基于eclipse-temurin镜像部署spring boot应用的实现示例

    基于eclipse-temurin镜像部署spring boot应用的实现示例

    本文提供了基于eclipse-temurin镜像部署Spring Boot应用的详细实现示例,通过使用Docker镜像,可以轻松地创建和管理Spring Boot应用程序的容器化环境,感兴趣的可以了解一下
    2023-08-08
  • 解决@RequestBody搭配@Data的大坑

    解决@RequestBody搭配@Data的大坑

    这篇文章主要介绍了解决@RequestBody搭配@Data的大坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • java如何对接企业微信的实现步骤

    java如何对接企业微信的实现步骤

    本文主要介绍了java如何对接企业微信的实现步骤,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • java多线程之线程安全的单例模式

    java多线程之线程安全的单例模式

    这篇文章主要为大家详细介绍了java多线程之线程安全的单例模式,文章内容全面,感兴趣的小伙伴们可以参考一下
    2016-03-03
  • Java基础之关键字final详解

    Java基础之关键字final详解

    这篇文章主要介绍了Java基础之关键字final详解,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-05-05

最新评论