Spring Boot - Zuul 代理服务器和路由

Zuul Server 是一个网关应用,处理所有的请求,做微服务应用的动态路由。 Zuul 服务器也称为边缘服务器。

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

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


创建 Zuul 服务器应用程序

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

创建 Zuul 服务器应用程序

在主 Spring Boot 应用程序上添加 @EnableZuulProxy 注解。 @EnableZuulProxy 注解用于使您的 Spring Boot 应用程序充当 Zuul 代理服务器。

package com.tutorialspoint.zuulserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication
@EnableZuulProxy
public class ZuulserverApplication {
   public static void main(String[] args) {
      SpringApplication.run(ZuulserverApplication.class, args);
   }
}

您必须在我们的构建配置文件中添加 Spring Cloud Starter Zuul 依赖项。

Maven 用户必须在 pom.xml 文件中添加以下依赖项 −

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

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

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

对于 Zuul 路由,在 application.properties 文件或 application.yml 文件中添加以下属性。

spring.application.name = zuulserver
zuul.routes.products.path = /api/demo/**
zuul.routes.products.url = http://localhost:8080/
server.port = 8111

这意味着对 /api/demo/ 的 http 调用会被转发到产品服务。例如,/api/demo/products 被转发到 /products

yaml 文件用户可以使用如下所示的 application.yml 文件 −

server:
   port: 8111
spring:
   application:  
      name: zuulserver
zuul:

routes:
   products:
      path: /api/demo/**
      url: http://localhost:8080/

注意http://localhost:8080/ 应用程序应该在通过 Zuul 代理路由之前已经运行。

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

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 
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>zuulserver</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>zuulserver</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.9.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
      <spring-cloud.version>Edgware.RELEASE</spring-cloud.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-zuul</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>
      </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 = '1.5.9.RELEASE'
   }
   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 = 1.8

repositories {
   mavenCentral()
}
ext {
   springCloudVersion = 'Edgware.RELEASE'
}
dependencies {
   compile('org.springframework.cloud:spring-cloud-starter-zuul')
   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”之后,您可以在目标目录下找到 JAR 文件。

对于 Gradle,您可以使用下面给出的命令 −

gradle clean build

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

现在,使用如下所示的命令运行 JAR 文件 −

java –jar <JARFILE> 

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

在 Tomcat 端口 8111 上启动应用程序

现在,在您的网络浏览器中点击 URL http://localhost:8111/api/demo/products,您可以看到 /products REST Endpoint 的输出,如下所示 −

Products REST Endpoint