Spring Boot - 网关代理服务器和路由

上一页
下一页

网关代理服务器是一个网关应用程序，它处理所有请求并对微服务应用程序进行动态路由。

例如，/api/user 映射到用户服务，/api/products 映射到产品服务，Zuul 服务器动态地将请求路由到相应的后端应用程序。

spring-cloud-starter-zuul 依赖项用于在 Spring Boot 项目中集成 Zuul 网关服务器。现在它已弃用，并替换为 spring-cloud-starter-gateway-mvc 依赖项。从现在开始，我们将使用网关服务器术语代替 Zuul 服务器。

在本章中，我们将详细了解如何在 Spring Boot 中创建网关服务器应用程序。

创建网关服务器应用程序

网关服务器与 Spring Cloud 依赖项捆绑在一起。您可以从 Spring Initializer 页面 https://start.spring.io/ 下载 Spring Boot 项目，并选择 Zuul 服务器依赖项。

Creating Gateway Server Application

在您的主 Spring Boot 应用程序中添加路由信息。在这里，我们将接收到的每个请求重路由到不同的服务器，同时添加一个示例请求头。

GatewayApplication

package com.tutorialspoint.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class GatewayApplication {

   public static void main(String[] args) {
      SpringApplication.run(GatewayApplication.class, args);
   }	
	
   @Bean
   public RouteLocator myRoutes(RouteLocatorBuilder builder) {
      return builder.routes()
         .route(p -> p
            .path("/**")
            .filters(f -> f.addRequestHeader("Src", "Tutorialspoint"))
            .uri("https://127.0.0.1:8080/"))
            .build();
   }
}

您需要在构建配置文件中添加 Spring Cloud Starter Gateway 依赖项。

Maven 用户需要在您的 pom.xml 文件中添加以下依赖项：

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

更新 application.properties 以指向 8111 端口

application.properties

spring.application.name=gateway
server.port = 8111

对于 Gradle 用户，在您的 build.gradle 文件中添加以下依赖项

compile('org.springframework.cloud:spring-cloud-starter-gateway')

application.yaml

spring
  application
     name: gateway
server
  port: 8111

注意 - 在通过网关代理路由之前，https://127.0.0.1:8080/ 应用程序应该已经运行。有关 REST 服务的详细信息，请参阅 使用 RESTful Web 服务 章节。

完整的构建配置文件如下所示。

Maven 用户可以使用以下给出的 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>3.3.3</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>gateway</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>gateway</name>
   <description>Demo project for Spring Boot</description>
   <url/>
   <licenses>
      <license/>
   </licenses>
   <developers>
      <developer/>
   </developers>
   <scm>
      <connection/>
      <developerConnection/>
      <tag/>
      <url/>
   </scm>
   <properties>
      <java.version>21</java.version>
      <spring-cloud.version>2023.0.3</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>
      </dependency>
      <dependency>
         <groupId>io.projectreactor</groupId>
         <artifactId>reactor-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>
      </dependencies>
   </dependencyManagement>
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

Gradle 用户可以使用以下给出的 build.gradle 文件：

buildscript {
   ext {
      springBootVersion = '3.3.3'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.tutorialspoint'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 21

repositories {
   mavenCentral()
}
ext {
   springCloudVersion = 'Edgware.RELEASE'
}
dependencies {
   compile('org.springframework.cloud:spring-cloud-starter-gateway')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}
dependencyManagement {
   imports {
      mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
   }
}

您可以创建一个可执行的 JAR 文件，并使用以下给出的 Maven 或 Gradle 命令运行 Spring Boot 应用程序：

对于 Maven，您可以使用以下给出的命令：

mvn clean install

“BUILD SUCCESS” 后，您可以在 target 目录下找到 JAR 文件。

对于 Gradle，您可以使用以下给出的命令：

gradle clean build

“BUILD SUCCESSFUL” 后，您可以在 build/libs 目录下找到 JAR 文件。

现在，使用以下显示的命令运行 JAR 文件：

java –jar <JARFILE>

您可以发现应用程序已在 Tomcat 端口 8111 上启动，如下所示。

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/

[32m :: Spring Boot :: [39m              [2m (v3.3.3)[0;39m

[2m2024-09-11T14:37:33.937+05:30[0;39m [32m INFO[0;39m [35m14996[0;39m [2m---[0;39m [2m[gateway] [           main][0;39m [2m[0;39m[36mc.t.gateway.GatewayApplication          [0;39m [2m:[0;39m Starting GatewayApplication using Java 21.0.3 with PID 14996 (E:\Dev\gateway\target\classes started by Tutorialspoint in E:\Dev\gateway)
[2m2024-09-11T14:37:33.940+05:30[0;39m [32m INFO[0;39m [35m14996[0;39m [2m---[0;39m [2m[gateway] [           main][0;39m [2m[0;39m[36mc.t.gateway.GatewayApplication          [0;39m [2m:[0;39m No active profile set, falling back to 1 default profile: "default"
...
[2m[0;39m[36mo.s.c.g.r.RouteDefinitionRouteLocator   [0;39m [2m:[0;39m Loaded RoutePredicateFactory [CloudFoundryRouteService]
[2m2024-09-11T14:37:35.796+05:30[0;39m [32m INFO[0;39m [35m14996[0;39m [2m---[0;39m [2m[gateway] [           main][0;39m [2m[0;39m[36mo.s.b.web.embedded.netty.NettyWebServer [0;39m [2m:[0;39m Netty started on port 8111 (http)
[2m2024-09-11T14:37:35.832+05:30[0;39m [32m INFO[0;39m [35m14996[0;39m [2m---[0;39m [2m[gateway] [           main][0;39m [2m[0;39m[36mc.t.gateway.GatewayApplication          [0;39m [2m:[0;39m Started GatewayApplication in 2.366 seconds (process running for 3.198)

现在，在您的 Web 浏览器中访问 URL https://127.0.0.1:8111/products，您将看到 https://127.0.0.1:8080/products REST 端点的输出，如下所示：

Products REST Endpoint
打印页面
上一页
下一页
广告