SpringCloud系列之API⽹关（Gateway）服务Zuul
1、什么是API⽹关
API⽹关是所有请求的⼊⼝，承载了所有的流量，API Gateway是⼀个门户⼀样，也可以说是进⼊系统的唯⼀节点。这跟⾯向对象设计模式中的Facet模式很像。API Gateway封装内部系统的架构，并且提供API给各个客户端。它还可能有其他功能，如授权、监控、负载均衡、缓存、请求分⽚和管理、静态响应处理等
API Gateway负责请求转发、合成和协议转换。所有来⾃客户端的请求都要先经过API Gateway，然后路由这些请求到对应的微服务。API Gateway将经常通过调⽤多个微服务来处理⼀个请求以及聚合多个服务的结果。它可以在web协议与内部使⽤的⾮Web友好型协议间进⾏转换，如 HTTP协议、WebSocket协议。
画图表⽰，没有⽹关的情况，客户端的请求会直接落到后端的各个服务中，⽆法集中统⼀管理。
画图表⽰，有⽹关的情况，所有的请求都先经过⽹关，然后进⾏分发到对应服务
2、API⽹关的重要性
API⽹关在微服务项⽬中是很重要的，⽹关提供⼀个统⼀的管理，服务间的调度变得有序
购物车服务：购物车中的物品数量
订单服务：订单历史记录
⽬录服务：基本产品信息，例如其名称，图像和价格
审核服务：客户审核
库存服务：库存不⾜警告
运送服务：运送选项，期限和费⽤与运送提供商的API分开提取
推荐服务：建议项⽬
在不使⽤⽹关的情况，客户端直接调⽤各服务：
理想情况，各服务调⽤是可以正常使⽤的，但是随着业务拓展，服务之间的调⽤越来越复杂，到时候系统就会变成如图：
如果没有⼀个统⼀的管理，肯定是不合理的，所以可以引⼊⽹关，作为⼀个统⼀的门户，如图：
3、API Gateway的作⽤
ok，简单介绍⽹关之后，要说说⽹关的作⽤，在Spring cloud官⽹也有过归纳：
当然，我们可以⾃⼰挑⼏个重要的介绍
动态路由
⽹关可以做路由转发，假如服务信息变了，只要改⽹关配置既可，所以说⽹关有动态路由(Dynamic Routing)的作⽤，如图：
请求监控
请求监控可以对整个系统的请求进⾏监控，详细地记录请求响应⽇志，如图，可以将⽇志丢到消息队列，如果没有使⽤⽹关的话，记录请求信息需要在各个服务中去做
认证鉴权
认证鉴权可以对每⼀个访问请求做认证，拒绝⾮法请求，保护后端的服务，不需要每个服务都做鉴权，在项⽬中经常有加上
OAuth2.0、JWT，Spring Security进⾏权限校验
压⼒测试
有⽹关的系统，如果要要对某个服务进⾏压⼒测试，可以如图所⽰，改下⽹关配置既可，测试请求路由到测试服务，测试服务会有单独的测试数据库，这样测试的请求就不会影响到正式的服务和数据库
4、什么是Netflix Zuul？
Netflix Zuul是Netflix公司的产品，是⼀款API⽹关中间件。Zuul是⼀个基于 JVM 路由和服务端的负载均衡器。提供了路由、监控、弹性、安全等服务。Zuul 能够与 Eureka、Ribbon、Hystrix 等组件配合使⽤，提供统⼀的API⽹关处理
5、Netflix Zuul⼯作原理
参考，Zuul的核⼼如图其实就是过滤器，zuul基于Servlet实现。当⼀个请求进来时，会先进⼊ pre 过滤器，在 pre 过滤器执⾏完后，接着就到了 routing 过滤器中，开始路由到具体的服务中，错误的情况会被错误过滤器拦截
过滤器类型：
前置过滤器(PRE FILTER)：在路由过滤器之前执⾏。功能可以包括请求⾝份验证，选择原始服务器以及记录调试信息。
路由过滤器(ROUTE FILTER)：处理将请求路由到源的过程。这是使⽤Apache HttpClient或Netflix Ribbon构建和发送原始HTTP 请求的地⽅。
后置过滤器(POST FILTER)：在将请求路由过滤器之后执⾏。功能可以包括向响应中添加标准HTTP标头，收集统计信息和指标以及将响应从源流传输到客户端。
错误过滤器(ERR FILTER)：在其他阶段之⼀发⽣错误时就会调⽤到错误过滤器
6、Zuul实验环境准备
环境准备：
JDK 1.8
SpringBoot2.2.3
SpringCloud(Hoxton.SR6)
Maven 3.2+
开发⼯具
IntelliJ IDEA
smartGit
创建⼀个SpringBoot Initialize项⽬，详情可以参考我之前博客：
maven配置：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
本博客的是基于spring-cloud-starter-netflix-eureka-client进⾏试验，试验前要运⾏eureka服务端，eureka服务提供者，代码请参考
项⽬创建成功后，先在启动类加上@EnableZuulProxy：
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloudflix.zuul.EnableZuulProxy;
@SpringBootApplication
@EnableZuulProxy
public class SpringcloudZuulApplication {
public static void main(String[] args) {
SpringApplication.run(SpringcloudZuulApplication.class, args);
}
}
7、eureka、zuul配置
eureka客户端配置：
server:
port: 8082
# 指定application name，这个是微服务注册的serviceId
spring:
application:
name: zuul-api-gateway
eureka:
client:
# 服务注册中⼼url
service-url:
defaultZone: localhost:8761/eureka/
# ⽹关服务注册、发现都开放，所以 register-with-eureka、fetch-registry都是true
register-with-eureka: true
fetch-registry: true
instance:
status-page-url-path: localhost:8761/actuator/info
health-check-url-path: localhost:8761/actuator/health
prefer-ip-address: true
instance-id: zuul-api-gateway8082
Zuul 配置路由规则：
zuul:
routes:
provider: # 路由标识，可以⾃⼰定义
service-id: eureka-service-provider # 服务id(必须配置)
path: /provider/** # 映射的路径，⼀般和routes.provider⼀致
url: localhost:8083 # 路由到的url，可以不配置
zuul:
# 配置前缀
prefix: /api-gateway
Zuul配置Header过滤：
zuul:
# 配置过滤敏感的请求头信息，设置为空就不会过滤
sensitive-headers: Cookie,Set-Cookie,Authorization
Zuul配置重定向添加Host：
zuul:
# 重定向会添加host请求头
add-proxy-headers: true
Zuul超时设置：
zuul:
host:
# 配置连接超时时间
connect-timeout-millis: 15000
# socker发送超时时间
socket-timeout-millis: 60000
zuul所有配置参考，详情参考：
zuul:
# 配置前缀
prefix: /api-gateway
routes:
provider: # 路由标识，可以⾃⼰定义
service-id: eureka-service-provider # 服务id
path: /provider/** # 映射的路径，⼀般和routes.provider⼀致
url: localhost:8083 # 路由到的url
host:
# 配置连接超时时间
connect-timeout-millis: 15000
# socker发送超时时间
socket-timeout-millis: 60000
# 请求url编码
decode-url: true
# 查询字符串编码
force-original-query-string-encoding: false
# 配置过滤敏感的请求头信息，设置为空就不会过滤
sensitive-headers: Cookie,Set-Cookie,Authorization
# 重定向会添加host请求头
add-proxy-headers: true
可能遇到的错误，504错误：
经过排查，需要加上超时设置，因为调⽤服务超时，导致504错误
zuul:
host:
微服务网关和注册中心区别connect-timeout-millis: 15000
socket-timeout-millis: 60000
加上配置，调⽤服务成功
8、Zuul⾃定义过滤器
在前⾯的介绍中，已经介绍了⼏种过滤器，现在⾃定义实现这四种过滤器项⽬结构：
过滤器类型参考org.springframework.cloudflix.zuul.filters.supportFilterConstants.java：实现⼀个前置过滤器：拦截请求，必须带token过来，不然抛出提⽰信息等等
ample.springcloud.zuul.web.filter;
import comflix.zuul.ZuulFilter;
import t.RequestContext;
import ption.ZuulException;
slf4j.Slf4j;
import org.apache.http.HttpHeaders;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import javax.servlet.http.HttpServletRequest;
import static org.springframework.cloudflix.zuul.filters.support.FilterConstants.FORWARD_TO_KEY; import static org.springframework.cloudflix.zuul.filters.support.FilterConstants.PRE_TYPE;
import static org.springframework.cloudflix.zuul.filters.support.FilterConstants.SERVICE_ID_KEY;
/**
* <pre>
* API⽹关预过滤器
* </pre>
*
* <pre>
* @author mazq
* 修改记录
* 修改后版本: 修改⼈：修改⽇期: 2020/08/05 18:08 修改内容:
* </pre>
*/
@Slf4j
//@Component
public class ZuulApiGatewayPreFilter extends ZuulFilter {
@Override
public String filterType() {
return PRE_TYPE;
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() throws ZuulException {
RequestContext ctx = CurrentContext();
HttpServletRequest request = Request();
String accessToken = Parameter("token");
if (StringUtils.isEmpty(accessToken)) {
// zuul过滤该请求，不进⾏路由
ctx.setSendZuulResponse(false);
// 设置返回的错误码
ctx.setResponseStatusCode(403);
ctx.setResponseBody("AccessToken is Invalid ");
return null;
}
log.info("accessToken: {}",accessToken);
// 否则业务继续执⾏
return null;
}
}
ample.springcloud.zuul.web.filter;
lemon.io.CharStreams;
import comflix.zuul.ZuulFilter;
import t.RequestContext;
import ption.ZuulException;
slf4j.Slf4j;
import org.apache.http.protocol.RequestContent;
import org.springframework.stereotype.Component;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import static org.springframework.cloudflix.zuul.filters.support.FilterConstants.POST_TYPE;
import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
/**
* <pre>
* API Gateway后置过滤器
* </pre>
*
* <pre>
* @author mazq
* 修改记录
* 修改后版本: 修改⼈：修改⽇期: 2020/08/06 10:05 修改内容:
* </pre>
*/
@Slf4j
//@Component
public class ZuulApiGatewayPostFilter extends ZuulFilter {
@Override
public String filterType() {
return POST_TYPE;
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() throws ZuulException {
RequestContext context = CurrentContext();
try (final InputStream responseDataStream = ResponseDataStream()) {
if(responseDataStream == null) {
log.warn("RESPONSE BODY: {}", "");
return null;
}
String responseData = String(new InputStreamReader(responseDataStream, "UTF-8")); log.info("RESPONSE BODY: {}", responseData);
context.setResponseBody(responseData);
}
catch (Exception e) {
throw new ZuulException(e, INTERNAL_SERVER_ERROR.value(), e.getMessage());
}
return null;
}
}
注册过滤器，将过滤器加载到Spring容器，也可以在过滤器类加上@Component
ample.springcloud.zuul;
ample.springcloud.zuul.web.filter.ZuulApiGatewayErrFilter;
ample.springcloud.zuul.web.filter.ZuulApiGatewayPostFilter;
ample.springcloud.zuul.web.filter.ZuulApiGatewayPreFilter;
ample.springcloud.zuul.web.filter.ZuulApiGatewayRouteFilter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloudflix.zuul.EnableZuulProxy;
import t.annotation.Bean;
@SpringBootApplication
@EnableZuulProxy
public class SpringcloudZuulApplication {
public static void main(String[] args) {
SpringApplication.run(SpringcloudZuulApplication.class, args);
}
@Bean
public ZuulApiGatewayPreFilter zuulApiGatewayPreFilter(){
return new ZuulApiGatewayPreFilter();
}
@Bean
public ZuulApiGatewayPostFilter zuulApiGatewayPostFilter(){
return new ZuulApiGatewayPostFilter();
}
@Bean
public ZuulApiGatewayRouteFilter zuulApiGatewayRouteFilter(){
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论