Spring Cloud Learning | 第九篇：API网关服务(Zuul)

一. 简介

      通过前面几篇文章的介绍，我们已经学习了怎么使用微服务架构中最为基础的几个核心模块。其实，利用这些模块，我们已经能够构建起下面的简单的微服务架构系统：

      在上面的架构中，我们的服务集群包括内部服务ServiceA和ServiceB，它们都会向Eureka Server集群进行注册与订阅服务，而Open-Service是一个对外的RESTful API服务，它通过F5、Nginx等工具实现对各个微服务的路由与负载均衡，并公开给外部的客户端调用。

      上面的架构实现系统功能是完全没有问题的，但是，这样的架构也有多个不足的地方。首先从运维方面上看，当系统规模变大或变小，微服务实例会随着增加或减少，或者当服务实例IP地址改变时，运维人员需要手动修改路由规则，同步修改配置信息，这样显然是不可取的，所以我们需要一套机制来有效降低维护路由规则与服务实例列表的难度。

      其次，从开发角度上看，在大多数情况下，为了保证对外服务的安全性，我们在服务端实现的微服务接口，往往都会有一定的权限校验机制，比如对用户登录状态的校验等，或者有其他的一些签名校验等。由于在微服务架构下，我们把原本处于一个应用中的多个模块拆分为多个应用，但是这些应用提供的接口都需要这些校验逻辑，我们不得不在这些应用中都实现这样的一套校验逻辑。这些校验逻辑一旦需要修改，我们都需要去修改每个应用的这些冗余校验。因此我们也需要一套机制能够很好地解决微服务架构中，对于微服务接口访问时各前置校验的冗余问题。

      为了解决上面的这些常见的架构问题，API网关就应运而生。API网关就像是整个微服务架构系统的门面，所有的外部客户端访问都需要经过它来进行调度和过滤。它除了要实现请求路由、负载均衡、校验过滤等功能外，还需要更多能力，比如与服务治理框架的结合、请求转发时的熔断机制、服务的聚合等一系列高级功能。

      Spring Cloud为我们提供了基于Netflix Zuul实现的API网关组件--Spring Cloud Zuul。使用了API网关后，整体的架构变成如下图所示：

      接下来我们来学习实践Zuul。

二. 快速入门

2.1 准备工作

      首先准备前面文章中的eureka-server、eureka-client、service-ribbon、service-feign项目。

2.2 构建网关

      首先新建一个基础的Spring Boot工程，命名为service-zuul，并在pom.xml中引入spring-cloud-starter-zuul等依赖：

<?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.dan</groupId>
	<artifactId>service-zuul</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>service-zuul</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>Dalston.SR4</spring-cloud.version>
	</properties>

	<dependencies>

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

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</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>

      在启动类上加上@EnableZuulProxy注解开启Zuul的API网关服务功能：

@EnableZuulProxy
@SpringBootApplication
public class ServiceZuulApplication {

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

      接着配置applica.properties文件：

spring.application.name=service-zuul
eureka.client.serviceUrl.defaultZone=http://localhost:8761/eureka
server.port=8769

zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.service-id=service-ribbon

zuul.routes.api-b.path=/api-b/**
zuul.routes.api-b.service-id=service-feign

      上面的配置首先指定服务注册中心地址、服务名和端口号，然后定义路由规则，即以/api-a/ 开头的请求都转发给service-ribbon服务，以/api-b/开头的请求都转发给service-feign服务。

      运行这五个工程，访问http://localhost:8769/api-a/hello?name=Jack和http://localhost:8769/api-b/hello?name=Jack都能看到：

Hello Jack. I am from port:8762

证明Zuul已经起到路由的功能。

三. 请求过滤

      在上面我们提到API网关除了有路由功能，还有过滤请求的功能。

      下面我们来实现一个简单的Zuul过滤器，它实现了在请求被路由之前检查HttpServletRequest中是否有accessToken参数，若有就进行路由，若没有就拒绝访问，返回401 Unauthorized错误。

      在service-zuul工程上新建过滤类AccessFilter，需要继承ZuulFilter：

@Component
public class AccessFilter extends ZuulFilter {
	
	private static Logger log = Logger.getLogger(AccessFilter.class);
	
	/*
	* filterType: 过滤器的类型，它决定过滤器在请求的哪个生命周期中执行。
	* pre：路由之前 routing：路由之时 post：路由之后 error：发送错误调用
	*/
	@Override
	public String filterType() {
		return "pre";
	}
	
	/*
	* filterOrder：过滤器的执行顺序。当请求在一个阶段中存在多个过滤器时，需要根据该方法返回的值来一次执行。
	*/
	@Override
	public int filterOrder() {
		return 0;
	}
	
	/*
	* shouldFilter：判断该过滤器是否需要被执行。
	* 这里可以写逻辑判断，是否要过滤，这里true, 永远过滤。
	*/
	@Override
	public boolean shouldFilter() {
		return true;
	}

	/*
	* run：过滤器的具体逻辑。可以很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。
	*/
	@Override
	public Object run() {
		RequestContext ctx = RequestContext.getCurrentContext();
		HttpServletRequest request = ctx.getRequest();
		log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
		Object accessToken = request.getParameter("token");
		if (accessToken == null) {
			log.warn("token is empty");
			ctx.setSendZuulResponse(false);
			ctx.setResponseStatusCode(401);
			try {
				ctx.getResponse().getWriter().write("token is empty");
			} catch (Exception e) {
			}

			return null;
		}
		log.info("ok");
		return null;
	}

}

      需要注意的是要在AccessFilter上加上@Component注解，或者在启动类中创建具体的Bean才能启动过滤器。

      启动工程，访问http://localhost:8769/api-b/hello?name=Jack，看到：

token is empty

      访问http://localhost:8769/api-a/hello?name=Jack&token=hhh才能看到正确结果：

Hello Jack. I am from port:8762

      源码下载：https://github.com/lingd3/SpringCloudLearning/tree/master/chapter9