SpringCloud极简入门(九)API网关 Netflix Zuul

经过前面的学习,对于Spring Cloud Netflix 核心组件已经了解了一大半,我们已经可以根据这些组件构建一个简单的微服务系统，如图：

对于上面的图例你是否看出了什么问题呢？正常情况下为了保证对外服务的安全性,我们在服务接口上都会做一些权限校验,或者签名校验机制等，而我们的微服务理念把应用拆成了很多的服务,而这些服务都是需要做接口权限校验，那就意味着我们需要花很大的力气在每个服务接口上都去写一条权限校验的代码,这种方式肯定是不合理的。再者说如果我们服务过多的情况下，对于服务接口调用规则，服务列表等维护工作也会变得复杂，基于这些问题，API 网关(路由网关)的概念应运而生。

一. API网关：Spring Cloud Netflix Zuul

API网关就像整个系统的门面一样,所有的外部访问都经过它实现调度,过滤,请求路由,负载均衡,校验等等，在SpringCloud为我们提供了基于Netflix Zuul实现的API网关组件——Spring Cloud Netflix Zuul，加入网关API后的服务架构如图：

二.实现API网关

1.搭建项目ZuulServer
pom.xml核心依赖
```
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.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>Finchley.M9</spring-cloud.version>
</properties>

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

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

>2.找到主程序类，打上@EnableZuulServer标签开启zuul功能

//@EnableZuulServer ：开启路由网关功能
@SpringBootApplication
@EnableZuulProxy
public class ServiceZuulApplication {

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

}

>3.添加配置文件 application.yml

eureka:
client:
serviceUrl:
defaultZone: http://localhost:1111/eureka/ #注册中心地址
server:
port: 1113 //当前zuul服务端口
spring:
application:
name: service-zuul #服务名
zuul:
routes: #配置路由
api-a:
path: /api-a/
serviceId: consumer1 #api-a 开头的请求跳转到 consumer1服务
api-b:
path: /api-b/
serviceId: consumer2 #api-b 开头的请求跳转到 consumer2服务

>4.依次启动 EurekaServer,ZuulServer,Producer,Consumer 访问：http://localhost:1113/api-a/consumer?name=haha ，你将会看到 “haha:你好呀这里是Producer服务” ，说明我们的请求由ZuulServer转发给了服务 consumer1，而服务consumer1通过调用 Producer服务返回 “haha:你好呀这里是Producer服务” 内容。

#### 三.服务过滤
>Netflix Zuul功能很强大,上面我们只是演示了他的路由功能，我们接下来玩一下过滤功能，对于服务接口的请求我们要求带上相应的验证信息

>1.定义类 MyFilter 继承 ZuulFilter,实现请求过滤

/
服务过滤
*/
@Component
public class MyFilter extends ZuulFilter {
/
返回过滤器的类型，过滤器类型如下：
pre：请求路由之前调用过滤
routing：请求routing之时调用过滤
post： 请求路由之后调用过滤
error：发送错误时调用过滤
*/
@Override
public String filterType() {
return “pre”;
}

//filterOrder：过滤的顺序
@Override
public int filterOrder() {
    return 0;
}

//shouldFilter：是否要过滤，true表示永远过滤。
@Override
public boolean shouldFilter() {
    return true;
}

//过滤逻辑可以在该方法中处理有没有权限访问等
@Override
public Object run() {
    //获取请求对象
    RequestContext ctx = RequestContext.getCurrentContext();
    Object pass = ctx.getRequest().getParameter("pass");
    if(pass == null) {
        ctx.setSendZuulResponse(false);
        ctx.setResponseStatusCode(401);
        try {
            ctx.getResponse().getWriter().write("pass is empty");
        }catch (Exception e){}
    }
    return null;
}

}
```

2.重启 ZuulServer 服务，访问： http://localhost:1113/api-a/consumer?name=haha 你会看到 “pass is empty” ，因为我们的请求中是没有带入 pass，那说明我们的请求过滤成功，重新访问： http://localhost:1113/api-a/consumer?name=haha&pass=111 成功的看到“haha:你好呀这里是Producer服务” 。