如何快速入门Gateway网关,配置断言工厂、过滤器工厂及全局过滤器以解决跨域问题?
- 内容介绍
- 文章标签
- 相关推荐
本文共计1863个文字,预计阅读时间需要8分钟。
(目录)Gateway服务网关 + Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,基于 Spring 5.0、Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,旨在为微服务架构提供一种简单、有效的方式来路由到不同的服务。
(目录)
Gateway服务网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
1.为什么需要网关
Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
架构图:
在SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul 是基于 Servlet 实现,属于阻塞式编程。而 Spring Cloud Gateway 则是基于 Spring5 中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
2.gateway快速入门
演示下网关的基本路由功能。基本步骤如下:
1)创建gateway服务,引入依赖
创建服务:
引入依赖:
<!--网关--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <!--nacos服务发现依赖--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency>2)编写启动类
package cn.itcast.gateway; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); } }3)编写基础配置和路由规则
创建application.yml文件,内容如下:
server: port: 10010 # 网关端口 spring: application: name: gateway # 服务名称 cloud: nacos: server-addr: localhost:8848 # nacos地址 gateway: routes: # 网关路由配置 - id: user-service # 路由id,自定义,只要唯一即可 # uri: 127.0.0.1:8081 # 路由的目标地址 userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
我们将 /user/**开头的请求,代理到lb://userservice
lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4)重启测试
重启网关,访问localhost:10010/user/1时,符合/user/**规则
请求转发到uri:userservice/user/1
得到了结果: 访问网关地址,网关转发请求到代理位置
5)网关路由的流程图
总结:
网关搭建步骤:
创建项目,引入nacos服务发现和gateway依赖
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
路由id:路由的唯一标示
路由目标(uri):路由的目标地址,userservice predicates: - Path=/user/** filters: # 过滤器 - AddRequestHeader=Truth, freaking awesome! # 添加请求头
如何验证,我们修改 userservice 中的一个接口
@GetMapping("/{id}") public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false) String truth) { System.out.println("truth:" + truth); return userService.queryById(id); }效果:
当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。
4.3.默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下
格式如下:
spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** default-filters: # 默认过滤项 - AddRequestHeader= Truth, freaking awesome!4.4.总结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用是什么?
① 对所有路由都生效的过滤器
5.全局过滤器
网关提供了31种,但每一种过滤器的作用都是固定的。
如果我们希望拦截请求,做自己的业务逻辑则没办法实现。
5.1.全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于 :
GatewayFilter 通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己实现
实现GlobalFilter接口
public interface GlobalFilter { /** * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 * * @param exchange 请求上下文,里面可以获取Request、Response等信息 * @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono<Void>} 返回标示当前过滤器业务结束 */ Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain); }在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
5.2.自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
-
参数中是否有authorization,
-
authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
在gateway中定义一个过滤器:
package cn.itcast.gateway.filters; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.annotation.Order; import org.springframework.www.ruanyifeng.com/blog/2016/04/cors.html解决跨域问题
在 Gateway 网关中解决跨域问题还是比较方便的。
在gateway服务的application.yml文件中,添加下面的配置:
spring: cloud: gateway: # .... globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 - "localhost:8090" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" # 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带cookie maxAge: 360000 # 这次跨域检测的有效期本文共计1863个文字,预计阅读时间需要8分钟。
(目录)Gateway服务网关 + Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,基于 Spring 5.0、Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,旨在为微服务架构提供一种简单、有效的方式来路由到不同的服务。
(目录)
Gateway服务网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
1.为什么需要网关
Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
架构图:
在SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul 是基于 Servlet 实现,属于阻塞式编程。而 Spring Cloud Gateway 则是基于 Spring5 中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
2.gateway快速入门
演示下网关的基本路由功能。基本步骤如下:
1)创建gateway服务,引入依赖
创建服务:
引入依赖:
<!--网关--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <!--nacos服务发现依赖--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency>2)编写启动类
package cn.itcast.gateway; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); } }3)编写基础配置和路由规则
创建application.yml文件,内容如下:
server: port: 10010 # 网关端口 spring: application: name: gateway # 服务名称 cloud: nacos: server-addr: localhost:8848 # nacos地址 gateway: routes: # 网关路由配置 - id: user-service # 路由id,自定义,只要唯一即可 # uri: 127.0.0.1:8081 # 路由的目标地址 userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
我们将 /user/**开头的请求,代理到lb://userservice
lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4)重启测试
重启网关,访问localhost:10010/user/1时,符合/user/**规则
请求转发到uri:userservice/user/1
得到了结果: 访问网关地址,网关转发请求到代理位置
5)网关路由的流程图
总结:
网关搭建步骤:
创建项目,引入nacos服务发现和gateway依赖
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
路由id:路由的唯一标示
路由目标(uri):路由的目标地址,userservice predicates: - Path=/user/** filters: # 过滤器 - AddRequestHeader=Truth, freaking awesome! # 添加请求头
如何验证,我们修改 userservice 中的一个接口
@GetMapping("/{id}") public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false) String truth) { System.out.println("truth:" + truth); return userService.queryById(id); }效果:
当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。
4.3.默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下
格式如下:
spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** default-filters: # 默认过滤项 - AddRequestHeader= Truth, freaking awesome!4.4.总结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用是什么?
① 对所有路由都生效的过滤器
5.全局过滤器
网关提供了31种,但每一种过滤器的作用都是固定的。
如果我们希望拦截请求,做自己的业务逻辑则没办法实现。
5.1.全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于 :
GatewayFilter 通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己实现
实现GlobalFilter接口
public interface GlobalFilter { /** * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 * * @param exchange 请求上下文,里面可以获取Request、Response等信息 * @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono<Void>} 返回标示当前过滤器业务结束 */ Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain); }在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
5.2.自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
-
参数中是否有authorization,
-
authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
在gateway中定义一个过滤器:
package cn.itcast.gateway.filters; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.annotation.Order; import org.springframework.www.ruanyifeng.com/blog/2016/04/cors.html解决跨域问题
在 Gateway 网关中解决跨域问题还是比较方便的。
在gateway服务的application.yml文件中,添加下面的配置:
spring: cloud: gateway: # .... globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 - "localhost:8090" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" # 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带cookie maxAge: 360000 # 这次跨域检测的有效期
