Spring Cloud Zuul:API网关服务
前言
Spring Cloud Zuul 是Spring Cloud Netflix 子项目的核心组件之一,可以作为微服务架构中的API网关使用,支持动态路由与过滤功能。API网关为微服务架构中的服务提供了统一的访问入口,客户端通过API网关访问相关服务。API网关的定义类似于设计模式中的门面模式,它相当于整个微服务架构中的门面,所有客户端的访问都通过它来进行路由及过滤。它实现了请求路由、负载均衡、校验过滤、服务容错、服务聚合等功能。
提示:以下是本篇文章正文内容,下面案例可供参考
一、微服务架构
在正常情况下我们会看到接触客户端的第一层就是我们的网关,网关为微服务架构中的服务提供了统一的访问入口,客户端通过API网关访问相关服务。
我们来开启一下网关:
1.添加依赖,配置
<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>
server:
port: 8801
spring:
application:
name: zuul-proxy
eureka:
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://localhost:8001/eureka/
2.在启动类上添加@EnableZuulProxy注解来启用Zuul的API网关功能
@EnableZuulProxy
@EnableDiscoveryClient
@SpringBootApplication
public class ZuulProxyApplication {
public static void main(String[] args) {
SpringApplication.run(ZuulProxyApplication.class, args);
}
}
二、功能
1.路由功能
配置路由功能,我们可以通过修改application.yml中的配置来配置路由规则,这里我们将匹配/userService/**的请求路由到user-service服务上去,匹配/feignService/**的请求路由到feign-service上去。
zuul:
routes: #给服务配置路由
user-service:
path: /userService/**
feign-service:
path: /feignService/**
访问http://localhost:8801/userService/user/1可以发现请求路由到了user-service上了;
访问http://localhost:8801/feignService/user/1可以发现请求路由到了feign-service上了。
然后我们查看路由信息:我们可以通过SpringBoot Actuator来查看Zuul中的路由信息。
添加依赖和配置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
management:
endpoints:
web:
exposure:
include: 'routes'
通过访问http://localhost:8801/actuator/routes查看简单路由信息
通过访问http://localhost:8801/actuator/routes/details查看详细路由信息
2.过滤功能
过滤功能负责对请求过程进行额外的处理,是请求校验过滤及服务聚合的基础。我们有以下几种过滤功能:
- pre:在请求被路由到目标服务前执行,比如权限校验、打印日志等功能;
- routing:在请求被路由到目标服务时执行,这是使用Apache HttpClient或Netflix Ribbon构建和发送原始HTTP请求的地方;
- post:在请求被路由到目标服务后执行,比如给目标服务的响应添加头信息,收集统计数据等功能;
- error:请求在其他阶段发生错误时执行
我们看一下过滤流程:
我们自定义过滤器,创建PreLogFilter类继承ZuulFilter,用于在请求路由到目标服务前打印请求日志。
@Component
public class PreLogFilter extends ZuulFilter {
private Logger LOGGER = LoggerFactory.getLogger(this.getClass());
/**
* 过滤器类型,有pre、routing、post、error四种。
*/
@Override
public String filterType() {
return "pre";
}
/**
* 过滤器执行顺序,数值越小优先级越高。
*/
@Override
public int filterOrder() {
return 1;
}
/**
* 是否进行过滤,返回true会执行过滤。
*/
@Override
public boolean shouldFilter() {
return true;
}
/**
* 自定义的过滤器逻辑,当shouldFilter()返回true时会执行。
*/
@Override
public Object run() throws ZuulException {
RequestContext requestContext = RequestContext.getCurrentContext();
HttpServletRequest request = requestContext.getRequest();
String host = request.getRemoteHost();
String method = request.getMethod();
String uri = request.getRequestURI();
LOGGER.info("Remote host:{},method:{},uri:{}", host, method, uri);
return null;
}
}
添加过滤器后,我们访问http://localhost:8801/user-service/user/1进行测试,会打印日志,日志里面显示存在过滤器,而且会出现下面的内容,表示shouldFilter()方法执行,而且执行结构为true。
我们再来看一下核心过滤器:
这个不需要我们一个个去掌握,我们只需要了解即可,正常情况下,我们可能需要自己去定义过滤器。
我们如果不想使用过滤器,我们就可以禁用过滤器,设置如下:
zuul:
filterClassName:
filter:
disable: true
结合一个例子我们看一下:
zuul:
ServletDetectionFilter:
pre:
disable: true
总结
在这里,我们用到了如下模块eureka-server 是eureka注册中心, user-service是 提供User对象CRUD接口的服,feign-service是 feign服务调用测试服务,zuul-proxy是zuul作为网关的测试服务。我们刚刚,还有之前的都已经了解到相应的程序。