微服务技术系列教程（25） - SpringCloud- 接口网关服务Zuul

引言

代码已提交至Github，有兴趣的同学可以下载看看：https://github.com/ylw-github/SpringCloud-Zuul-Demo

本文目录结构：
l____引言
l____1. 网关
l________1.1 网关分类
l________1.2 网关设计
l________1.3 网关框架
l____2. 接口网关服务Zuul
l________2.1 使用Zuul实现反向代理
l________2.2 使用Zuul过滤器
l________2.3 使用Zuul整合Ribbon
l________2.4 动态网关
l________2.5 网关集群
l____3. 总结

之前也写过关于Zuul网关的文章，有兴趣的同学可以参考：

• 《基于Nginx实现API网关》
• 《基于Zuul实现API网关》

先来理解几个概念：

网关的作用：

• 可以实现负载均衡、路由转发、日志、权限控制、监控等。
  

网关与过滤器区别：

• 网关是拦截所有服务器请求进行控制
• 过滤器拦截某单个服务器请求进行控制
  

Nginx与Zuul的区别：

• Nginx是采用服务器负载均衡进行转发
• Zuul依赖Ribbon和eureka实现本地负载均衡转发
  
• 相对来说Nginx功能比Zuul功能更加强大，能够整合其他语言比如lua脚本实现强大的功能，同时Nginx可以更好的抗高并发，Zuul网关适用于请求过滤和拦截等。

Zuul是spring cloud的一个推荐组件：https://github.com/Netflix/zuul

1. 网关

1. 1 网关分类

开放API

• 开放api(openApi) 企业需要将自身数据、能力等作为开发平台向外开放，通常会以rest的方式向外提供，最好的例子就是淘宝开放平台、腾讯公司的QQ开发平台、微信开放平台。 Open API开放平台必然涉及到客户应用的接入、API权限的管理、调用次数管理等，必然会有一个统一的入口进行管理，这正是API网关可以发挥作用的时候。

微服务网关

• 微服务的概念最早在2012年提出，在Martin Fowler的大力推广下，微服务在2014年后得到了大力发展。 在微服务架构中，有一个组件可以说是必不可少的，那就是微服务网关，微服务网关处理了负载均衡，缓存，路由，访问控制，服务代理，监控，日志等。API网关在微服务架构中正是以微服务网关的身份存在。

API服务管理平台

• 上述的微服务架构对企业来说有可能实施上是困难的，企业有很多遗留系统，要全部抽取为微服务器改动太大，对企业来说成本太高。但是由于不同系统间存在大量的API服务互相调用，因此需要对系统间服务调用进行管理，清晰地看到各系统调用关系，对系统间调用进行监控等。 API网关可以解决这些问题，我们可以认为如果没有大规模的实施微服务架构，那么对企业来说微服务网关就是企业的API服务管理平台。

1.2 网关设计

开放API接口

• 对于OpenAPI使用的API网关来说，一般合作伙伴要以应用的形式接入到OpenAPI平台，合作伙伴需要到 OpenAPI平台申请应用。 因此在OpenAPI网关之外，需要有一个面向合作伙伴的使用的平台用于合作伙伴，这就要求OpenAPI网关需要提供API给这个用户平台进行访问。 如下架构:
• 
• 当然如果是在简单的场景下，可能并不需要提供一个面向合作伙伴的门户，只需要由公司的运营人员直接添加合作伙伴应用id/密钥等，这种情况下也就不需要合作伙伴门户子系统。

内网API接口

• 对于内网的API网关，在起到的作用上来说可以认为是微服务网关，也可以认为是内网的API服务治理平台。 当企业将所有的应用使用微服务的架构管理起来，那么API网关就起到了微服务网关的作用。 而当企业只是将系统与系统之间的调用使用rest api的方式进行访问时使用API网关对调用进行管理，那么API网关起到的就是API服务治理的作用。 架构参考如下：
• 
• 对于公司内部公网应用（如APP、公司的网站），如果管理上比较细致，在架构上是可能由独立的API网关来处理这部分内部公网应用，如果想比较简单的处理，也可以是使用面向合作伙伴的API网关。 如果使用独立的API网关，有以下的好处：
  ------- 面向合作伙伴和面向公司主体业务的优先级不一样，不同的API网关可以做到业务影响的隔离。
  ------- 内部API使用的管理流程和面向合作伙伴的管理流程可能不一样。
  ------- 内部的API在功能扩展等方面的需求一般会大于OpenAPI对于功能的要求。
  ------- 基于以上的分析，如果公司有能力，那么还是建议分开使用合作伙伴OPEN API网关和内部公网应用网关。

1.3 网关框架

Kong :是基于Nginx+Lua进行二次开发的方案， https://konghq.com/

Netflix Zuul:是spring cloud的一个推荐组件，https://github.com/Netflix/zuul

Orange,这个开源程序是国人开发的， http://orange.sumory.com/

2. 接口网关服务Zuul

2.1 使用Zuul实现反向代理

前面有讲解过，可以参考我写的文章：《基于Zuul实现API网关》，要搭建的项目有：

• 创建Eureka注册中心
• 创建Zuul网关项目
• 创建A项目服务
• 创建B项目服务

这里主要讲解Zuul网关的搭建。

1.需要创建Zuul网关工程

2.Zuul网关工程添加Maven依赖

<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>2.0.1.RELEASE</version>
</parent>
<!-- 管理依赖 -->
<dependencyManagement>
	<dependencies>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-dependencies</artifactId>
			<version>Finchley.M7</version>
			<type>pom</type>
			<scope>import</scope>
		</dependency>
	</dependencies>
