首页手记 Spring Boot项目中gateway引入详解

Spring Boot项目中gateway引入详解

标签：

云计算容器运维

概述

本文详细介绍了如何在Spring Boot项目中引入gateway并配置路由规则，通过Maven或Gradle添加依赖，使用配置文件或Java配置类定义路由规则，实现灵活的请求转发和处理。文章还展示了使用内置过滤器和自定义过滤器增强网关功能的方法。

什么是Spring Boot Gateway

Spring Boot Gateway 是Spring生态系统中的一个微服务网关。它为微服务架构提供了一个简单、强大且灵活的API网关解决方案。Spring Boot Gateway 可以作为API的前端服务器，处理所有传入的请求，执行路由转发、请求过滤等操作，从而保护和增强后端的微服务。它基于Spring Cloud Gateway开发，提供了丰富的功能，如路径匹配、路由、过滤器等，使得构建高性能、高可用的网关变得简单。

Spring Boot Gateway的核心优势包括：

高性能和高可用性：Spring Boot Gateway基于WebFlux，这是一个响应式非阻塞的框架，可以极大地提升网关的性能和处理能力。
灵活的路由规则：Spring Boot Gateway提供了丰富的路由规则配置选项，支持基于路径、HTTP方法、请求头等多种匹配方式。
强大的过滤器支持：内置了多种过滤器，如预过滤器、后置过滤器、路由过滤器等，可以满足各种复杂的处理需求。开发人员还可以创建自定义过滤器来增强功能。
方便的集成和管理：Spring Boot Gateway可以与Spring Boot和Spring Cloud生态系统中的其他组件无缝集成，简化了微服务架构的构建和管理过程。

Spring Boot Gateway是构建现代化微服务架构的理想选择，它不仅提高了系统的可扩展性和可维护性，还可以通过配置路由和过滤器来实现各种高级功能，如权限控制、监控、日志记录等。

准备工作

在开始使用Spring Boot Gateway之前，需要完成一些准备工作，包括安装Java开发环境、安装IDE（如IntelliJ IDEA或Eclipse），以及创建Spring Boot项目。

安装Java开发环境

首先，确保你的系统上已经安装了Java开发环境。Spring Boot项目通常使用JDK 8或更高版本。以下是安装步骤：

下载并安装JDK：
访问Oracle官方网站或OpenJDK官方网站下载最新版本的JDK。安装完成后，设置JAVA_HOME环境变量，指向JDK的安装路径，并将JDK的bin目录添加到PATH环境变量中。

验证安装：
打开命令行工具，输入以下命令验证安装是否成功：

java -version

如果安装成功，将显示Java的版本号，如：

java version "1.8.0_292"
Java(TM) SE Runtime Environment (build 1.8.0_292-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.292-b10, mixed mode)

安装IDE（如IntelliJ IDEA或Eclipse）

接下来，选择一个合适的IDE来编写Spring Boot项目。这里以IntelliJ IDEA为例，说明安装和配置步骤。

下载并安装IntelliJ IDEA：
访问IntelliJ IDEA官方网站下载并安装最新版本的IntelliJ IDEA。
配置IntelliJ IDEA：
- 安装完成后，打开IntelliJ IDEA，选择“File” -> “New” -> “Project”。
- 在弹出的窗口中选择“Spring Initializr”，点击“Next”。
- 在“Project SDK”中选择已安装的JDK。
- 选择项目名称、保存位置和语言（Java），点击“Next”。
- 在“Dependencies”中选择“Web”和“Spring Web”，点击“Next”。
- 点击“Finish”，IntelliJ IDEA将创建并加载新项目。

验证IDE配置：
打开项目中的pom.xml文件（如果使用Maven）或build.gradle文件（如果使用Gradle），确保配置正确。以下是一个简单的Maven pom.xml示例：

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.example</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <dependencies>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
           <version>2.6.3</version>
       </dependency>
   </dependencies>
   <build>
       <plugins>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
       </plugins>
   </build>
</project>

创建Spring Boot项目

