欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

spring cloud-zuul的Filter使用详解

程序员文章站 2023-12-04 10:54:40
在前面我们使用zuul搭建了网关 关于网关的作用,这里就不再次赘述了,我们今天的重点是zuul的filter。通过filter,我们可以实现安全控制,比如,只有请求参...

在前面我们使用zuul搭建了网关

关于网关的作用,这里就不再次赘述了,我们今天的重点是zuul的filter。通过filter,我们可以实现安全控制,比如,只有请求参数中有用户名和密码的客户端才能访问服务端的资源。那么如何来实现filter了?

要想实现filter,需要以下几个步骤:

1、继承zuulfilter类,为了验证filter的特性,我们这里创建3个filter

根据用户名来过滤

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.httpservletrequest;  
import com.netflix.zuul.zuulfilter; 
import com.netflix.zuul.context.requestcontext; 
public class accessusernamefilter extends zuulfilter { 
  @override 
  public object run() { 
    requestcontext ctx = requestcontext.getcurrentcontext(); 
    httpservletrequest request = ctx.getrequest(); 
 
    system.out.println(string.format("%s accessusernamefilter request to %s", request.getmethod(), request.getrequesturl().tostring())); 
 
    string username = request.getparameter("username");// 获取请求的参数 
    if(null != username && username.equals("chhliu")) {// 如果请求的参数不为空,且值为chhliu时,则通过 
      ctx.setsendzuulresponse(true);// 对该请求进行路由 
      ctx.setresponsestatuscode(200); 
      ctx.set("issuccess", true);// 设值,让下一个filter看到上一个filter的状态 
      return null; 
    }else{ 
      ctx.setsendzuulresponse(false);// 过滤该请求,不对其进行路由 
      ctx.setresponsestatuscode(401);// 返回错误码 
      ctx.setresponsebody("{\"result\":\"username is not correct!\"}");// 返回错误内容 
      ctx.set("issuccess", false); 
      return null; 
    } 
  } 
 
  @override 
  public boolean shouldfilter() { 
    return true;// 是否执行该过滤器,此处为true,说明需要过滤 
  } 
 
  @override 
  public int filterorder() { 
    return 0;// 优先级为0,数字越大,优先级越低 
  } 
 
  @override 
  public string filtertype() { 
    return "pre";// 前置过滤器 
  } 
} 

通过继承zuulfilter然后覆写上面的4个方法,就可以实现一个简单的过滤器,下面就相关注意点进行说明
filtertype:返回一个字符串代表过滤器的类型,在zuul中定义了四种不同生命周期的过滤器类型,具体如下:

  1. pre:可以在请求被路由之前调用
  2. route:在路由请求时候被调用
  3. post:在route和error过滤器之后被调用
  4. error:处理请求时发生错误时被调用

zuul的主要请求生命周期包括“pre”,“route”和“post”等阶段。对于每个请求,都会运行具有这些类型的所有过滤器。

filterorder:通过int值来定义过滤器的执行顺序

shouldfilter:返回一个boolean类型来判断该过滤器是否要执行,所以通过此函数可实现过滤器的开关。在上例中,我们直接返回true,所以该过滤器总是生效

run:过滤器的具体逻辑。需要注意,这里我们通过ctx.setsendzuulresponse(false)令zuul过滤该请求,不对其进行路由,然后通过ctx.setresponsestatuscode(401)设置了其返回的错误码

过滤器间的协调

过滤器没有直接的方式来访问对方。 它们可以使用requestcontext共享状态,这是一个类似map的结构,具有一些显式访问器方法用于被认为是zuul的原语,内部是使用threadlocal实现的,有兴趣的同学可以看下源码。

再建一个过滤器,根据密码来过滤:

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.httpservletrequest; 
import com.netflix.zuul.zuulfilter; 
import com.netflix.zuul.context.requestcontext;  
public class accesspasswordfilter extends zuulfilter {  
  @override 
  public object run() { 
    requestcontext ctx = requestcontext.getcurrentcontext(); 
    httpservletrequest request = ctx.getrequest(); 
 
    system.out.println(string.format("%s accesspasswordfilter request to %s", request.getmethod(), request.getrequesturl().tostring())); 
 
    string username = request.getparameter("password"); 
    if(null != username && username.equals("123456")) { 
      ctx.setsendzuulresponse(true); 
      ctx.setresponsestatuscode(200); 
      ctx.set("issuccess", true); 
      return null; 
    }else{ 
      ctx.setsendzuulresponse(false); 
      ctx.setresponsestatuscode(401); 
      ctx.setresponsebody("{\"result\":\"password is not correct!\"}"); 
      ctx.set("issuccess", false); 
      return null; 
    } 
  } 
 
