一起学习使用Spring-Cloud-Netflix之Zuul

前言

Zuul 在 Spring Cloud 体系中扮演着统一网关的角色，负责与外部交互。用户可以通过不同的 URL 特征来访问不同的后端服务，类似于 Nginx 代理的效果。Zuul 与 Eureka 结合使用，可以根据服务名来访问后端的服务，对于 Eureka 而言，Zuul 也是一个 Eureka Client。系统的信息流入流出都需要经过 Zuul，在 Zuul 中，我们可以统一监控流量，统一安全认证，统一报文组装等等。

本文来源于我的博客网站：http://51think.net

一、Zuul 网关在本例中的架构

从图中可以看到，之前博客中提到的 srping-cloud-ribbon-client 应用以及 spring-cloud-eureka-myservice 应用都有参与。这两个应用和 spring-cloud-zuul 都属于 Eureka 的 client，因此都需要在 Eureka 中进行注册，否则无法相互调用。

二、创建 Zuul 应用

1、IDEA 创建 module，选择 Zuul

2、pom 文件中添加 web 组件以及 Eureka 组件

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>spring-cloud-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-cloud-zuul</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
      <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</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>

3、applicaton 类加上注解 @EnableZuulProxy 和 @EnableEurekaClient，开启 Zuul 功能

@EnableZuulProxy
@EnableEurekaClient
@SpringBootApplication
public class SpringCloudZuulApplication {public static void main(String[] args) {SpringApplication.run(SpringCloudZuulApplication.class, args);
    }

}

4、修改 application.yml 文件

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8010/eureka/
server:
  port: 8030
spring:
  application:
    name: cloudZuul
zuul:
  routes:
    ribbonClient:
      path: /ribbonClient/**
      serviceId: ribbonClient

其中 path: /ribbonClient/** 表示 URL 中如果带有 /ribbonClient/ 将被代理到 serviceId 为 ribbonClient 的服务中去。

三、启动观察

启动 spring-cloud-zuul 之后，访问 Eureka 面板，观察 cloudZuul 是否在服务列表中。

在之前的 ribbon 博客中，我们的访问地址是 http://localhost:8020/sayHello?say=helloWorld，现在我们通过 Zuul 来访问 spring-cloud-ribbon-client 应用，在浏览器中使用此地址进行访问：http://localhost:8030/ribbonClient/sayHello?say=helloWorld，可以发现访问效果和直接访问 http://localhost:8020/sayHello?say=helloWorld 的效果是一致的。

四、使用服务过滤

服务过滤就是一个 filter，它可以在指定事件中（路由前，路由中，路由后等）执行相关操作。Zuul 中提供了一个 filter 接口，实现它即可。

@Component
public class TokenFilter extends ZuulFilter {

        @Override
        public String filterType() {return "pre";}

        @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().getWriter().write("token is not exist!");
                }catch (Exception e){}

                return null;
            }
            return null;
    }
}

这段代码表示，如果请求中没有 token 信息，就会报错“token is not exist!”。关注 filterType 字段，它代表过滤器的类型，具体如下：
pre：路由之前会调用
route：路由转发的时候会调用
error：处理请求时发生错误时会调用
post：运行结束被调用

我们再次重启一下 spring-cloud-zuul，浏览器再次访问 http://localhost:8030/ribbonClient/sayHello?say=helloWorld，会发现如下错误提示：

加上 token 参数之后，即可正常访问：