Spring Cloud Gateway 是基于 Spring Framework 5.0 和 Spring Boot 2.0 构建的 API 网关,提供路由等功能。其旨在提供一种简单而有效的方法路由到 API,并为它们提供跨领域的关注点,例如:安全性、监视/指标和弹性。
特性:
Java 8
Spring Framework 5
Spring Boot 2
动态路由
Spring Handler Mapping 内置的路由匹配
HTTP 请求上的路由匹配(路径、方法、Header、主机等)
过滤器限定范围以匹配路由
过滤器可以修改下游 HTTP 请求和 HTTP 响应(添加/删除 Header、添加/删除参数、重写路径、设置路径等)
API 或配置驱动
支持 Spring Cloud DiscoveryClient 配置路由
前五章讲了如何服务注册与发现,远程调用,负载均衡,熔断,zuul网关,此文章就是把zuul网关改为spring cloud gateway
1、创建module
选择Spring Cloud Routing->Gateway
此项目不选择spring web 是应为spring cloud gateway是基于webflux的,如果非要web支持的话需要导入spring-boot-starter-webflux而不是spring-boot-start-web。
如果你选择了web依赖,会报错提示删除依赖which is incompatible with Spring Cloud Gateway at this time. Please removeXXXX
目录结构
pom.xml文件
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.springcloud</groupId>
<artifactId>spring-gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-gateway</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR6</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</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>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
修改启动项添加服务发现
package com.springcloud.eurekagateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@EnableDiscoveryClient
@SpringBootApplication
public class EurekaGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaGatewayApplication.class, args);
}
}
剩下的就可以配置动态路由了
spring.application.name=mygateway server.port=6799 ## 心跳时间,即服务续约间隔时间(缺省为30s) #eureka.instance.lease-renewal-interval-in-seconds= 5 ## 发呆时间,即服务续约到期时间(缺省为90s) #eureka.instance.lease-expiration-duration-in-seconds= 15 ## 开启健康检查(依赖spring-boot-starter-actuator) #eureka.client.healthcheck.enabled=true eureka.client.serviceUrl.defaultZone=http://localhost:3456/eureka/ spring.cloud.gateway.discovery.locator.enabled=true #是将请求路径上的服务名配置为小写(因为服务注册的时候,向注册中心注册时将服务名转成大写的了),比如以/service-hi/*的请求路径被路由转发到服务名为service-hi的服务上。 spring.cloud.gateway.discovery.locator.lower-case-service-id=true spring.cloud.gateway.routes[0].id=gateway-service spring.cloud.gateway.routes[0].uri=lb://eureka-client spring.cloud.gateway.routes[0].predicates[0]=Path=/api/** spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1
网关规则可参考
https://cloud.tencent.com/developer/article/1556949 StripPrefix=1表示去掉url中的前缀
此时配置代表如果我访问http://localhost:6799/api/hello
经过网关转后变成http://localhost:6799/eureka-client
/hello 其中eureka-client为你注册到eureka服务中心的服务名
同样实现了负载均衡
如果你用的不是eureka想要直接访问你的接口路径也可以把网关配置改为下面这种非lb形式
spring.cloud.gateway.discovery.locator.lower-case-service-id=true
spring.cloud.gateway.routes[0].id=gateway-service
spring.cloud.gateway.routes[0].uri=http://localhost:8081/hello
spring.cloud.gateway.routes[0].predicates[0]=Path=/api/**
spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1
如果把uri中端口号后面的/路径去了,我们访问api/ 后面的路径会自动拼接到uri后,如下
spring.cloud.gateway.discovery.locator.lower-case-service-id=true
spring.cloud.gateway.routes[0].id=gateway-service
spring.cloud.gateway.routes[0].uri=http://localhost:8081
spring.cloud.gateway.routes[0].predicates[0]=Path=/api/**
spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1