使用IntelliJ IDEA创建Spring Boot项目：
- 选择“File” -> “New” -> “Project”。
- 点击“Spring Initializr”，然后选择“Maven”，点击“Next”。
- 输入项目信息（如Group ID、Artifact ID、Version、Name等），选择Java语言。
- 在“Dependencies”中添加Spring Boot Starter Web和Spring Boot Starter Gateway。
- 点击“Next”，然后点击“Finish”。IntelliJ IDEA将自动生成并加载项目结构。
使用Eclipse创建Spring Boot项目：
- 选择“File” -> “New” -> “Dynamic Web Project”。
- 输入项目名称（如GatewayDemo），然后点击“Next”。
- 在“Configure for”中选择“Dynamic Web Module”，点击“Next”。
- 选择“Target Runtime”，点击“Next”，然后点击“Finish”。

配置项目依赖：

打开pom.xml文件，添加Spring Boot Starter Web和Spring Boot Starter Gateway依赖。

示例代码：

<dependencies>
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
     <version>2.6.3</version>
 </dependency>
 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-gateway</artifactId>
     <version>3.1.2</version>
 </dependency>
</dependencies>

至此，准备工作已完成，接下来可以开始在Spring Boot项目中引入Gateway。

在Spring Boot项目中引入Gateway

在Spring Boot项目中引入Gateway需要进行两步：添加Gateway依赖和配置Gateway路由规则。以下将详细介绍这两步操作。

使用Maven或Gradle添加Gateway依赖

在Spring Boot项目中，通常使用Maven或Gradle管理依赖。以下是添加Gateway依赖的具体步骤，包括Maven和Gradle的配置示例。

使用Maven添加依赖：
在项目的pom.xml文件中添加spring-cloud-starter-gateway依赖，示例如下：

<dependencies>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-gateway</artifactId>
   </dependency>
</dependencies>

其中，spring-boot-starter-web是Spring Boot Web应用的基本依赖，而spring-cloud-starter-gateway是Spring Cloud Gateway的依赖。

使用Gradle添加依赖：
在项目的build.gradle文件中添加spring-cloud-starter-gateway依赖，示例如下：
```
dependencies {
   implementation 'org.springframework.boot:spring-boot-starter-web'
   implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
}
```
其中，implementation 'org.springframework.boot:spring-boot-starter-web'是Spring Boot Web应用的基本依赖，而implementation 'org.springframework.cloud:spring-cloud-starter-gateway'是Spring Cloud Gateway的依赖。

配置Gateway路由规则

添加依赖后，需要配置Gateway的路由规则，以便将其应用到具体的请求处理中。以下是配置路由规则的步骤和示例代码。

使用配置文件配置路由规则：
Spring Cloud Gateway默认使用application.yml或application.properties文件来配置路由规则。以下是一个简单的application.yml示例，展示了如何配置路由规则：
```
spring:
 cloud:
   gateway:
     routes:
       - id: route1
         uri: http://example.com
         predicates:
           - Path=/api/v1/*
```
上面的配置表示当所有路径以/api/v1/开头的请求都被转发到http://example.com。

使用Java配置类配置路由规则：
可以创建一个Java配置类来定义路由规则。以下是一个示例：

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 myRoutes(RouteLocatorBuilder builder) {
       return builder.routes()
               .route("route1", r -> r.path("/api/v1/**")
                       .uri("http://example.com"))
               .build();
   }
}

在上述配置中，使用RouteLocatorBuilder来构建路由规则。path方法用于设置匹配路径，uri方法用于设置目标URI。

通过上述配置方式，可以灵活地定义和管理路由规则，确保Spring Boot Gateway能够正确地处理传入的请求。

Gateway的基本使用

Spring Boot Gateway具有丰富的功能，比如设置路由规则和路由转发。本节将详细介绍如何设置路由规则，并提供一个路由转发的示例。

设置路由规则

设置路由规则是Spring Boot Gateway的核心功能之一，它可以将不同的请求转发到不同的后端服务。以下是如何设置基本路由规则的步骤和示例代码。