</dependencyManagement>
<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
	</dependency>
	<!-- SpringBoot整合eureka客户端 -->
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
	</dependency>
</dependencies>
<!-- 注意： 这里必须要添加， 否者各种依赖有问题 -->
<repositories>
	<repository>
		<id>spring-milestones</id>
		<name>Spring Milestones</name>
		<url>https://repo.spring.io/libs-milestone</url>
		<snapshots>
			<enabled>false</enabled>
		</snapshots>
	</repository>
</repositories>

3.Zuul网关工程application.yml

###注册 中心
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8100/eureka/
server:
  port: 80
###网关名称
spring:
  application:
    name: service-zuul
### 配置网关反向代理
zuul:
  routes:
    api-a:
      ### 以 /api-a/访问转发A服务
      path: /api-a/**
      serviceId: app-service-a
    api-b:
      ### 以 /api-b/
      path: /api-b/**
      serviceId: app-service-b

4.Zuul启动类

@EnableZuulProxy
@EnableEurekaClient
@SpringBootApplication
public class App {

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

5.A服务和B服务的Controller是这样的

A服务的getInfo：------------------------------------------
@RestController
public class ServiceController {

    @RequestMapping("/getInfo")
    public String getOrder() {
        return "我是A服务的getInfo";
    }
}

B服务的getInfo：------------------------------------------
@RestController
public class ServiceController {

    @RequestMapping("/getInfo")
    public String getOrder() {
        return "我是B服务的getInfo";
    }
}

5.启动Eureka注册中心服务、网关、A服务和B服务

6.通过网关访问A和B服务
访问A服务：http://localhost/api-a/getInfo

访问B服务：http://localhost/api-b/getInfo

2.2 使用Zuul过滤器

案例：使用过滤器验证客户端是否有登陆。

前面有讲解过，可以参考我写的文章：《基于Zuul实现API网关》，主要讲解下TokenFilter：

@Component
public class TokenFilter extends ZuulFilter {

	public Object run() throws ZuulException {
		// 获取上下文
		RequestContext currentContext = RequestContext.getCurrentContext();
		HttpServletRequest request = currentContext.getRequest();
		String userToken = request.getParameter("userToken");
		if (StringUtils.isEmpty(userToken)) {
			currentContext.setSendZuulResponse(false);
			currentContext.setResponseStatusCode(401);
			currentContext.setResponseBody("userToken is null");
			return null;
		}
		// 否则正常执行业务逻辑.....
		return null;
	}

	// 判断过滤器是否生效
	public boolean shouldFilter() {

		return true;
	}

	// 过滤器的执行顺序。当请求在一个阶段的时候存在多个多个过滤器时，需要根据该方法的返回值依次执行
	public int filterOrder() {

		return 0;
	}

	// 过滤器类型 pre 表示在 请求之前进行拦截
	public String filterType() {

		return "pre";
	}

}

浏览器输入： http://localhost/api-a/getInfo

需要携带token访问：http://localhost/api-a/getInfo?userToken=123

2.3 使用Zuul整合Ribbon

Zuul 默认开启了 Ribbon本地负载均衡功能。此处不再详述。
application.yml关键代码：

#Zuul整合Ribbon      
api-a:
  ribbon:
    listOfServers: http://localhost:8081,http://localhost:8082
ribbon:
  eureka:
    enabled: false

2.4 动态网关

传统方式将路由规则配置在配置文件中，如果路由规则发生了改变，需要重启服务器。这时候我们结合上一篇博客《SpringCloud- 分布式配置中心》内容整合SpringCloud Config分布式配置中心，实现动态路由规则。

1.在git上创建一个文件service-zuul-dev.yml

### 配置网关反向代理    
zuul:
  routes:
    api-a:
     ### 以 /api-a/访问转发到a服务
      path: /api-a/**
      serviceId: app-service-a
    api-b:
        ### 以 /api-b/访问转发到b服务
      path: /api-b/**
      serviceId: app-service-b

2.添加maven依赖

<!-- actuator监控中心 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!-- springcloud config 2.0 -->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-config-client</artifactId>
</dependency>

3.application.yml

###服务注册地址
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8100/eureka/
###api网关端口号      
server:
  port: 80
###网关名称  
spring:
  application:
    name: service-zuul
  cloud:
    config:
    ####读取后缀
      profile: dev
      ####读取config-server注册地址
      discovery:
        service-id: config-server
        enabled: true    

###默认服务读取eureka注册服务列表 默认间隔30秒

###开启所有监控中心接口
management:
  endpoints:
    web:
      exposure:
        include: "*"

4.项目启动类里面添加方法

// zuul配置能够使用config实现实时更新
@RefreshScope
@ConfigurationProperties("zuul")
public ZuulProperties zuulProperties() {
    return new ZuulProperties();
}

5.启动所有项目

6.验证配置文件：浏览器输入http://localhost:8888/service-zuul-dev.yml

7.访问A服务浏览器输入http://localhost/api-a/getInfo?userToken=123

可以看出能正常调用服务！

2.5 网关集群

Zuul网关集群使用Nginx反向代理即可，保证每台网关配置数据相同。

upstream  backServer{
    server 127.0.0.1:81;
    server 127.0.0.1:82;
}
   server {
       listen       80;
       server_name  wg.ylw.com;
      location / {
	    ### 指定上游服务器负载均衡服务器
	    proxy_pass http://backServer/;
           index  index.html index.htm;
       }
   }

3. 总结

代码已提交至Github，有兴趣的同学可以下载看看：https://github.com/ylw-github/SpringCloud-Zuul-Demo