Geteway
大家好我是苏麟今天带来Geteway.
Gateway服务网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统 一的 API 路由管理方式。
官网 : spring.io/projects/spring-cloud-gateway/
网关
Gateway网关是我们服务的守门神，所有微服务的统一入口。
网关的功能特性：
- 路由
- 负载均衡
- 统一鉴权
- 跨域
- 统一业务处理(缓存)
- 访问控制
- 发布控制
- 流量染色
- 接口保护:
- 限制请求
- 信息脱敏
- 降级
- 限流
- 超时时间
- 统一日志
- 统一文档
架构图:
网关分为两种:
1.全局网关(接入层网关):作用是负载均衡,请求日志等,不和业务逻辑绑定.
2.业务网关(微服务层网关):会有一定逻辑,作用是将请求转发到不同的业务/项目/接口/服务
Gateway快速入门
下面，我们就演示下网关的基本路由功能。基本步骤如下：
1. 创建SpringBoot工程gateway，引入网关依赖
2. 编写启动类
3. 编写基础配置和路由规则
4. 启动网关服务进行测试
1）创建gateway服务，引入依赖
创建服务:
引入依赖：
org.springframework.cloud
spring-cloud-starter-gateway
com.alibaba.cloud
spring-cloud-starter-alibaba-nacos-discovery
2）编写启动类
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
3）编写基础配置和路由规则
server:
port: 10010 # 网关 端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service
#uri: http://127.0.0.0.1:8848 #路由的目的地址 http 是固定地址
uri: lb://userservice # 路由的目的地址 lb是负载均衡,后面跟上服务名称
predicates: #路由断言 , 判断请求路由是否符合规则
- Path=/user/** # 以/user/开头的都符合规则
- id: orderserver
uri: lb://orderserver
predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
- Path=/order/** # 这个是按照路径匹配，只要以/user/开头就符合要求
我们将符合 Path 规则的一切请求，都代理到 uri 参数指定的地址。
本例中，我们将 /user/** 开头的请求，代理到 lb://userservice ，lb是负载均衡，根据服务名拉取 服务列表，实现负载均衡。
4）重启测试
重启网关，访问http://localhost:10010/user/1时，符合 /user/** 规则，请求转发到uri：http://users ervice/user/1，得到了结果：
5）网关路由的流程图
整个访问的流程如下：
总结：
网关搭建步骤：
1. 创建项目，引入nacos服务发现和gateway依赖
2. 配置application.yml，包括服务基本信息、nacos地址、路由
路由配置包括：
1. 路由id：路由的唯一标示
2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
3. 路由断言（predicates）：判断路由的规则
4. 路由过滤器（filters）：对请求或响应做处理
断言工厂
我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路 由判断的条件
例如Path=/user/**是按照路径匹配，这个规则是由 org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory 类来 处理的，像这样的断言工厂在SpringCloudGateway还有十几个:
演示一下After
server:
port: 10010 # 网关 端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service
#uri: http://127.0.0.0.1:8848 #路由的目的地址 http 是固定地址
uri: lb://userservice # 路由的目的地址 lb是负载均衡,后面跟上服务名称
predicates: #路由断言 , 判断请求路由是否符合规则
- Path=/user/** # 以/user/开头的都符合规则
- After=2099-01-20T17:42:47.789-07:00[Asia/Shanghai]
- id: orderserver
uri: lb://orderserver
predicates:
- Path=/order/**
更多断言工厂全在官网,想要了解更全面更仔细去官方网站,那里不仅有小Demo还有文字讲解.
我们只需要掌握Path这种路由工程就可以了。
过滤器工厂
GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：
路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂。例如：
请求头过滤器
下面我们以AddRequestHeader 为例来讲解。
需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!
server:
port: 10010 # 网关 端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service
#uri: http://127.0.0.0.1:8848 #路由的目的地址 http 是固定地址
uri: lb://userservice # 路由的目的地址 lb是负载均衡,后面跟上服务名称
predicates: # 路由断言 , 判断请求路由是否符合规则
- Path=/user/** # 以/user/开头的都符合规则
filters:
- AddRequestHeader=Truth, SL is very good! # 添加请求头
- id: orderserver
uri: lb://orderserver
predicates:
- Path=/order/**
当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。
在UserController 中获取请求头
@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {
/**
* 路径： /user/1
*
* @param id 用户id
* @return 用户
*/
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id,
@RequestHeader(value = "Truth",required = false) String truth) {
System.out.println(truth);
return userService.queryById(id);
}
}
访问
得到结果
默认过滤器
如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：
server:
port: 10010 # 网关 端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service
#uri: http://127.0.0.0.1:8848 #路由的目的地址 http 是固定地址
uri: lb://userservice # 路由的目的地址 lb是负载均衡,后面跟上服务名称
predicates: #路由断言 , 判断请求路由是否符合规则
- Path=/user/** # 以/user/开头的都符合规则
- id: orderserver
uri: lb://orderserver
predicates:
- Path=/order/**
default-filters: # 默认路由过滤器
- AddRequestHeader=Truth,SL is very good总结
过滤器的作用是什么？
① 对路由的请求或响应做加工处理，比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用是什么？
① 对所有路由都生效的过滤器
全局过滤器
路由过滤器，网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求， 做自己的业务逻辑则没办法实现。
全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于 GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口。
public interface GlobalFilter {
/**
* 处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
*
* @param exchange 请求上下文，里面可以获取Request、Response等信息
* @param chain 用来把请求委托给下一个过滤器
* @return {@code Mono} 返回标示当前过滤器业务结束
*/
Mono filter(ServerWebExchange exchange, GatewayFilterChain chain);
} 在filter中编写自定义逻辑，可以实现下列功能：
- 登录状态判断
- 权限校验
- 请求限流等
自定义全局过滤器
需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行，否则拦截
package cn.itcast.gateway;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/**
* @className: AuthorizeFilter
* @author: TianYuan ShowTime
* @date: 2023/6/16-14:41
**/
/**
* @Order(-1) 是让过滤器先后执行的
*/
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
ServerHttpRequest request = exchange.getRequest();
MultiValueMap queryParams = request.getQueryParams();
//2.获取参数中的 authorization 参数
String authorization = queryParams.getFirst("authorization");
//3.判断参数值是否等于admin
if ("admin".equals(authorization)) {
//4.是,放行
return chain.filter(exchange);
}
//5.否,拦截
//设置状态码 401 未登录
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
}
访问
加上参数访问
过滤器执行顺序
请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排 序后依次执行每个过滤器：
排序的规则是什么呢？
-
每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
-
GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
-
路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
-
当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
详细内容，可以查看源码：
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters() 方 法是先加载defaultFilters，然后再加载某个route的filters，然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle() 方法会加载全局 过滤器，与前面的过滤器合并后根据order排序，组织过滤器链
跨域问题
跨域：域名不一致就是跨域，主要包括：
- 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
- 域名相同，端口不同：localhost:8080和localhost8081
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题
解决方案：CORS 可以看:有些问题/跨域.md · sl/typore - 码云 - 开源中国 (gitee.com)
解决跨域问题
在gateway服务的application.yml文件中，添加下面的配置：
server:
port: 10010 # 网关 端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos 地址
gateway:
globalcors: #全局跨域处理
add-to-simple-url-handler-mapping: true #解决options请求拦截问题
cors-configurations:
'[/**]':
allowedOrigins: #允许那些网站的跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
allowedMethods:
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" #允许请求带的头信息
allowCredentials: true #是否允许带Cookie
maxAge: 360000 #这次跨域的有效期
这期就到这里下期见!