微服务架构 基础(四)
持续更新…
服务网关
什么是SpringCloud Gateway?
SpringCloud Gateway是Spring Cloud的一个全新项目,基于Spring 5+SpringBoot 2 和Project Reactor等技术开发网关,它旨在为微服务架构提供一种简单的有效的统一的API路由管理方式。
SpringCloud Gateway作为Spring Cloud生态系统中的网关,使用的WebFlux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架,其目标是替代Zuul。
Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链方式提供了网关基本功能,比如:反向代理,安全认证,路由转发,日志监控/指标,以及限流熔断。
为什么需要服务网关?
请看下图,通俗地说,就是如果没有服务网关,那么对于公司许多不允许公开的内部业务API就是直接"暴露"的,任何人都能访问…
因此,需要添加一层服务网关进行过滤认证才能授权访问…
大致架构
Spring Cloud Gateway 基本特性
- 基于Spring Framework 5,Project Reactor和Spring Boot 2.0。
- 集成Hystrix断路器。
- 支持Predicates(断言)和Filters(过滤)作用于特定路由,易于编写的Predicates和Filters。
- 具备一些网关的高级功能:动态路由、限流、路径重写。
- 集成了Spring Cloud服务发现功能
Spring Cloud Gateway的三大核心概念
Route 路由
路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤组成,当请求到达网关时,由 Gateway Handler Mapping 通过断言进行路由匹配(Mapping),当断言为真时,匹配到路由。
Predicate 断言
Predicate 是 Java 8 中提供的一个函数。输入类型是 Spring Framework ServerWebExchange。它允许开发人员匹配来自 HTTP 的请求,例如请求头或者请求参数,如果请求和断言相匹配则进行路由。简单来说它就是匹配条件。
Filter 过滤
Filter 是 Gateway 中的过滤器(GatewayFilter实例),可以在请求发出前后进行一些业务上的处理。
如下:
官方图示
核心逻辑就是路由转发+执行过滤链
入门配置
基本框架搭建过程简单,首先新建子模块(gateway-service-10001):
引入依赖(以下依赖切记不要引入SpringWeb的依赖):
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.wu</groupId>
<artifactId>gateway-service-10001</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>gateway-service-10001</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring-boot.version>2.3.7.RELEASE</spring-boot.version>
<spring-cloud.version>Hoxton.SR9</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.3.7.RELEASE</version>
<configuration>
<mainClass>cn.wu.gatewayservice10001.GatewayService10001Application</mainClass>
</configuration>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
创建主启动类:
package cn.wu;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class GateWayApplication10001 {
public static void main(String[] args) {
SpringApplication.run(GateWayApplication10001.class, args);
}
}
创建application.yml:
server:
port: 10001
spring:
application:
name: gateway-10001
cloud:
gateway:
routes:
- id: micro-service-routh-1 # 路由的ID,没有固定的规则但要求唯一
uri: http://localhost:8001 # 匹配提供后的路由地址
predicates:
- Path=/book/id/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true # 将自己注册
fetch-registry: true # 获取注册信息,需要检索服务
service-url:
# 集群版本的服务端口地址,直接填写所有的服务端地址即可
defaultZone: http://eureka7001.cn:7001/eureka,http://eureka7002.cn:7002/eureka
首先启动两个Eureka服务端(端口分别为7001以及7002),再启动端口为8001的服务提供者,测试结果如下:
直接访问服务提供者
访问网关
动态路由
简单地说,就是通过微服务名称实现动态路由
首先修改网关子模块(gateway-service-10001) application.yml:
server:
port: 10001
spring:
application:
name: gateway-10001
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: micro-service-routh-1 # 路由的ID,没有固定的规则但要求唯一
#uri : http://localhost:8001 # 匹配提供后的路由地址
uri: lb://micro-service-1 # 负载均衡的微服务应用名称 LB为LoadBalancer的缩写
predicates:
- Path=/book/id/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true # 将自己注册
fetch-registry: true # 获取注册信息,需要检索服务
service-url:
# 集群版本的服务端口地址,直接填写所有的服务端地址即可
defaultZone: http://eureka7001.cn:7001/eureka,http://eureka7002.cn:7002/eureka
首先启动两台Eureka服务器(端口分别为7001和7002),然后启动两个业务完全一致的服务提供者(端口号分别为8001和9001),再启动网关服务(端口为10001),测试结果为:
以下简单地实现了轮询策略的负载均衡
时间计划
响应位置修改application.yml
routes:
- id: micro-service-routh-1 # 路由的ID,没有固定的规则但要求唯一
#uri : http://localhost:8001 # 匹配提供后的路由地址
uri: lb://micro-service-1 # 负载均衡的微服务应用名称 LB为LoadBalancer的缩写
predicates:
- After=2021-11-08T19:37:43.586+08:00[Asia/Shanghai] # 该时间点之后开启该路由
- Path=/book/id/**
在该时间开启之前访问URL会失败,如下:
若当前时间大于配置时间,则可以访问成功:
- Before亦类似上述用法
- Between
如: Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]- Cookie
需要两个参数,一个是Cookie Name ,一个是正则表达式,路由规则会去匹配以上的规则,如果匹配成功执行路由,没有匹配则不执行。如下示例:
修改配置信息:
predicates:
- After=2021-11-08T19:37:43.586+08:00[Asia/Shanghai]
- Path=/book/id/**
- Cookie=Message,HelloWorld # 匹配cookie name为Message,而值为HelloWorld正则规则的的Cookie
利用本地局域网的Ubuntu主机测试结果:
- Header
使用方式类似Cookie,同样的需要两个参数,一个是Header Name ,一个是正则表达式,路由规则会去匹配以上的规则,如果匹配成功执行路由,没有匹配则不执行。- Get
请求方式匹配- …
Filter使用
单一请求过滤filters配置
spring:
cloud:
gateway:
routes:
- id: add_request_parameter_route
uri: https://example.org
predicates:
filters:
- AddRequestParameter=HelloWorld # 会直接在请求参数中加入HelloWorld
所有请求过滤filters配置
spring:
cloud:
gateway:
default-filters: # 全局过滤配置
- AddRequestHeader=message,Hello World!
自定义过滤器
在服务提供者(8001和9001端口)控制层添加一个测试URL:
@GetMapping("/test")
public String test(){
return "测试URL";
}
修改服务网关的application.yml:
routes:
- id: micro-service-routh-1 # 路由的ID,没有固定的规则但要求唯一
#uri : http://localhost:8001 # 匹配提供后的路由地址
uri: lb://micro-service-1 # 负载均衡的微服务应用名称 LB为LoadBalancer的缩写
predicates:
- After=2021-11-08T19:37:43.586+08:00[Asia/Shanghai]
- Path=/book/id/**
# - Cookie=Message,HelloWorld # 匹配cookie name为Message,而值为HelloWorld正则规则的的Cookie
- id: micro-service-routh-2
uri: lb://micro-service-1
predicates:
- Path=/test
添加自定义全局过滤器:
package cn.wu.filter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class MyGateWayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("我已经进入该区域");
String userName = exchange.getRequest().getQueryParams().getFirst("message");
if(userName == null){
System.out.println("消息内容为空!");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
结果(只有当URL中含有参数信息message不为空的时候才能访问成功):
跨域问题解决
大致配置参数如下: