zuul filter

前言

过滤器是Zuul的核心组件，这篇文章我们来详细讨论Zuul的过滤器。下面话不多说，来看看详细的介绍吧。

过滤器类型与请求生命周期

Zuul大部分功能都是通过过滤器来实现的。Zuul中定义了四种标准过滤器类型，这些过滤器类型对应于请求的典型生命周期。

(1) PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

(2) ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。

(3) POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

(4) ERROR：在其他阶段发生错误时执行该过滤器。

除了默认的过滤器类型，Zuul还允许我们创建自定义的过滤器类型。例如，我们可以定制一种STATIC类型的过滤器，直接在Zuul中生成响应，而不将请求转发到后端的微服务。

通过Filter，我们可以实现安全控制，比如，只有请求参数中有用户名和密码的客户端才能访问服务端的资源。那么如何来实现Filter了？

要想实现Filter，需要以下几个步骤：

1、继承ZuulFilter类，为了验证Filter的特性，我们这里创建3个Filter

根据用户名来过滤

1. package com.chhliu.springcloud.zuul;
2. import javax.servlet.http.HttpServletRequest;
3. import com.netflix.zuul.ZuulFilter;
4. import com.netflix.zuul.context.RequestContext;
5. public class AccessUserNameFilter extends ZuulFilter {
6. @Override
7. public Object run() {
8. RequestContext ctx = RequestContext.getCurrentContext();
9. HttpServletRequest request = ctx.getRequest();
10. System.out.println(String.format("%s AccessUserNameFilter request to %s", request.getMethod(), request.getRequestURL().toString()));
11. String username = request.getParameter("username");// 获取请求的参数
12. if(null != username && username.equals("chhliu")) {// 如果请求的参数不为空，且值为chhliu时，则通过
13. ctx.setSendZuulResponse(true);// 对该请求进行路由
14. ctx.setResponseStatusCode(200);
15. ctx.set("isSuccess", true);// 设值，让下一个Filter看到上一个Filter的状态
16. return null;
17. }else{
18. ctx.setSendZuulResponse(false);// 过滤该请求，不对其进行路由
19. ctx.setResponseStatusCode(401);// 返回错误码
20. ctx.setResponseBody("{\"result\":\"username is not correct!\"}");// 返回错误内容
21. ctx.set("isSuccess", false);
22. return null;
23. }
24. }
25. @Override
26. public boolean shouldFilter() {
27. return true;// 是否执行该过滤器，此处为true，说明需要过滤
28. }
29. @Override
30. public int filterOrder() {
31. return 0;// 优先级为0，数字越大，优先级越低
32. }
33. @Override
34. public String filterType() {
35. return "pre";// 前置过滤器
36. }
37. }

通过继承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实现的，有兴趣的同学可以看下源码。

再建一个过滤器，根据密码来过滤：

1. package com.chhliu.springcloud.zuul;
2. import javax.servlet.http.HttpServletRequest;
3. import com.netflix.zuul.ZuulFilter;
4. import com.netflix.zuul.context.RequestContext;
5. public class AccessPasswordFilter extends ZuulFilter {
6. @Override
7. public Object run() {
8. RequestContext ctx = RequestContext.getCurrentContext();
9. HttpServletRequest request = ctx.getRequest();
10. System.out.println(String.format("%s AccessPasswordFilter request to %s", request.getMethod(), request.getRequestURL().toString()));
11. String username = request.getParameter("password");
12. if(null != username && username.equals("123456")) {
13. ctx.setSendZuulResponse(true);
14. ctx.setResponseStatusCode(200);
15. ctx.set("isSuccess", true);
16. return null;
17. }else{
18. ctx.setSendZuulResponse(false);
19. ctx.setResponseStatusCode(401);
20. ctx.setResponseBody("{\"result\":\"password is not correct!\"}");
21. ctx.set("isSuccess", false);
22. return null;
23. }
24. }
25. @Override
26. public boolean shouldFilter() {
27. RequestContext ctx = RequestContext.getCurrentContext();
28. return (boolean) ctx.get("isSuccess");// 如果前一个过滤器的结果为true，则说明上一个过滤器成功了，需要进入当前的过滤，如果前一个过滤器的结果为false，则说明上一个过滤器没有成功，则无需进行下面的过滤动作了，直接跳过后面的所有过滤器并返回结果
29. }
30. @Override
31. public int filterOrder() {
32. return 1; // 优先级设置为1
33. }
34. @Override
35. public String filterType() {
36. return "pre";
37. }
38. }

最后建一个post过滤器

1. package com.chhliu.springcloud.zuul;
2. import javax.servlet.http.HttpServletRequest;
3. import com.netflix.zuul.ZuulFilter;
4. import com.netflix.zuul.context.RequestContext;
5. public class AccessTokenFilter extends ZuulFilter {
6. @Override
7. public Object run() {
8. RequestContext ctx = RequestContext.getCurrentContext();
9. HttpServletRequest request = ctx.getRequest();
10. System.out.println(String.format("%s AccessTokenFilter request to %s", request.getMethod(),
11. request.getRequestURL().toString()));
12. ctx.setSendZuulResponse(true);
13. ctx.setResponseStatusCode(200);
14. ctx.setResponseBody("{\"name\":\"chhliu\"}");// 输出最终结果
15. return null;
16. }
17. @Override
18. public boolean shouldFilter() {
19. return true;
20. }
21. @Override
22. public int filterOrder() {
23. return 0;
24. }
25. @Override
26. public String filterType() {
27. return "post";// 在请求被处理之后，会进入该过滤器
28. }
29. }

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

1. @Bean
2. public AccessUserNameFilter accessUserNameFilter() {
3. return new AccessUserNameFilter();
4. }
5. @Bean
6. public AccessPasswordFilter accessPasswordFilter(){
7. return new AccessPasswordFilter();
8. }

3、输入请求，验证

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

测试结果为：

{"result":"password is not correct!"}

控制台打印结果

1. GET AccessUserNameFilter request to http://localhost:8768/h2service/user/1
2. 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!"}

控制台打印结果：

1. 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

测试结果为：

1. {
2. "id": 1,
3. "username": "user1",
4. "name": "张三",
5. "age": 20,
6. "balance": 100.00
7. }

控制台打印的结果：

1. GET AccessUserNameFilter request to http://localhost:8768/h2service/user/1
2. GET AccessPasswordFilter request to http://localhost:8768/h2service/user/1

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

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

1. 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允许将特定请求路由到分隔的调试集群或主机。