SpringCloud 第三篇：路由网关 zuul

转载请标明出处：
http://blog.csdn.net/forezp/article/details/69939114
本文出自方志朋的博客

最新版本：
史上最简单的SpringCloud教程 | 第五篇: 路由网关(zuul)(Finchley版本)

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。一个简答的微服务系统如下图：

SpringCloud 第三篇：路由网关 zuul
注意：A服务和B服务是可以相互调用的，作图的时候忘记了。并且配置服务也是注册到服务注册中心的。

在Spring Cloud微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服。，服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理（下一篇文章讲述），配置服务的配置文件放在git仓库，方便开发人员随时改配置。

一、Zuul简介

Zuul的主要功能是路由转发和过滤器。路由功能是微服务的一部分，比如／api/user转发到到user服务，/api/shop转发到到shop服务。zuul默认和Ribbon结合实现了负载均衡的功能。

zuul有以下功能：

Authentication
Insights
Stress Testing
Canary Testing
Dynamic Routing
Service Migration
Load Shedding
Security
Static Response handling
Active/Active traffic management

二、准备工作

继续使用上一节的工程。在原有的工程上，创建一个新的工程。

三、创建service-zuul工程

3.1、其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>com.example</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>service-zuul</name>
   <description>Spring Cloud 路由网关</description>

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

   <dependencies>
      <!--zuul 路由网关-->
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-zuul</artifactId>
      </dependency>
      <!--eureka-->
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-eureka</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.2、在启动类加上注解 @EnableZuulProxy：

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy//开启路由网关代理
public class ServiceZuulApplication {

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

3.3、加上配置文件application.yml加上以下的配置代码：

server.port=8765
# 服务名称
spring.application.name=service-zuul
# 指定注册中心
eureka.client.service-url.default-zone=http://localhost:8761/eureka/
# zuul的服务分发-指定了服务在注册中心的id
zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId=service-ribbon
# 解决超时问题
ribbon.ReadTimeout=60000
ribbon.ConnectTimeout=60000

首先指定服务注册中心的地址为http://localhost:8761/eureka/，服务的端口为8765，服务名为service-zuul；以/api-a/ 开头的请求都转发给service-ribbon服务；

访问：http://localhost:8769/api-a/hi?name=cuicui ，显示：

hi cuicui,你访问的服务端口是:8762

这说明zuul起到了路由的作用

四、服务过滤

zuul不仅只是路由，并且还能过滤，做一些安全验证。继续改造工程；

/**
 * zuul:
 * 1、自定义过滤器，继承ZuulFilter。实现了过滤的逻辑。
 * 2、在配置文件中，指定了对 /api-a 请求的服务转发。
 * 实现效果：先过滤请求中是否带token，带token的转发，不带的被拦截。
 */
@Component
public class MyFilter extends ZuulFilter{

    private Logger log = LoggerFactory.getLogger(this.getClass());

    /**
     * 路由器类型:pre-路由之前,routing-路由之时，post-路由之后，error-错误时调用
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

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

    @Override
    public boolean shouldFilter() {//是否要过滤
        return true;
    }

    //过滤的逻辑,可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。
    @Override
    public Object run() throws ZuulException {
        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;
    }
}

重启项目，然后：

访问：http://localhost:8765/api-a/hi?name=cuicui ；

token is empty

访问 http://localhost:8765/api-a/hi?name=cuicui&token=22 ；

hi cuicui,你访问的服务端口是:8762

本文源码下载：
https://github.com/forezp/SpringCloudLearning/tree/master/chapter5