Springcloud 微服务实战笔记 Zuul
优点
- 解决路由规则与服务实例维护问题。
- 对于类似签名校验、登录校验在微服务架构中的冗余问题。
入门使用
构建网关
-
pom.xml引入 spring-cloud-starter-netflix-zuul
org.springframework.cloud spring-cloud-starter-netflix-zuul -
应用主类增加@EnableZuulProxy注解
-
增加配置信息，主要是路由规则信息
由于zuul已实现与eureka无缝整合，配置路由规则时候无需配置具体的URL，而是映射到具体的服务即可。比如： /api1/** 对应的就是请求SPRING-CLOUD-STUDY-DEMO服务
通过指定Eureka Server服务注册中心的位置，除了将自己注册成服务之外，还可以让Zuul能够获取微服务实力清单，以实现path映射服务，再从服务中挑选实例来进行请求转发的完整路由机制。
server: port: 7777 spring: application: name: spring-cloud-study-zuul zuul: #需要忽略的头部信息，不在传播到其他服务 sensitive-headers: Access-Control-Allow-Origin ignored-headers: Access-Control-Allow-Origin,H-APP-Id,Token,APPToken routes: apis1: path: /api1/** #serviceId: spring-cloud-study-demo serviceId: SPRING-CLOUD-STUDY-DEMO apis2: path: /api2/** url: http://127.0.0.1:9999/ apis3: path: /api23/** url: https://www.baidu.com/
请求过滤
Zuul允许开发者在API网关上通过自定义过滤器来实现对请求的拦截与过滤，实现的方式很简单，只需要继承ZuulFilter抽象类并实现抽象方法即可。比如：
@Component
public class WebSocketFilter extends ZuulFilter {
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
RequestContext context = RequestContext.getCurrentContext();
HttpServletRequest request = context.getRequest();
String upgradeHeader = request.getHeader("Upgrade");
if (null == upgradeHeader) {
upgradeHeader = request.getHeader("upgrade");
}
if (null != upgradeHeader && "websocket".equalsIgnoreCase(upgradeHeader)) {
context.addZuulRequestHeader("connection", "Upgrade");
}
return null;
}
}
package com.didispace.filter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.http.HttpServletRequest;
/**
* 校验请求中是否包含accessToken参数，如果没有包含则返回401
*/
public class AccessFilter extends ZuulFilter {
private static Logger log = LoggerFactory.getLogger(AccessFilter.class);
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
log.info("send {} request to {}", request.getMethod(), request.getRequestURL().toString());
Object accessToken = request.getParameter("accessToken");
if(accessToken == null) {
log.warn("access token is empty");
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
return null;
}
log.info("access token ok");
return null;
}
}
●filterType：过滤器的类型，它决定过滤器在请求的哪个生命周期中执行。这里定义为pre，代表会在请求被路由之前执行。 ●filterOrder：过滤器的执行顺序。当请求在一个阶段中存在多个过滤器时，需要根据该方法返回的值来依次执行。 ●shouldFilter：判断该过滤器是否需要被执行。这里我们直接返回了 true，因此该过滤器对所有请求都会生效。实际运用中我们可以利用该函数来指定过滤器的有效范围。 ● run ： 过 滤 器 的 具 体 逻 辑 。 这 里 我 们 通 过ctx.setSendZuulResponse（false）令 zuul 过滤该请求，不对其进行路由，然后通过 ctx.setResponseStatusCode（401）设置了其返回的错误码 ， 当 然 也 可 以 进 一 步优 化 我 们 的 返 回 ， 比 如 ， 通 过ctx.setResponseBody（body）对返回的body内容进行编辑等。
总结
●它作为系统的统一入口，屏蔽了系统内部各个微服务的细节。 ●它可以与服务治理框架结合，实现自动化的服务实例维护以及负载均衡的路由转发。 ●它可以实现接口权限校验与微服务业务逻辑的解耦。 ●通过服务网关中的过滤器，在各生命周期中去校验请求的内容，将原本在对外服务层做的校验前移，保证了微服务的无状态性，同时降低了微服务的测试难度，让服务本身更集中关注业务逻辑的处理。
进阶使用
路由详解
- 传统路由配置：直接path对应到具体的地址，多个地址则使用逗号分隔开
- 服务路由配置：path对应服务名即可，由于zuul整合了eureka，zuul可获取服务实例的地址清单，然后通过负载均衡策略，可在清单中选择一个具体的实例进行转发就能完成路由工作。
- 服务路由默认规则：zuul已经自动实现了zuul.routes.=/serviceId/** 路由规则配置，当然由于某些服务可能需要禁止可使用zuul.ignored-services=来排除服务
自定义路由映射规则
实现很简单，只需要在API网关工程中，增加Bean，比如：
@Bean
public PatternServiceRouteMapper serviceRouteMapper(){
return new PatternServiceRouteMapper(
"(? ^.+)-(? v.+$)",
"${version}/${name}");
}
通过上述代码就实现将userservice-v1和userservice-v2路径，修改为/v1/userservice/ 和 /v2/userservice/ 这样带有版本号前缀的路径。
忽略表达式
比如，以快速入门中的示例为基础，如果不希望/hello 接口被路由，那么我们可以这样设置：
zuul.ignored-patterns=/**/hello/**
路由前缀
为了方便全局地为路由规则增加前缀信息，Zuul提供了zuul.prefix 参数来进行设置，比如，希望为网关上的路由规则都增加/api前缀，那么我们可以在配置文件中增加配置：
zuul.prefix=/api
Cookie与头信息
默认情况下，Spring Cloud Zuul在请求路由时，会过滤掉HTTP请求头信息中的一些敏感信息，防止它们被传递到下游的外部服务器。默认的敏感头信息通过zuul.sensitiveHeaders参数定义，包括Cookie、SetCookie、Authorization三个属性。所以，我们在开发Web项目时常用的Cookie在Spring Cloud Zuul网关中默认是不会传递的，这就会引发一个常见的问题：如果我们要将使用了 Spring Security、Shiro等安全框架构建的Web应用通过Spring Cloud Zuul构建的网关来进行路由时，由于Cookie信息无法传递，我们的Web应用将无法实现登录和鉴权。怎么解决？
- 方式一：对指定路由开启自定义敏感头
zuul.routes..customSensitiveHeaders=true - 方式二：将指定路由的敏感头设置为空
zuul.routes..sensitiveHeaders=
比较推荐使用这两种方法，仅对指定的Web应用开启对敏感信息的传递，影响范围小，不至于引起其他服务的信息泄露问题。
过滤器详解
过滤器
功能：请求的路由和过滤
路由：将外部请求转发到具体的微服务实例上，实现外部访问统一入口的基础。
过滤：负责对请求的处理过程进行干预，实现请求校验、服务聚合等功能的基础。
过滤器必须包含4个基本特征：过滤类型、执行顺序、执行条件、具体操作。对应4个抽象方法：
String filterType(); // 过滤器的类型
int filterOrder(); // 过滤器的执行顺序
boolean shouldFilter(); // 判断该过滤器是否要执行
Object run(); // 过滤器的具体逻辑
过滤器类型：
■pre：可以在请求被路由之前调用。 ■routing：在路由请求时被调用。 ■post：在routing和error过滤器之后被调用。 ■error：处理请求时发生错误时被调用。
请求生命周期
主要过程：
- pre，主要进行请求路由之前做一些前置加工，比如请求的校验等。
- routing，路由请求转发阶段，将外部请求转发到具体服务实例上去的过程。
- post，此时可以获取到请求信息，也可以获取到实例返回信息，在此阶段可进行一些加工或者转换等操作。
- error，此阶段只有在上述阶段中发生异常时候才会触发，最终流向哈市post，将最终结果返回给客户端。
核心过滤器
Spring cloud zuul默认实现了一批核心过滤器，主要如下图：
过滤器执行过程
com.netflix.zuul.http.ZuulServlet 实现如下：
@Override
public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws ServletException, IOException {
try {
init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);
// Marks this request as having passed through the "Zuul engine", as opposed to servlets
// explicitly bound in web.xml, for which requests will not have the same data attached
RequestContext context = RequestContext.getCurrentContext();
context.setZuulEngineRan();
try {
preRoute();
} catch (ZuulException e) {
error(e);
postRoute();
return;
}
try {
route();
} catch (ZuulException e) {
error(e);
postRoute();
return;
}
try {
postRoute();
} catch (ZuulException e) {
error(e);
return;
}
} catch (Throwable e) {
error(new ZuulException(e, 500, "UNHANDLED_EXCEPTION_" + e.getClass().getName()));
} finally {
RequestContext.getCurrentContext().unset();
}
}
通过配置禁用过滤器
zuul...disable=true
代表过滤器的类名 比如：ErrorFilter
代表过滤器类型，比如：error。
参考资料：
《Spring Cloud微服务实战》