Spring Cloud Alibaba-Spring Cloud Gateway-API 网关-使用路由网关统一访问接口

快来打我* 2024-03-30 12:37 27阅读 0赞

### 什么是 Spring Cloud Gateway ###

Spring Cloud Gateway 是 Spring 官方基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，Spring Cloud Gateway 旨在为微服务架构提供一种简单而有效的统一的 API 路由管理方式。**Spring Cloud Gateway 作为 Spring Cloud 生态系中的网关，目标是替代 Netflix ZUUL**，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控/埋点，和限流等。

![7f94f4c96bb2605dcb2daba1938a3db6.jpeg][]

### Spring Cloud Gateway 功能特征 ###

*  基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0
 *  动态路由
 *  Predicates 和 Filters 作用于特定路由
 *  集成 Hystrix 断路器
 *  集成 Spring Cloud DiscoveryClient
 *  易于编写的 Predicates 和 Filters
 *  限流
 *  路径重写

### Spring Cloud Gateway 工程流程 ###

![96a5320a87ede99d238c80c077517dee.jpeg][]

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前（`pre`）或之后（`post`）执行业务逻辑。

### POM ###

> 1.  `<?xml version="1.0" encoding="UTF-8"?>`
> 2.  `<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`
> 3.  `xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">`
> 4.  `<modelVersion>4.0.0</modelVersion>`
> 5.  
> 6.  `<parent>`
> 7.  `<groupId>cn.dandelioncloud</groupId>`
> 8.  `<artifactId>hello-spring-cloud-alibaba-dependencies</artifactId>`
> 9.  `<version>1.0.0-SNAPSHOT</version>`
> 10. `<relativePath>../hello-spring-cloud-alibaba-dependencies/pom.xml</relativePath>`
> 11. `</parent>`
> 12. 
> 13. `<artifactId>hello-spring-cloud-gateway</artifactId>`
> 14. `<packaging>jar</packaging>`
> 15. 
> 16. `<name>hello-spring-cloud-gateway</name>`
> 17. `<url>http://www.dandelioncloud.cn</url>`
> 18. `<inceptionYear>2018-Now</inceptionYear>`
> 19. 
> 20. `<dependencies>`
> 21. ``
> 22. `<dependency>`
> 23. `<groupId>org.springframework.boot</groupId>`
> 24. `<artifactId>spring-boot-starter-actuator</artifactId>`
> 25. `</dependency>`
> 26. `<dependency>`
> 27. `<groupId>org.springframework.boot</groupId>`
> 28. `<artifactId>spring-boot-starter-test</artifactId>`
> 29. `<scope>test</scope>`
> 30. `</dependency>`
> 31. ``
> 32. 
> 33. ``
> 34. `<dependency>`
> 35. `<groupId>org.springframework.cloud</groupId>`
> 36. `<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>`
> 37. `</dependency>`
> 38. `<dependency>`
> 39. `<groupId>org.springframework.cloud</groupId>`
> 40. `<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>`
> 41. `</dependency>`
> 42. `<dependency>`
> 43. `<groupId>org.springframework.cloud</groupId>`
> 44. `<artifactId>spring-cloud-starter-openfeign</artifactId>`
> 45. `</dependency>`
> 46. `<dependency>`
> 47. `<groupId>org.springframework.cloud</groupId>`
> 48. `<artifactId>spring-cloud-starter-gateway</artifactId>`
> 49. `</dependency>`
> 50. ``
> 51. 
> 52. ``
> 53. `<dependency>`
> 54. `<groupId>javax.servlet</groupId>`
> 55. `<artifactId>javax.servlet-api</artifactId>`
> 56. `</dependency>`
> 57. ``
> 58. `</dependencies>`
> 59. 
> 60. `<build>`
> 61. `<plugins>`
> 62. `<plugin>`
> 63. `<groupId>org.springframework.boot</groupId>`
> 64. `<artifactId>spring-boot-maven-plugin</artifactId>`
> 65. `<configuration>`
> 66. `<mainClass>cn.dandelioncloud.hello.spring.cloud.gateway.GatewayApplication</mainClass>`
> 67. `</configuration>`
> 68. `</plugin>`
> 69. `</plugins>`
> 70. `</build>`
> 71. `</project>`

主要增加了 `org.springframework.cloud:spring-cloud-starter-gateway` 依赖

#### 特别注意 ####

