二、Gateway的项目搭建与配置
Gateway核心的流程就是:路由转发与执行过滤器链。
Gateway的项目搭建与配置
工作流程
下图提供了 Spring Cloud Gateway 如何工作的高级概述:
核心概念:
客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配,则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前(pre)和之后(post)运行逻辑。执行所有pre过滤器逻辑。然后发出代理请求。发出代理请求后,将运行“post”过滤器逻辑。
注意:在没有端口的路由中定义的uri对于HTTP和HTTPS uri分别获得默认端口值80和443。
过滤器作用:
- Filter在pre类型的过滤器可以做参数效验、权限效验、流量监控、日志输出、协议转换等。
- Filter在post类型的过滤器可以做响应内容、响应头的修改、日志输出、流量监控等
- 这两种类型的过滤器有着非常重要的作用
核心点
-
Route(路由)
路由是构建网关的基础模块,它由ID,目标URI,包括一些列的断言和过滤器组成,如果断言为true则匹配该路由
-
Predicate(断言)
参考的是Java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),请求与断言匹配则进行路由
-
Filter(过滤)
指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
三个核心点连起来:
当用户发出请求到达Gateway,Gateway会通过一些匹配条件,定位到真正的服务节点,并在这个转发过程前后,进行一些及细化控制。其中Predicate就是我们匹配的条件,而Filter可以理解为一个拦截器,有了这两个点,再加上目标URI,就可以实现一个具体的路由了。
总结
Gateway核心的流程就是:路由转发与执行过滤器链
Gateway配置路由的两种方式
(1)通过YML配置
项目搭建
注意:该项目需配合Nacos一起使用
- 新建一个Maven项目:spring-cloud-gateway,java版本选择8
- 删除项目的src目录, 并新建两个Module,分别为cloud-alibaba-gateway-9999和springcloudalibaba-nacos-9001
-
导入对应依赖,因为Gateway属于SpringCloud的,所以一定要注意版本关系:
版本对应地址:https://spring.io/projects/spring-cloud
父级项目spring-cloud-gateway的pom文件:
<?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.12.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.example</groupId> <artifactId>spring-cloud-gateway</artifactId> <version>0.0.1-SNAPSHOT</version> <name>spring-cloud-gateway</name> <packaging>pom</packaging> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <spring-cloud-version>Hoxton.SR12</spring-cloud-version> <spring-cloud-alibaba-version>2.2.8.RELEASE</spring-cloud-alibaba-version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </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> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-alibaba-dependencies</artifactId> <version>${spring-cloud-alibaba-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> <modules> <module>cloud-alibaba-gateway-9999</module> <module>springcloudalibaba-nacos-9001</module> <module>demo-9002</module> </modules> </project>
子级项目spring-cloud-gateway:
pom文件:
注意:引入Gateway一定要删除spring-boot-starter-web依赖,否则会有冲突无法启动
<?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>com.example</groupId>
<artifactId>spring-cloud-gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<!-- <relativePath/> <!– lookup parent from repository –>-->
</parent>
<groupId>com.example</groupId>
<artifactId>cloud-alibaba-gateway-9999</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>cloud-alibaba-gateway-9999</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<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>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
由于此项目也是配合Nacos使用,所以启动器要加上@EnableDiscoveryClient注解:
application.yml:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: http://localhost:9001/nacos-provider # 匹配提供服务的路由地址
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
注意:gateway.discovery.locator.enabled = true 是开启自动路由功能,根据服务名称自动创建routes,因为我们后面有配置routes,所以可以不要(不要的话默认为false)。routes中的uri其实最后是不需要服务名称的,这个位置其实只需要指定的localhost:9001即可
所以这个位置我们可以把当前的配置优化为以下配置,它是一样可以启动的(项目中为了更直观,还是采用了上面的配置):
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway: #(去掉了gateway.discovery.locator.enabled配置)
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: http://localhost:9001 # 匹配提供服务的路由地址(去掉了/nacos-provider)
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
子级项目springcloudalibaba-nacos-9001:
pom文件:
<?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>com.example</groupId>
<artifactId>spring-cloud-gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<!-- <relativePath/> <!– lookup parent from repository –>-->
</parent>
<groupId>com.son</groupId>
<artifactId>springcloudalibaba-nacos-9001</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springcloudalibaba-nacos-9001</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
</dependencies>
</project>
由于此项目也是配合Nacos使用,所以启动器要加上@EnableDiscoveryClient注解:
application.yml:
server:
port: 9001
spring:
application:
name: nacos-provider
cloud:
nacos:
discovery:
server-addr: localhost:8848
management:
endpoint:
web:
exposure:
include: '*'
DemoController.java:
package com.son.springcloudalibabanacos9001.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/demo") //添加路由路径
public class DemoController {
@Value("${server.port}")
private String serverPort;
@GetMapping(value = "/hello")
public String getServerPort(){
return "Hello! port: "+ serverPort;
}
}
测试
- 启动Nacos(Windows环境)
本地Nacos启动命令(standalone代表着单机模式运行,非集群模式):
startup.cmd -m standalone
- 启动9999网关和springcloudalibaba-nacos-9001服务,同时查看Nacos控制台,发现Nacos控制台成功注册Gateway网关
- 启动完成之后,访问接口:http://localhost:9999/demo/hello ,此时接口访问成功
(2)通过代码的方式进行配置
通过配置类进行配置,通过@Bean注入一个RouteLocator:
package com.example.cloudalibabagateway9999.config;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
// 构建多个路由routes
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
// 具体路由地址
routes.route("path_demo",r -> r.path("/demo/**").uri("http://localhost:9001/nacos-provider")).build();
// 返回所有路由规则
return routes.build();
}
}
yml文件routes配置屏蔽,并将gateway.discovery.locator.enabled设置为false
我们在9001的DemoController中添加一个测试方法
@GetMapping(value = "/code")
public String codeTest(){
return "代码配置类网关配置测试";
}
启动9999网关和springcloudalibaba-nacos-9001服务,启动完成之后,访问接口:http://localhost:9999/demo/code ,此时接口就可以转发到9001中具体的接口中了
更多推荐
所有评论(0)