基本路由配置：
以下是一个基本的路由配置示例，展示了如何将/api/v1/*路径的请求转发到http://example.com：
```
spring:
 cloud:
   gateway:
     routes:
       - id: route1
         uri: http://example.com
         predicates:
           - Path=/api/v1/*
```
上述配置定义了一个ID为route1的路由规则，当路径匹配/api/v1/*时，请求将被转发到http://example.com。
自定义路径匹配器：
可以使用各种路径匹配器来创建更复杂的路由规则。例如，可以使用正则表达式进行路径匹配：
```
spring:
 cloud:
   gateway:
     routes:
       - id: route2
         uri: http://another-example.com
         predicates:
           - Path=/api/v2/**, Pattern=^/api/v2/[a-zA-Z0-9-]+$
```
上述配置使用了正则表达式来匹配/api/v2/开头且后面跟随一个由字母、数字和破折号组成的路径。

通过上述配置方式，可以灵活地定义和管理路由规则，确保Spring Boot Gateway能够正确地处理传入的请求。

路由转发示例

下面将通过一个具体的例子来说明如何配置Spring Boot Gateway进行路由转发。假设我们有一个简单的微服务架构，包含一个网关服务和一个后端服务，我们将配置Spring Boot Gateway将特定路径的请求转发到后端服务。

创建后端服务：
创建一个简单的Spring Boot应用程序作为后端服务，例如BackendService，该服务有一个端点/api/v1/users，返回用户列表。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Arrays;
import java.util.List;

@RestController
@RequestMapping("/api/v1")
public class UserController {

   @GetMapping("/users")
   public List<String> getUsers() {
       return Arrays.asList("user1", "user2", "user3");
   }
}

配置网关服务：
在网关服务中配置路由规则，将所有/api/v1/users的请求转发到后端服务。

spring:
 cloud:
   gateway:
     routes:
       - id: user_route
         uri: http://localhost:8081
         predicates:
           - Path=/api/v1/users

启动服务：
启动网关服务和后端服务。网关服务将会监听不同的端口，例如8080，而后端服务监听8081。
测试路由转发：
使用浏览器或curl工具访问网关服务的端点/api/v1/users，确保请求被正确转发到后端服务，并返回用户列表。
```
curl http://localhost:8080/api/v1/users
```
期望的响应应该如下：
```
["user1", "user2", "user3"]
```

通过上述示例，可以清楚地看到Spring Boot Gateway如何将请求转发到后端服务，从而实现微服务架构中的请求路由功能。

Gateway的过滤器使用

Spring Boot Gateway提供了强大的过滤器功能，可以对请求和响应进行各种处理和增强。本节将详细介绍如何创建自定义过滤器和使用内置过滤器。

创建自定义过滤器

自定义过滤器可以实现各种复杂的业务逻辑，比如权限验证、日志记录等。以下是如何创建和使用自定义过滤器的步骤和示例代码。

定义过滤器接口：
Spring Cloud Gateway提供了多种过滤器接口，包括GatewayFilter和GlobalFilter。以下是一个简单的自定义过滤器示例：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class CustomGatewayFilter implements GatewayFilter, Ordered {

   @Override
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
       // 获取请求路径
       String path = exchange.getRequest().getPath().value();

       if (path.startsWith("/api/v1/")) {
           // 如果路径以"/api/v1/"开头，则返回403错误
           return exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
       }

       // 继续处理请求
       return chain.filter(exchange);
   }

   @Override
   public int getOrder() {
       // 设置过滤器的执行顺序
       return 0;
   }
}

在上述代码中，定义了一个名为CustomGatewayFilter的自定义过滤器。该过滤器检查请求路径，如果路径以/api/v1/开头，则返回HTTP状态码403，表示请求被禁止。

注册过滤器：
需要在配置类中注册自定义过滤器。以下是一个示例配置类：

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 myRoutes(RouteLocatorBuilder builder) {
       return builder.routes()
               .route("route1", r -> r.path("/api/v1/**")
                       .uri("http://example.com")
                       .filters(f -> f.filter(new CustomGatewayFilter())))
               .build();
   }
}

在上述配置类中，使用filters方法来注册自定义过滤器CustomGatewayFilter，该过滤器将应用于所有路径以/api/v1/开头的请求。

通过上述步骤，可以创建自定义过滤器并将其应用到特定的路由规则，实现更复杂的业务逻辑。

使用内置过滤器

Spring Boot Gateway提供了多种内置过滤器，可以满足各种常见的请求处理需求。以下是如何使用内置过滤器的示例。

添加内置过滤器：
在配置文件中使用内置过滤器。例如，使用RewritePath过滤器来重写请求路径：
```
spring:
 cloud:
   gateway:
     routes:
       - id: route1
         uri: http://example.com
         predicates:
           - Path=/api/v1/users/**
         filters:
           - RewritePath=/api/v1/users/(\.*), uri=/users/$1
```
在上述配置中，RewritePath过滤器将路径/api/v1/users/重写为/users/，并转发到目标URI。

指定过滤器顺序：
可以通过order属性来指定过滤器的执行顺序。例如，使用Order注解来设置过滤器的顺序：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.core.Ordered;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class CustomOrderFilter implements GatewayFilter, Ordered {

   @Override
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
       ServerHttpRequest request = exchange.getRequest();
       if (request.getQueryParams().containsKey("test")) {
           return chain.filter(exchange);
       }
       return exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
   }

   @Override
   public int getOrder() {
       return 1;
   }
}

在上述代码中，定义了一个名为CustomOrderFilter的过滤器，该过滤器检查请求参数test，如果存在则允许请求继续执行，否则返回403状态码。通过Order注解，将该过滤器的顺序设置为1。

使用全局过滤器：
全局过滤器会影响所有路由规则。例如，使用GlobalFilter来添加全局过滤器：

import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;

import java.util.function.Function;

@Configuration
public class GatewayConfig {

   @Bean
   public GlobalFilter globalFilter() {
       return (exchange, chain) -> {
           ServerHttpRequest request = exchange.getRequest();
           if (request.getQueryParams().containsKey("test")) {
               return chain.filter(exchange);
           }
           return exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
       };
   }
}

在上述配置中，定义了一个全局过滤器globalFilter，该过滤器检查请求参数test，如果存在则允许请求继续执行，否则返回403状态码。

通过上述示例，可以清楚地看到如何使用内置过滤器和全局过滤器来增强网关的功能，实现更复杂的请求处理逻辑。

Gateway的启动与测试

启动Spring Boot应用并测试路由转发功能是确保Gateway正确配置和运行的关键步骤。本节将详细介绍如何启动Spring Boot应用，并进行路由转发功能的测试。

启动Spring Boot应用

启动Spring Boot应用通常只需运行应用程序的主类，该主类通常包含@SpringBootApplication注解。以下是如何启动Spring Boot应用的步骤和示例代码。

构建并运行主类：
在Spring Boot项目中，创建一个主类，该主类通常包含@SpringBootApplication注解。例如：

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);
   }
}

上述代码中，GatewayApplication是Spring Boot应用的主类，通过调用SpringApplication.run方法启动应用。

运行主类：
在IDE中，通常可以通过点击运行按钮或使用命令行工具启动应用。例如，在IntelliJ IDEA中，点击主类上方的绿色运行按钮。或者在命令行中执行以下命令：
```
mvn spring-boot:run
```
如果使用Gradle，可以执行以下命令：
```
./gradlew bootRun
```
应用启动后，可以在控制台输出中看到启动日志，包括应用的端口号（默认为8080）。

测试路由转发功能

启动应用后，可以通过测试路由转发功能来验证Gateway是否正确配置。以下是如何进行测试的步骤和示例代码。

启动后端服务：
如果配置了路由转发到后端服务，首先需要启动后端服务。例如，假设有一个简单的Spring Boot应用作为后端服务，该应用包含一个端点/api/v1/users，返回用户列表：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Arrays;
import java.util.List;

@RestController
@RequestMapping("/api/v1")
public class UserController {

   @GetMapping("/users")
   public List<String> getUsers() {
       return Arrays.asList("user1", "user2", "user3");
   }
}

启动该后端服务，并确保其正常运行在某个端口（例如8081）。

访问网关服务端点：
使用浏览器或命令行工具访问网关服务的端点，例如：
```
curl http://localhost:8080/api/v1/users
```
如果一切配置正确，网关服务将会将该请求转发到后端服务，并返回用户列表。
验证响应：
期望的响应应该如下：
```
["user1", "user2", "user3"]
```
如果响应正确，说明路由转发功能已经成功配置并运行。

通过上述步骤，可以验证Spring Boot Gateway是否正确配置和运行，确保路由转发功能正常工作。如果遇到问题，可以检查配置文件、路由规则和依赖项，确保没有遗漏或错误的信息。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

慕桂英3389331

手记
篇

粉丝

43

获赞与收藏

187

关注作者，订阅最新文章

相关文章推荐

Spring Cloud Gateway限流详解

Spring Boot项目中使用Mockito

SpringCloud Gateway入门

Spring Cloud Gateway实战之一：初探

SpringCloud Gateway入门

阅读免费教程

Java并发工具

23个小节 19133 310

HTTP 入门教程

28个小节 37601 645

后端通用面试教程

41个小节 30273 342

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空