SpringCloud快速通关(下)
一.Gateway
SpringCloudGateway有两种类型:
需求:
- 1.客户端发送/api/order/**转到service-order
- 2.客户端发送/api/product/**转到service-product
- 3.以上转发有负载均衡效果
2.1 创建网关
(1)创建模块: 由于网关不属于业务，它属于架构组件的一部分，所以我们new一个model，改名gateway。
(2)注入依赖: 因为我们在cloud-demo里面对springboot和springcloud做了基本的版本控制，所以在网关里面我们只需要引入相关依赖,还要注入注册中心的依赖:
<dependencies><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency></dependencies>(3) 启动项目，即为一个网关
@SpringBootApplication
public class GatewayApplication {public static void main(String[] args) {org.springframework.boot.SpringApplication.run(GatewayApplication.class, args);}
}每个项目都得依赖配置文件
spring:application:name:gatewaycloud:nacos:server-addr: 127.0.0.1:88482.2 路由
配置规则
当我想要把以/api/order/**为开头的请求发给service-order,把以/api/product/***为开头的请求发给service-product的时候，这个该如何实现呢?
springcloud提供了两种配置方法:
①在配置文件中进行配置
②使用编码的方式进行配置
接下来我们先测试第一种:
(1)在gateway的包中新建一个配置文件application-route.yml,然后想要其生效，须在application中进行配置
spring-cloud-gateway-routes: 路由规则表，可指定路由规则，其中包含
- id:给这个路由起个名字
- uri:接下来这个请求我们需要转到哪(写上微服务名)
- predicates:断言，接下来遵守哪种规则我就转，即什么时候转
- order:优先级顺序，数字越小，优先级越高
spring:cloud:gateway:routes:# id 全局唯一- id: order-route# 指定服务名称(lb即是load-balance的缩写，即负载均衡的发)uri: lb://service-order# 指定断言规则，即路由匹配规则predicates:- Path=/api/order/**order: 1但是此时在浏览器中输入是不能进行路由请求的，会显示503即代表服务不可用。因为我们未在gateway中引入负载均衡的依赖,接下来引用负载均衡依赖:
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-loadbalancer</artifactId></dependency>此时输入网址不报503的错误了，但是报了404
为什么会找不到路径呢，那是因为网关接收到/api/order/readDb之后，会老老实实的去OrderController中找有没有以/api/order/readDb为开头的，但是全是@GetMapping("/readDb"),所以我们需要在OrderController中加上@RequestMapping(""),注意feignclient也要改
@RestController
@RequestMapping("/api/order")
public class OrderController {}此时成功了
工作原理
2.3断言
长短写法
断言有两种写法:
①长写法
②短写法
spring:cloud:gateway:routes:# id 全局唯一- id: order-route# 指定服务名称uri: lb://service-order# 指定断言规则，即路由匹配规则# Fully Expanded Argumentspredicates:- name: Pathargs:patterns: /api/order/**matchTrailingSlash: true- id: product-routeuri: lb://service-product# Shortcut Configurationpredicates:- Path=/api/product/**在 Spring Cloud Gateway 的实现中，断言的实现都是 RoutePredicateFactory 接口的实现。
因此除了直接查看官方文档外确定有哪些断言形式外，还可以通过查看 RoutePredicateFactory 的实现：
HeaderRoutePredicateFactoryPathRoutePredicateFactoryReadBodyRoutePredicateFactoryBeforeRoutePredicateFactory...
断言的名称可以通过去掉实现类名后的 RoutePredicateFactory 来确定，比如 HeaderRoutePredicateFactory 对应名为 Header 的断言。
| 名称 | 参数（个数/类型） | 作用 |
|---|---|---|
| After | 1/datetime | 在指定时间之后 |
| Before | 1/datetime | 在指定时间之前 |
| Between | 2/datetime | 在指定时间区间内 |
| Cookie | 2/string,regexp | 包含 cookie 名且必须匹配指定值 |
| Header | 2/string,regexp | 包含请求头且必须匹配指定值 |
| Host | N/string | 请求 host 必须是指定枚举值 |
| Method | N/string | 请求方式必须是指定枚举值 |
| Path | 2/List<String>,bool | 请求路径满足规则，是否匹配最后的 / |
| Query | 2/string,regexp | 包含指定请求参数 |
| RemoteAddr | 1/List<String> | 请求来源于指定网络域（CIDR写法） |
| Weight | 2/string,int | 按指定权重负载均衡 |
| XForwardedRemoteAddr | 1/List<String> | 从 X-Forwarded-For 请求头中解析请求来源，并判断是否来源于指定网络域 |
自定义断言工厂
尽管 Gateway 内置了许多断言规则，但依旧难以满足千变万化的需求。
我想指定一个名为 Vip 的断言规则，要求存在名为 user 的请求参数，并且值为 mofan 时才将请求跳转到 https://cn.bing.com：
spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.compredicates:- name: Pathargs:patterns: /search- name: Queryargs:param: qregexp: haha- Vip=user,mofan自定义 AbstractRoutePredicateFactory 实现类 VipRoutePredicateFactory：
@Component
public class VipRoutePredicateFactory extends AbstractRoutePredicateFactory<VipRoutePredicateFactory.Config> {public VipRoutePredicateFactory() {super(Config.class);}@Overridepublic List<String> shortcutFieldOrder() {return List.of("param", "value");}@Overridepublic Predicate<ServerWebExchange> apply(Config config) {return (GatewayPredicate) serverWebExchange -> {// localhost/search?q=haha&user=mofanServerHttpRequest request = serverWebExchange.getRequest();String first = request.getQueryParams().getFirst(config.param);return StringUtils.hasText(first) && first.equals(config.value);};}@Validated@Getter@Setterpublic static class Config {@NotEmptyprivate String param;@NotEmptyprivate String value;}
}2.4 过滤器
先前在网关中配置了将 /api/order/ 开头的请求转到 service-order 服务，并要求在 service-order 服务中也存在 /api/order/ 开头的请求路径，比如 /api/order/readDb。如果该服务中原先并不存在 /api/order/ 开头的请求，比如只有 /readDb，那么在以 /api/order/readDb 进行访问就会出现 404 错误。
基本过滤器
为了解决这个问题，可以在 service-order 服务对应的 Controller 上添加 @RequestMapping("/api/order") 注解，但这并不是最佳方案，如果能直接在网关层面解决这个问题就好了，就像把 /api/order/readDb 重写为 /readDb。
Gateway 中内置了许多过滤器，其中有一个常用的过滤器名为：RewritePath，即路径重写。
修改网关的配置规则application-route.yml在其中加上过滤器:
spring:cloud:gateway:routes:# id 全局唯一- id: order-route# 指定服务名称uri: lb://service-order# 指定断言规则，即路由匹配规则# Fully Expanded Argumentspredicates:- name: Pathargs:patterns: /api/order/**matchTrailingSlash: truefilters:# 类似把 /api/order/a/bc 重写为 /a/bc，移除路径前的 /api/order/- RewritePath=/api/order/?(?<segment>.*), /$\{segment}order: 1- id: product-routeuri: lb://service-product# Shortcut Configurationpredicates:- Path=/api/product/**filters:- RewritePath=/api/product/?(?<segment>.*), /$\{segment}order: 2默认filter
如果需要为所有路由都添加同一个过滤器，则可以使用 默认过滤器，比如：
spring:cloud:gateway:default-filters:# 为所有路由添加响应头过滤器- AddResponseHeader=X-Response-Abc, 123全局过滤器
除了默认过滤器，全局过滤器也能为所有匹配的路由添加一个过滤器，全局过滤器的配置无需修改配置文件。
实现 GlobalFilter 接口，并将实现类交由 Spring 管理，即可实现全局过滤器。
还可以实现 Ordered 接口，调整多个全局过滤器的执行顺序。
//在gateway包中新建filter包，建立
@Slf4j
@Component
public class RtGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {ServerHttpRequest request = exchange.getRequest();String uri = request.getURI().toString();long start = System.currentTimeMillis();log.info("请求 [{}] 开始，时间：{}", uri, start);return chain.filter(exchange).doFinally(res -> {long end = System.currentTimeMillis();log.info("请求 [{}] 结束，时间：{}，耗时：{}ms", uri, start, end - start);});}@Overridepublic int getOrder() {return 0;}
}自定义过滤器工厂
尽管 Gateway 内置了许多过滤器，但仍有无法满足需求的情况，此时就需要自定义过滤器工厂。
与自定义断言类似，自定义过滤器工厂的类名也有限制，要求以 GatewayFilterFactory 结尾，而配置文件中配置的名称就是类名开头。
比如需要在配置文件中定义名为 OnceToken 的过滤器，那么需要新增 OnceTokenGatewayFilterFactory：
@Component
public class OnceTokenGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {@Overridepublic GatewayFilter apply(NameValueConfig config) {return (exchange, chain) -> chain.filter(exchange).then(Mono.fromRunnable(() -> {ServerHttpResponse response = exchange.getResponse();String value = switch (config.getValue().toLowerCase()) {case "uuid" -> UUID.randomUUID().toString();case "jwt" -> "Test Token";default -> "";};HttpHeaders headers = response.getHeaders();headers.add(config.getName(), value);}));}
}
spring:cloud:gateway:routes:- id: order-routeuri: lb://service-orderfilters:# 自定义过滤器- OnceToken=X-Response-Token, uuid全局跨域
如果需要配置跨域，可以在 Controller 的类上添加 @CrossOrigin 注解。
如果有许多 Controller，逐一添加注解太麻烦，可以在项目的配置类中添加 CorsFilter 类型的 Bean。
上述方法只适用于单体服务，那如果在微服务中呢？
借由 Gateway 的功能，可以在配置文件中轻松完成微服务的跨域配置：
spring:cloud:gateway:globalcors:cors-configurations:'[/**]':allowed-origin-patterns: '*'allowed-headers: '*'allowedMethods: '*'面试题:
微服务之间的调用经过网关吗？
答案:不经过，它们是直接去注册中心查找的
