通过之前的学习,我们得知Zuul它包含了两个核心功能:对请求的路由和过滤。
- 其中路由功能负责将外部请求转发到具体的微服务实例上,是实现外部访问统一入口的基础;
- 而过滤器功能则负责对请求的处理过程进行干预,是实现请求校验、服务聚合等功能的基础。其实,路由功能在真正运行时,它的路由映射和请求转发同样也由几个不同的过滤器完成的。所以,过滤器可以说是Zuul实现API网关功能最为核心的部件,每一个进入Zuul的HTTP请求都会经过一系列的过滤器处理链得到请求响应并返回给客户端。
一,ZuulFilter 简介
Zuul
中的过滤器跟我们之前使用的
javax.servlet.Filter
不一样,
javax.servlet.Filter 只有一种类型,可以通过配置
urlPatterns
来拦截对应的请求。而
Zuul
中的过滤器总共有
4 种类型,且每种类型都有对应的使用场景。
- PRE:这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
- ROUTING:这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求,并使用Apache HttpClient或Netfifilx Ribbon请求微服务。
- POST:这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
- ERROR:在其他阶段发生错误时执行该过滤器。
Zuul提供了自定义过滤器的功能实现起来也十分简单,只需要编写一个类去实现zuul提供的接口
pre:转发到微服务之前执行的过滤器
routing:在路由请求时执行的过滤器
post:执行微服务获取返回值之后执行的过滤器
error:在整个阶段抛出异常的时候执行的过滤器
二,自定义过滤器
自定义zuul 过滤器只需要继承ZuulFilter 类
ZuulFilter
是过滤器的顶级父类。在这里我们看一下其中定义的
4
个最重要的方法
@Component
public class LoginFilter extends ZuulFilter{
@Override
public String filterType() {
// 登录校验,肯定是在前置拦截
return "pre";
}
@Override
public int filterOrder() {
// 顺序设置为1
return 1;
}
@Override
public boolean shouldFilter() {
// 返回true,代表过滤器生效。
return true;
}
@Override
public Object run() throws ZuulException {
//处理业务逻辑
return null;
}
}
- ZuulFilter是过滤器的顶级父类。在这里我们看一下其中定义的4个最重要的方法
- shouldFilter :返回一个 Boolean 值,判断该过滤器是否需要执行。返回true执行,返回false 不执行。
- run :过滤器的具体业务逻辑。
- filterType :返回字符串,代表过滤器的类型。包含以下4种:
pre :请求在被路由之前执行routing :在路由请求时调用post :在routing 和 errror 过滤器之后调用error :处理请求时发生错误调用
- filterOrder :通过返回的int值来定义过滤器的执行顺序,数字越小优先级越高。
三,生命周期
- 正常流程:
- 请求到达首先会经过pre类型过滤器,而后到达routing类型,进行路由,请求就到达真正的 服务提供者,执行请求,返回结果后,会到达post过滤器。而后返回响应。
- 异常流程:
- 整个过程中,pre或者routing过滤器出现异常,都会直接进入error过滤器,再error处理完毕 后,会将请求交给POST过滤器,最后返回给用户。
- 如果是error过滤器自己出现异常,最终也会进入POST过滤器,而后返回。
- 如果是POST过滤器出现异常,会跳转到error过滤器,但是与pre和routing不同的时,请求不会再到达POST过滤器了。
- 不同过滤器的场景:
- 请求鉴权:一般放在pre类型,如果发现没有访问权限,直接就拦截了
- 异常处理:一般会在error类型和post类型过滤器中结合来处理。
- 服务调用时长统计:pre和post结合使用。
所有内置过滤器列表: