（六十）java版spring cloud微服务架构b2b2c电子商务平台-Zuul

API 服务网关顾名思义就是统一入口，类似 nginx、F5 等功能一样，统一代理控制请求入口，弱化各个微服务被客户端记忆功能；

本章节主要讲解了使用 zuul 的代理功能与反向代理功能，当然 zuul 还有很多属性设置，我就没一一列举所有的测试方法了；

二、实现步骤

2.1 添加 maven 引用包

<?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>

    <artifactId>springms-gateway-zuul</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>com.springms.cloud</groupId>
        <artifactId>springms-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <dependencies>
        <!-- API网关模块 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

        <!-- 客户端发现模块，由于文档说 Zuul 的依赖里面不包括 eureka 客户端发现模块，所以这里还得单独添加进来 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
    </dependencies>

</project>

2.2 添加应用配置文件

spring:
  application:
    name: springms-gateway-zuul
server:
  port: 8150
eureka:
  datacenter: SpringCloud   # 修改 http://localhost:8761 地址 Eureka 首页上面 System Status 的 Data center 显示信息
  environment: Test         # 修改 http://localhost:8761 地址 Eureka 首页上面 System Status 的 Environment 显示信息
  client:
    service-url:
      defaultZone: http://admin:admin@localhost:8761/eureka
   healthcheck:  # 健康检查
       enabled: true
  instance:
    prefer-ip-address: true
    instance-id: ${spring.application.name}:${spring.cloud.client.ipAddress}:${spring.application.instance_id:${server.port}}

2.3 添加zuul服务网关微服务启动类

package com.springms.cloud;

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

/**
* Zuul 服务 API 网关微服务之代理与反向代理。
*
* 注意 EnableZuulProxy 注解能注册到 eureka 服务上，是因为该注解包含了 eureka 客户端的注解，该 EnableZuulProxy 是一个复合注解。
*
* @EnableZuulProxy --> { @EnableCircuitBreaker、@EnableDiscoveryClient } 包含了 eureka 客户端注解，同时也包含了 Hystrix 断路器模块注解。
*
* http://localhost:8150/routes 地址可以查看该zuul微服务网关代理了多少微服务的serviceId。
*
* @author hmilyylimh
*
* @version 0.0.1
*
* @date 2017/9/24
*
*/
@SpringBootApplication
@EnableZuulProxy
public class MsGatewayZuulApplication {

   public static void main(String[] args) {
       SpringApplication.run(MsGatewayZuulApplication.class, args);
       System.out.println(" GatewayZuul微服务已启动.");
   }
}

三、测试

一、Zuul 服务 API 网关微服务之代理与反向代理（正常情况测试）：

1、编写 application.yml 文件，添加应用程序的注解 EnableZuulProxy 配置；

2、启动 springms-discovery-eureka 模块服务，启动1个端口；

3、启动 springms-provider-user 模块服务，启动1个端口（application.yml 文件中的 appname 属性不去掉的话，测试一是无法测试通过的）；

4、启动 springms-consumer-movie 模块服务，启动1个端口；

5、启动 springms-gateway-zuul 模块服务；

6、新起网页页签，输入 http://localhost:7900/simple/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

7、新起网页页签，输入 http://localhost:7901/movie/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

总结一：第6、7步正常，说明 springms-provider-user、springms-consumer-movie 两个服务目前正常；

8、新起网页页签，然后输入 http://localhost:8150/springms-provider-user/simple/3，正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

9、新起网页页签，然后输入 http://localhost:8150/springms-consumer-movie/movie/4，正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

总结二：第8、9步也能正常打印用户信息，说明 API 网关已经生效了，可以通过API服务器地址链接各个微服务的 http://localhost:8150/serviceId/path 这样的路径来访问了；

二、Zuul 服务 API 网关微服务之代理与反向代理（自定义路径配置，给 springms-provider-user 微服务添加前缀地址，反向代理用户微服务）：

1、编写 application.yml 文件，添加应用程序的注解 EnableZuulProxy 配置；
# 测试二，自定义路径配置，给 springms-provider-user 微服务添加前缀地址，反向代理用户微服务

   zuul:
      routes:
          springms-provider-user: /user/

2、启动 springms-discovery-eureka 模块服务，启动1个端口；

3、启动 springms-provider-user 模块服务，启动1个端口（application.yml 文件中的 appname 属性不去掉的话，测试一是无法测试通过的）；

4、启动 springms-consumer-movie 模块服务，启动1个端口；

5、启动 springms-gateway-zuul 模块服务；

6、新起网页页签，输入 http://localhost:7900/simple/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

7、新起网页页签，输入 http://localhost:7901/movie/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

8、新起网页页签，然后输入 http://localhost:8150/springms-provider-user/simple/3，正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

9、新起网页页签，然后输入 http://localhost:8150/springms-consumer-movie/movie/4，正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

10、新起网页页签，然后输入 http://localhost:8150/user/simple/3，正常情况下是能看到 ID != 0 一堆用户信息被打印出来，可见【用户微服务】的地址被改变生效了，同时被 API 网关反向代理了，也就是说 http 的请求 /user 将被发送到【用户微服务】；

11、新起网页页签，然后输入 http://localhost:8150/user/movie/4，正常情况下访问不通，理应访问不通的；

三、Zuul 服务 API 网关微服务之代理与反向代理（自定义路径配置，给 springms-provider-user 微服务添加前缀地址，反向代理用户微服务，其它代理路径一律失效）：

1、编写 application.yml 文件，添加应用程序的注解 EnableZuulProxy 配置；
# 测试三，自定义路径配置，给User微服务添加前缀地址，反向代理User微服务

  zuul:
      ignoredServices: '*'
      routes:
          springms-provider-user: /user/**

2、启动 springms-discovery-eureka 模块服务，启动1个端口；

3、启动 springms-provider-user 模块服务，启动1个端口（application.yml 文件中的 appname 属性不去掉的话，测试一是无法测试通过的）；

4、启动 springms-consumer-movie 模块服务，启动1个端口；

5、启动 springms-gateway-zuul 模块服务；

6、新起网页页签，输入 http://localhost:7900/simple/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

7、新起网页页签，输入 http://localhost:7901/movie/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

总结一：第6、7步正常，说明 springms-provider-user、springms-consumer-movie 两个服务目前正常；

8、新起网页页签，然后输入 http://localhost:8150/springms-provider-user/simple/3， 正常情况下不能被代理了，访问页面不存在，出现404错误码；

9、新起网页页签，然后输入 http://localhost:8150/springms-consumer-movie/movie/4， 正常情况下不能被代理了，访问页面不存在，出现404错误码；

总结二：第8、9步访问出现404错误码，说明通过 http://localhost:8150/serviceId/path 代理路径访问 API 网关已经失效了；

10、新起网页页签，然后输入 http://localhost:8150/user/simple/3， 正常情况下是能看到 ID != 0 一堆用户信息被打印出来，可见【用户微服务】的地址被改变生效了，同时被 API 网关反向代理了，也就是说 http 的请求 /user 将被发送到【用户微服务】；

11、新起网页页签，然后输入 http://localhost:8150/user/movie/4， 正常情况下访问不通，理应访问不通的；

四、Zuul 服务 API 网关微服务之代理与反向代理（自定义路径配置，给 springms-provider-user 微服务添加前缀地址，代理、反向代理用户微服务，忽略禁用 springms-consumer-movie 代理、反向代理路径）：

1、编写 application.yml 文件，添加应用程序的注解 EnableZuulProxy 配置；

测试四，自定义路径配置，给 springms-provider-user 微服务添加前缀地址，代理、反向代理用户微服务，忽略禁用 springms-consumer-movie 代理、反向代理路径

  zuul:
      ignoredServices: springms-consumer-movie
      routes:
         springms-provider-user: /user/**

2、启动 springms-discovery-eureka 模块服务，启动1个端口；

3、启动 springms-provider-user 模块服务，启动1个端口（application.yml 文件中的 appname 属性不去掉的话，测试一是无法测试通过的）；

4、启动 springms-consumer-movie 模块服务，启动1个端口；

5、启动 springms-gateway-zuul 模块服务；

6、新起网页页签，输入 http://localhost:7900/simple/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

7、新起网页页签，输入 http://localhost:7901/movie/3 正常情况下是能看到 ID != 0 一堆用户信息被打印出来；

8、新起网页页签，然后输入 http://localhost:8150/springms-provider-user/simple/3， 正常情况下是能看到 ID != 0 一堆用户信息被打印出来，可见【用户微服务】的地址被改变生效了，同时被 API 网关反向代理了，也就是说 http 的请求 /user 将被发送到【用户微服务】；

9、新起网页页签，然后输入 http://localhost:8150/springms-consumer-movie/movie/4， 正常情况下不能被代理了，访问页面不存在，出现404错误码；

10、新起网页页签，然后输入 http://localhost:8150/user/simple/3， 正常情况下是能看到 ID != 0 一堆用户信息被打印出来，可见【用户微服务】的地址被改变生效了，同时被 API 网关反向代理了，也就是说 http 的请求 /user 将被发送到【用户微服务】；

11、新起网页页签，然后输入 http://localhost:8150/user/movie/4， 正常情况下访问不通，理应访问不通的；

注意：测试三、测试四的区别在于，ignoredServices 属性的设置，影响的是 springms-consumer-movie 微服务的代理路径是否可以访问