Filter怎么在springcloud-zuul中使用
这篇文章将为大家详细讲解有关Filter怎么在spring cloud-zuul中使用,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。
目前创新互联已为近1000家的企业提供了网站建设、域名、网络空间、网站托管维护、企业网站设计、烟台网站维护等服务,公司将坚持客户导向、应用为本的策略,正道将秉承"和谐、参与、激情"的文化,与客户和合作伙伴齐心协力一起成长,共同发展。
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中定义了四种不同生命周期的过滤器类型,具体如下:
pre:可以在请求被路由之前调用
route:在路由请求时候被调用
post:在route和error过滤器之后被调用
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/h3service/user/1?username=chhliu
测试结果为:{"result":"password is not correct!"}
控制台打印结果
GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1
GET AccessPasswordFilter request to http://localhost:8768/h3service/user/1
通过了AccessUserNameFilter过滤器,在验证AccessPasswordFilter过滤器的时候失败了
后台无sql打印,说明请求没有被路由
(2)请求为:http://localhost:8768/h3service/user/1?password=123456
测试结果为:{"result":"username is not correct!"}
控制台打印结果:
GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1
说明到了AccessUserNameFilter过滤器,但是没有到AccessPasswordFilter过滤器,因为AccessUserNameFilter过滤器的优先级高一些,会先执行,在执行的时候,发现过滤条件不符合,于是跳过了后面所有的过滤器,并返回结果
后台无sql打印,说明请求没有被路由
(3)请求为:http://localhost:8768/h3service/user/1?password=123456&username=chhliu
测试结果为:
{
"id": 1,
"username": "user1",
"name": "张三",
"age": 20,
"balance": 100.00
}
控制台打印的结果:
GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1
GET AccessPasswordFilter request to http://localhost:8768/h3service/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的生命周期,见下图
注:上图有个小错误,routing应该是route
5、拓展
zuul还提供了一类特殊的过滤器,分别为:StaticResponseFilter和SurgicalDebugFilter
StaticResponseFilter:StaticResponseFilter允许从Zuul本身生成响应,而不是将请求转发到源。
SurgicalDebugFilter:SurgicalDebugFilter允许将特定请求路由到分隔的调试集群或主机。
关于Filter怎么在spring cloud-zuul中使用就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。
名称栏目:Filter怎么在springcloud-zuul中使用
URL地址:http://scyanting.com/article/pooeoe.html