Spring Boot+Spring Cloud基础入门（六）路由网关——Zuul

网关

---

微服务架构中，会存在多个服务，每个服务拥有不同的地址，用户在请求一个业务时，可能会执行多次请求，这时候，就需要我们的网关来进行转发了。网关是位于请求发起后，访问服务前的中间层，所有的访问，都需要先经过网关，比如在用户访问api时，请求链接为/login，则将其转发到login服务，请求链接为/shop，则将其转发到shop服务。

---

Zuul

zuul 是netflix开源的一个API Gateway 服务器, 本质上是一个web servlet应用，Zuul的主要功能是路由转发和过滤器。

Zuul 在云平台上提供动态路由，监控，弹性，安全等边缘服务的框架。将整个项目比喻为一个大房子，那么Zuul 相当于是设备和 Netflix 流应用的 Web 网站后端所有请求的门童，由它来引导请求进入他们要求的房间。

---

搭建项目

在项目中，新建Module，引入Zuul和Eureka，新建好的文件的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>

    <groupId>cn.ponytech</groupId>
    <artifactId>zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>zuul</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.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.RELEASE</spring-cloud.version>
    </properties>

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


</project>

在入口类中，加入@EnableZuulProxy、@EnableEurekaClient注解，开启Zuul和Eureka

@SpringBootApplication
@EnableZuulProxy
@EnableEurekaClient
public class ZuulApplication {

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

在properties文件中，指定端口号等信息，将网址中带有/ribbon的请求转发到ribbon服务中，将网址中带有/feign的请求转发到feign服务中。

server.port=9005
eureka.client.service-url.defaultZone= http://localhost:9000/eureka/
spring.application.name=zuul
zuul.routes.ribbon.path=/ribbon/**
zuul.routes.ribbon.service-id=ribbon
zuul.routes.feign.path=/feign/**
zuul.routes.feign.service-id=feign

依次启动5个项目，访问http://localhost:9005/ribbon/welcome?name=Cheng，出现：

Cheng 欢迎您，这里有一些话想对你说: Hey! This is Spring Cloud

访问 http://localhost:9005/feign/welcome?name=Cheng ，出现：

Cheng 欢迎您，这里有一些话想对你说: Hey! This is Spring Cloud

说明Zuul的两个转发都成功了，起到了路由的作用。

---

服务过滤

Zuul还有一个主要的功能，便是服务过滤，比如，用户在登录前，可以将服务请求过滤到指定的页面去。
在项目中，新增一个MyFilter类。代码如下：

@Component
public class MyFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run(){
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().setHeader("Content-Type", "text/html;charset=UTF-8");
                ctx.getResponse().getWriter().write("登录信息为空！");
            }catch (Exception e){}
            return null;
        }
        return null;
    }
}

其中，filterType方法，返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：

pre：路由之前
routing：路由之时
post： 路由之后
error：发送错误调用
filterOrder：过滤的顺序
shouldFilter：这里可以写逻辑判断，是否要开启过滤
run：过滤器的具体逻辑。可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。

一般我们在使用时，不手打“pre”这些类型，而是通过调用Zuul中已写好的FilterConstants类，其中封装了所有的过滤器类型。这样可以避免打错字符而导致错误的发生。
接下来，我们访问http://localhost:9005/feign/welcome?name=Cheng 显示：

登录信息为空！

在后面加上token，http://localhost:9005/feign/welcome?name=Cheng&token=111，显示：

Cheng 欢迎您，这里有一些话想对你说: Hey! This is Spring Cloud

这样就证明，我们的过滤器起作用了。