网关
在微服务架构中,一个系统会被拆分为很多个微服务,那么作为客户端要如何去调用 这么多的微服务呢?如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别去调用。
这样的架构,会存在着诸多的问题:
客户端多次请求不同的微服务,增加客户端代码或配置编写的复杂性。
认证复杂,每个服务都需要独立认证。
存在跨域请求,在一定场景下处理相对复杂。
API 网关,就是指系统的统一入口,它封装了应用程序的内部结构,为客 户端提供统一服务,一些与业务本身功能无关的公共逻辑可以在这里实现,诸如认证、鉴权、监控、路由转发等等。
常见的网关
Nginx+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用 lua 是一种脚本语言,可以来编写一些简单的逻辑, nginx 支持 lua 脚本。
Kong
基于 Nginx+Lua 开发,性能高,稳定,有多个可用的插件(限流、鉴权等等) 可以开箱即用。 问题: 只支持 Http 协议;二次开发,自由扩展困难;提供管 理 API,缺乏更易用的管控、配置方式。
Zuul
Netflix 开源的网关,功能丰富,使用 JAVA 开发,易于二次开发 问题:缺乏管控,无法动态配 置;依赖组件较多;处理 Http 请求依赖的是 Web 容器, 性能不如 Nginx。
Spring Cloud Gateway
Spring Cloud Gateway 是 Spring 官方推出的 API 网关组件,基于 Spring 5、Project Reactor 和 Spring Boot 2 构建,采用异步非阻塞模型,专为微服务架构设计,支持动态路由、限流熔断、安全控制等核心功能。
Gateway
这里我就不在赘述了。
优/缺点:
性能优越,功能强大,内置多种实用功能
缺点是不能部署在tomcat,Jetty等Servlet容器中,只能打包执行,且需要Springboot2.0yishang版本支持。
微服务集成Gateway
1.创建网关模块(与创建服务板块一致)
2.导入依赖,并且要剔除web相关依赖
<!--gateway 网关-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
这里通过设置作用域的方式变相剔除,有更好的方法还望不吝赐教哦。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
<scope>test</scope>
</dependency>
3.创建启动类
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
4.添加配置文件
server:
port: 9000 #指定端口
spring:
application:
name: api-gateway #服务名
cloud:
gateway:
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: order_route # 当前路由的标识, 要求唯一
uri: http://localhost:8071 # 请求要转发到的地址
order: 1 # 路由的优先级,数字越小级别越高
predicates: # 断言(就是路由转发要满足的条件)
- Path=/order-serv/** # 当请求路径满足Path指定的规则时才进行路由转发
filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 # 转发之前去掉 1 层路径
5.测试
启动项目, 并通过网关去访问微服务
地址:http://127.0.0.1:9000/order-serv/order/message
Gateway结合Nacos
之前我们在配置文件中写死了转发路径,现在我们通过Nacos从注册中心获取地址
1.加入Nacos依赖
<!--nacos 服务发现依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
2.在启动类添加注解标签
@EnableDiscoveryClient
3.修改配置
server:
port: 9000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: order_route # 当前路由的标识, 要求唯一
uri: lb://service-order # 请求要转发到的地址
order: 1 # 路由的优先级,数字越小级别越高
predicates: # 断言(就是路由转发要满足的条件)
- Path=/order-serv/** # 当请求路径满足Path指定的规则时, 才进行路由转发
filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 # 转发之前去掉 1 层路径
- id: product_route # 当前路由的标识, 要求唯一
uri: lb://service-product # 请求要转发到的地址
order: 1 # 路由的优先级,数字越小级别越高
predicates: # 断言(就是路由转发要满足的条件)
- Path=/product-serv/** # 当请求路径满足Path指定的规则时, 才进行路由转发
filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 # 转发之前去掉 1 层路径
- id: user_route # 当前路由的标识, 要求唯一
uri: lb://service-user # 请求要转发到的地址
order: 1 # 路由的优先级,数字越小级别越高
predicates: # 断言(就是路由转发要满足的条件)
- Path=/user-serv/** # 当请求路径满足Path指定的规则时, 才进行路由转发
filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 # 转发之前去掉 1 层路径
4.访问测试
启动项目, 并通过网关去访问微服务
地址:http://127.0.0.1:9000/order-serv/order/message
这里可能有人就会有疑问?说你这好像没有一点变化啊!
是的,访问地址是没有任何变化,那哪里变了呢?这就是开头提到的为什么要结合Nacos,原因就在这,就是通过配置动态获取服务地址,当我们修改了服务端口ip时,我们不需要来回改动网关这部分的代码,因为他只需要提供服务名就会动态的去寻找地址,省去了我们维护代码的成本。
全局过滤器
全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一 校验,安全性验证等功能.
内置全局过滤器
自定义全局过滤器
内置的过滤器已经可以完成大部分的功能,但是对于企业开发的一些业务功 能处理,还是需要我们自己编写过滤器来实现的,那么我们一起通过代码的形式 自定义一个过滤器,去完成统一的权限校验。 开发中的鉴权逻辑:
1.当客户端第一次请求服务时,服务端对用户进行信息认证(登录)
2.认证通过,将用户信息进行加密形成 token,返回给客户端,作为登录凭证
3.以后每次请求,客户端都携带认证的 token
4.服务端对 token 进行解密,判断是否有效
@Component
public class TokenFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//获取请求中的参数部分
String token = exchange.getRequest().getQueryParams().getFirst("token");
if (!"123456".equals(token)) {//模拟验证 token
System.out.println("鉴权失败");
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();//响应状态码
}
//调用 chain.filter 继续向下游执行
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
测试
启动项目, 并通过网关去访问微服务
地址:http://127.0.0.1:9000/order-serv/order/message?token=1
token验证失败时,不会转发路由
网关限流
采用Sentinel 组件来实现网关的限流。Sentinel 支持对 SpringCloud Gateway、Zuul 等主流网关进行限流。
从 1.6.0 版本开始,Sentinel 提供了 SpringCloud Gateway 的适配模块,可以 提供两种资源维度的限流: route 维度:即在 Spring 配置文件中配置的路由条 目,资源名为对应的 routeId 自定义 API 维度:用户可以利用 Sentinel 提供的API 来自定义一些 API 分组.
1.导入依赖
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
</dependency>
2.编写配置类
@Configuration
public class GatewayConfiguration {
private final List<ViewResolver> viewResolvers;
private final ServerCodecConfigurer serverCodecConfigurer;
public GatewayConfiguration(ObjectProvider<List<ViewResolver>>
viewResolversProvider, ServerCodecConfigurer serverCodecConfigurer) {
this.viewResolvers =
viewResolversProvider.getIfAvailable(Collections::emptyList);
this.serverCodecConfigurer = serverCodecConfigurer;
}
// 初始化一个限流的过滤器
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public GlobalFilter sentinelGatewayFilter() {
return new SentinelGatewayFilter();
}
// 配置初始化的限流参数
@PostConstruct
public void initGatewayRules() {
Set<GatewayFlowRule> rules = new HashSet<>();
rules.add(
new GatewayFlowRule("order_route") //资源名称,对应路由 id
.setCount(2) // 限流阈值
.setIntervalSec(1) // 统计时间窗口,单位是秒,默认是 1 秒
);
GatewayRuleManager.loadRules(rules);
}
// 配置限流的异常处理器
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public SentinelGatewayBlockExceptionHandler
sentinelGatewayBlockExceptionHandler() {
return new SentinelGatewayBlockExceptionHandler(viewResolvers,
serverCodecConfigurer);
}
// 自定义限流异常页面
@PostConstruct
public void initBlockHandlers() {
BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
public Mono<ServerResponse> handleRequest(ServerWebExchange
serverWebExchange, Throwable throwable) {
Map map = new HashMap<>();
map.put("code", 0);
map.put("message", "接口被限流了");
return ServerResponse.status(HttpStatus.OK).
contentType(MediaType.APPLICATION_JSON_UTF8).
body(BodyInserters.fromObject(map));
}
};
GatewayCallbackManager.setBlockHandler(blockRequestHandler);
}
}
3.测试访问
启动项目, 以每秒3次以上速率访问
地址:http://127.0.0.1:9000/order-serv/order/message?token=123456
通过网关成功达到限流目的。