SpringCloud 网关Zuul 实现之路由功能

一、背景

通过之前的实现springCloud 各组件，发现有一个特点，就是外部访问的时候，直接就是通过各服务具体端口进行访问的，这在实际生产上是不可能的，实际生产环境中nignx就可以做一层地址的映射，那springCloud有没有这个功能呢，当然有，在springCloud中提供了Zuul组件，其中一个功能就是进行服务的路由的功能。

以下是一般项目中服务端网络拓扑图：

如图所示：客户端请求经过网关之后，通过eureka server查找相对应的服务调用方，并经过ribbon负载均衡之后范围具体的服务提供方，来进行相对应的服务操作。

可以看到，网关zuul是对外的第一处（这里没有加上nginx）。

下面我们来实现Zuul第一个功能：路由

二、Zuul实现 

项目依旧是基于之前的项目基础上进行开发的，之前相关的介绍和代码参考：项目介绍和源码

和之前一样创建一个新的module, 在配置的模块中选上Eureka Discovery,Zuul

对应的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>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.3.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.Cloud</groupId>
	<artifactId>gateway</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>gateway</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
		<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</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>

	<repositories>
		<repository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
		</repository>
	</repositories>

</project>

在生成的启动类加上注解：@EnableDiscoveryClient @EnableZuulProxy

package com.cloud.gateway;

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

@SpringBootApplication
@EnableDiscoveryClient
@EnableZuulProxy
public class GatewayApplication {

	public static void main(String[] args) {
		SpringApplication.run(GatewayApplication.class, args);
	}

}

配置文件这边相对应比较推荐yaml，比较好写路由，配置文件中加上端口号，eureka server地址，服务名称，还有对应的路由配置项目。

server:
  port: 9900

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:12345/eureka/

spring:
  application:
            name: CLOUD-GATEWAY-SERVICE

management:
  endpoints:
        web:
          exposure:
            include: '*'
  endpoint:
    health:
      show-details: ALWAYS

zuul:
  routes:
    ribbon:
      path: /ribbon/**
      service-id: SPRING-CLIENT-02
    feign:
      path: /feign/**
      service-id: SPRING-FEIGN-SERVICE
    client:
      path: /three/**
      service-id: SPRING-CLIENT-03

我这边根据之前创建的3的服务，配置了三个路由。

路由配置的规则是routes后面是你自己指定的项目，这个随便命名，再下面path就是在url中的路径，service-id就是Cloud中对应的服务名称。

这样就配置好了。

配置完成之后依次启动eureka server, 配置的各项服务，我这边就启动了之前项目中的Ribbon 服务SPRING-CLIENT-02，Feign服务SPRING-FEIGN-SERVICE，还有一个SPRING-CLIENT-02服务。

登录到eureka server管理界面我这边是http://localhost:12345

 然后这边访问之前Ribbon的一个端口服务：http://localhost:11000/getInfo/hellol得到的结果是：

然后通过路由来访问：http://localhost:9900/ribbon/getInfo/hellol得到的结果是：

可以看到路由功能成功。 

另外，如果配置好了路由功能，那么怎么查看路由表呢，直接可以通过浏览器路由所在服务端口+actuator/routes看到。

我这边就是http://localhost:9900/actuator/routes

可以看到在Cloud中没有配置路由的服务，也自动生产了路由。

至此ZUUL第一个功能路由功能就实现了。

此次项目工程源码github地址:源码地址