*  Spring Cloud Gateway 不使用 Web 作为服务器，而是 **使用 WebFlux 作为服务器**，Gateway 项目已经依赖了 `starter-webflux`，所以这里 **千万不要依赖 `starter-web`**
 *  由于过滤器等功能依然需要 Servlet 支持，故这里还需要依赖 `javax.servlet:javax.servlet-api`

### Application ###

> 1.  `package cn.dandelioncloud.hello.spring.cloud.gateway;`
> 2.  
> 3.  `import org.springframework.boot.SpringApplication;`
> 4.  `import org.springframework.boot.autoconfigure.SpringBootApplication;`
> 5.  `import org.springframework.cloud.client.discovery.EnableDiscoveryClient;`
> 6.  `import org.springframework.cloud.openfeign.EnableFeignClients;`
> 7.  
> 8.  `@SpringBootApplication`
> 9.  `@EnableDiscoveryClient`
> 10. `@EnableFeignClients`
> 11. `public class GatewayApplication {`
> 12. `public static void main(String[] args) {`
> 13. `SpringApplication.run(GatewayApplication.class, args);`
> 14. `}`
> 15. `}`

### application.yml ###

> 1.  `spring:`
> 2.  `application:`
> 3.  `# 应用名称`
> 4.  `name: spring-gateway`
> 5.  `cloud:`
> 6.  `# 使用 Naoos 作为服务注册发现`
> 7.  `nacos:`
> 8.  `discovery:`
> 9.  `server-addr: 127.0.0.1:8848`
> 10. `# 使用 Sentinel 作为熔断器`
> 11. `sentinel:`
> 12. `transport:`
> 13. `port: 8721`
> 14. `dashboard: localhost:8080`
> 15. `# 路由网关配置`
> 16. `gateway:`
> 17. `# 设置与服务注册发现组件结合，这样可以采用服务名的路由策略`
> 18. `discovery:`
> 19. `locator:`
> 20. `enabled: true`
> 21. `# 配置路由规则`
> 22. `routes:`
> 23. `# 采用自定义路由 ID（有固定用法，不同的 id 有不同的功能，详见：https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html#gateway-route-filters）`
> 24. `- id: NACOS-CONSUMER`
> 25. `# 采用 LoadBalanceClient 方式请求，以 lb:// 开头，后面的是注册在 Nacos 上的服务名`
> 26. `uri: lb://nacos-consumer`
> 27. `# Predicate 翻译过来是“谓词”的意思，必须，主要作用是匹配用户的请求，有很多种用法`
> 28. `predicates:`
> 29. `# Method 方法谓词，这里是匹配 GET 和 POST 请求`
> 30. `- Method=GET,POST`
> 31. `- id: NACOS-CONSUMER-FEIGN`
> 32. `uri: lb://nacos-consumer-feign`
> 33. `predicates:`
> 34. `- Method=GET,POST`
> 35. 
> 36. `server:`
> 37. `port: 9000`
> 38. 
> 39. `# 目前无效`
> 40. `feign:`
> 41. `sentinel:`
> 42. `enabled: true`
> 43. 
> 44. `# 目前无效`
> 45. `management:`
> 46. `endpoints:`
> 47. `web:`
> 48. `exposure:`
> 49. `include: "*"`
> 50. 
> 51. `# 配置日志级别，方别调试`
> 52. `logging:`
> 53. `level:`
> 54. `org.springframework.cloud.gateway: debug`

**注意：请仔细阅读注释**

### 测试访问 ###

依次运行 Nacos 服务、`NacosProviderApplication`、`NacosConsumerApplication`、`NacosConsumerFeignApplication`、`GatewayApplication`

打开浏览器访问：`http://localhost:9000/nacos-consumer/echo/app/name` 浏览器显示

> 1.  `Hello Nacos Discovery nacos-consumer i am from port 8082`

打开浏览器访问：`http://localhost:9000/nacos-consumer-feign/echo/hi` 浏览器显示

> 1.  `Hello Nacos Discovery Hi Feign i am from port 8082`

**注意：请求方式是** `http://路由网关IP:路由网关Port/服务名/**`

至此说明 Spring Cloud Gateway 的路由功能配置成功

[7f94f4c96bb2605dcb2daba1938a3db6.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/9b81621c5b3b448cbaf45d60fa12c264.jpeg
[96a5320a87ede99d238c80c077517dee.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/43be5a3921584b4c96932d5cecef101b.jpeg