Spring Cloud (五)：路由网关（Zuul）

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

注：服务A 与 服务B 同样可以互相调用，且配置服务也是注册到服务注册中心的。

在SpringCloud 微服务中，一种常见的负载均衡方式是：客户端的请求首先经过负载均衡（zuul、Nginx）–服务网关（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
• Static Response handling

二、准备工作
继续上一节的工程，在原有工程上创建一个新的工程。

三、创建一个 新工程 eureka-zuul 工程

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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.lbh</groupId>
        <artifactId>eurekademo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.lbh</groupId>
    <artifactId>eureka-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>

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

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            <version>2.0.0.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
            <version>2.0.0.RELEASE</version>
        </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>
        </repository>
    </repositories>

</project>

入口类中加入注解 @EnableZuulProxy, 开启zuul功能：

@EnableZuulProxy   // 开启zuul功能
@EnableEurekaClient
@EnableDiscoveryClient
@SpringBootApplication
public class EurekaZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaZuulApplication.class, args);
        System.out.println("==============eureka-zuul 启动成功=================");
    }

}

加上配置文件 application.yml ：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

server:
  port: 8769

spring:
  application:
    name: eureka-zuul

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: eureka-ribbon
    api-b:
      path: /api-b/**
      serviceId: eureka-feign

首先制定注册中心的地址为：http://localhost:8761/eureka/，服务名为 eureka-zuul，以 /api-a/ 的请求都转发给 eureka-ribbon，以 /api-b/ 的请求都转发给 eureka-feign。
依次运行五个工程，打开浏览器访问：http://localhost:8769/api-a/hi?name=lbh ,显示： hi lbh ,i am from port:8762
打开浏览器访问：http://localhost:8769/api-b/hi?name=zm ,显示： hi zm ,i am from port:8762
此时，zuul起到作用了。

四、服务过滤
zuul 不仅只是路由，还能过滤，做一些安全验证之类的。创建一个过滤器

package com.lbh.eurekazuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
* Created by Advancer on 2019/1/21 10:24.
* auth: lbh
*/

@Component
public class MyFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);

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

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

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

    @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 accountToken = request.getParameter("token");
        if (null == accountToken) {
            log.warn("token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        log.info("ok");
        return null;
    }
}

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

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

此时 访问：http://localhost:8769/api-a/hi?name=lbh : 显示 token is empty

访问：http://localhost:8769/api-a/hi?name=lbh&token=11 : 显示 hi lbh ,i am from port:8762

代码下载地址：

https://github.com/JavaAdvancer/eurekademo

文章参考资料：

https://www.fangzhipeng.com/springcloud/2018/08/30/sc-f5-zuul/