Springcloud+ZuulFilter微服务中过滤器的实现

偏执的太偏执、 2022-04-06 06:14 109阅读 0赞

### 1.简介: ###

Zuul作为网关的中一个重要功能，就是实现请求的鉴定权限。我们是通过Zuul提供的过滤器来实现的。

### 2.ZuulFilter: ###

ZuulFilter是过滤器的顶级父类。  
他定义了四个方法:

public abstract class ZuulFilter implements IZuulFilter{ 
        boolean shouldFilter();
        Object run() throws ZuulException;
        abstract public String filterType();
        abstract public int filterOrder();
    }

下面让我来一一详解:

> shouldFilter：是否执行该过滤器。true执行，false不执行。  
> run：过滤器的具体业务逻辑。  
> filterType：返回过滤器类型。  
> 一共有4种：  
> 1.pre：请求在被路由之前执行  
> 2.routing：在路由请求时调用  
> 3.post：在routing和errror过滤器之后调用  
> 4.error：调用错误  
> filterOrder：过滤器的执行顺序，数字越小优先级越高,且该值不可重复

### 3.过滤器执行生命周期 ###

*  正常流程：  
    请求经过pre类型过滤器，而后到达routing类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。
 *  异常流程：  
    a.如果pre或者routing过滤器出现异常，都会直接进入error过滤器，再error处理完毕后，会将请求交给POST过滤器，最后返回给用户。  
    b.–如果是error过滤器自己出现异常，最终也会进入POST过滤器，而后返回。  
    c.如果是POST过滤器出现异常，会跳转到error过滤器

### 4.过滤器执行生命周期 ###

*  请求鉴权：一般放在pre类型，如果发现没有访问权限，直接就拦截了
 *  异常处理：一般会在error类型和post类型过滤器中结合来处理。
 *  服务调用时长统计：pre和post结合使用。

### 5.做一个用户登录拦截的HelloWorld ###

1.首先有一个我们配置好的zuul网关环境[配置详情][Link 1]  
2.创建一个filter类,继承ZuulFilter ,实现方法

@Component
    public class UserFilter extends ZuulFilter { 
        @Override
        public String filterType() { 
            // 设置前置拦截
            return "pre";
        }
        @Override
        public int filterOrder() { 
        	// 设置执行顺序,从0开始
            return 1;
        }
        @Override
        public boolean shouldFilter() { 
        	// 是否执行这个方法,默认false
            return true;
        }
        @Override
        public Object run() throws ZuulException { 
        	// run 方法,到时候所有的操作判断在这里执行
            return null;
        }
    }

到这儿可以先运行测试一下,看程序是否通过该过滤器  
3.测试运行没问题后,我们编写核心代码,登录拦截

@Override
    public Object run() throws ZuulException { 
        // 登录校验
        // 1.获取Zuul提供的请求上下文对象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2.从上下文中获取request对象
        HttpServletRequest req = ctx.getRequest();
        // 3.从请求中获取token
        String token = req.getParameter("usertoken");
        // 4.判断
        if(token == null || "".equals(token.trim())){ 
            // 没有token，登录校验失败，拦截
            ctx.setSendZuulResponse(false);
            // 返回401状态码。
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校验通过，可以考虑把用户信息放入上下文，继续向后执行
        return null;
    }

运行访问得到的结果:  
1.如果没有携带usertoken参数,就会返回给用户一个401:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzQyMzM4OTYy_size_16_color_FFFFFF_t_70]  
2.携带了usertoken参数,就会放行.  
完成ZuulFilter入门案例!

[Link 1]: https://mp.csdn.net/mdeditor/84872446#
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzQyMzM4OTYy_size_16_color_FFFFFF_t_70]: /images/20220406/50a79e1a22d94a42a729c72035d598d5.png