  @override 
  public boolean shouldfilter() { 
    requestcontext ctx = requestcontext.getcurrentcontext(); 
    return (boolean) ctx.get("issuccess");// 如果前一个过滤器的结果为true,则说明上一个过滤器成功了,需要进入当前的过滤,如果前一个过滤器的结果为false,则说明上一个过滤器没有成功,则无需进行下面的过滤动作了,直接跳过后面的所有过滤器并返回结果 
  } 
 
  @override 
  public int filterorder() { 
    return 1; // 优先级设置为1 
  } 
 
  @override 
  public string filtertype() { 
    return "pre"; 
  } 
} 

最后建一个post过滤器

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.httpservletrequest;  
import com.netflix.zuul.zuulfilter; 
import com.netflix.zuul.context.requestcontext;  
public class accesstokenfilter extends zuulfilter { 
  @override 
  public object run() { 
    requestcontext ctx = requestcontext.getcurrentcontext(); 
    httpservletrequest request = ctx.getrequest(); 
 
    system.out.println(string.format("%s accesstokenfilter request to %s", request.getmethod(), 
        request.getrequesturl().tostring())); 
     
    ctx.setsendzuulresponse(true); 
    ctx.setresponsestatuscode(200); 
    ctx.setresponsebody("{\"name\":\"chhliu\"}");// 输出最终结果 
    return null; 
  } 
 
  @override 
  public boolean shouldfilter() { 
    return true; 
  } 
 
  @override 
  public int filterorder() { 
    return 0; 
  } 
 
  @override 
  public string filtertype() { 
    return "post";// 在请求被处理之后,会进入该过滤器 
  } 
} 

2、在主类中,先开启前面的两个过滤器

@bean 
  public accessusernamefilter accessusernamefilter() { 
    return new accessusernamefilter(); 
  } 
   
  @bean 
  public accesspasswordfilter accesspasswordfilter(){ 
    return new accesspasswordfilter(); 
  } 

3、输入请求,验证

(1)请求为:http://localhost:8768/h2service/user/1?username=chhliu

测试结果为:{"result":"password is not correct!"}

控制台打印结果

get accessusernamefilter request to http://localhost:8768/h2service/user/1 
get accesspasswordfilter request to http://localhost:8768/h2service/user/1 

通过了accessusernamefilter过滤器,在验证accesspasswordfilter过滤器的时候失败了

后台无sql打印,说明请求没有被路由

(2)请求为:http://localhost:8768/h2service/user/1?password=123456

测试结果为:{"result":"username is not correct!"}

控制台打印结果:
get accessusernamefilter request to http://localhost:8768/h2service/user/1 

说明到了accessusernamefilter过滤器,但是没有到accesspasswordfilter过滤器,因为accessusernamefilter过滤器的优先级高一些,会先执行,在执行的时候,发现过滤条件不符合,于是跳过了后面所有的过滤器,并返回结果
后台无sql打印,说明请求没有被路由

(3)请求为:http://localhost:8768/h2service/user/1?password=123456&username=chhliu

测试结果为:


 
    "id": 1, 
    "username": "user1", 
    "name": "张三", 
    "age": 20, 
    "balance": 100.00 
 

控制台打印的结果:

get accessusernamefilter request to http://localhost:8768/h2service/user/1 
get accesspasswordfilter request to http://localhost:8768/h2service/user/1 

说明是先执行了accessusernamefilter然后才执行accesspasswordfilter这也和我们前面说的order的值越小,优先级越高是吻合的。

同时被请求的服务有sql输出:

hibernate: select user0_.id as id1_0_0_, user0_.age as age2_0_0_, user0_.balance as balance3_0_0_, user0_.name as name4_0_0_, user0_.username as username5_0_0_ from user user0_ where user0_.id=? 

说明请求被路由了。

4、开启post过滤器,再跑一次

测试结果:发现post过滤器是最后执行的,尽管它的优先级为0

关于zuul的filter的生命周期,见下图

spring cloud-zuul的Filter使用详解

注:上图有个小错误,routing应该是route

5、拓展

zuul还提供了一类特殊的过滤器,分别为:staticresponsefilter和surgicaldebugfilter

staticresponsefilter:staticresponsefilter允许从zuul本身生成响应,而不是将请求转发到源。

surgicaldebugfilter:surgicaldebugfilter允许将特定请求路由到分隔的调试集群或主机。

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