Spring Cloud笔记-Zuul路由网关（十一）

第二季原视频里，并没有讲解Zuul的用法，于是，就从其他地方（尚硅谷Spring Cloud第一季和千锋教育Spring Cloud）找了找资源，学习一下。

1.概述简介

Zuul包含了对请求的路由和过滤两个最主要的功能。其中路由功能负责将外部请求转发到具体的微服务实例上，是实现外部访问统一入口的基础，过滤器功能则负责对请求的处理过程进行干预，是实现请求校验、服务聚合等功能的基础。Zuul和Eureka进行整合，将Zuul自身注册为Eureka服务治理下的应用，同时还可以从Eureka中获取其他微服务的消息，以后访问微服务都是通过Zuul跳转后获得的。

注意：Zuul服务最终还是会注册进Eureka，提供代理、路由、过滤三大功能。

Zuul在GitHub上的资料：https://github.com/Netflix/zuul/wiki

2.路由基本配置

新建cloud-gateway-zuul5555模块，修改pom.xml，这里加入Zuul、Eureka、Hystrix的坐标。

<?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">
    <parent>
        <artifactId>cloud2020</artifactId>
        <groupId>com.atguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>cloud-geteway-zuul5555</artifactId>
    <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>
            <version>2.0.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</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-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

添加application.yml配置文件。

server:
  port: 5555
spring:
  application:
    name: cloud-gateway-zuul
eureka:
  client:
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/
  instance:
    instance-id: gateway-zuul-5555 # 指定服务实例ID
    prefer-ip-address: true # 访问路径可以显示IP地址

 添加主启动类。

package com.atguigu.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

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

启动Eureka注册中心，Provider服务生产者，Zuul路由网关模块。

通过浏览器访问http://localhost:8001/payment/hystrix/ok/1，此时可以拿到正确的结果，此时是直接访问，我们尝试访问http://localhost:5555/cloud-provider-hystrix-payment/payment/hystrix/ok/1，发现也可以拿到正确的结果。

我们来分析这个请求地址，其中localhost:5555是网关，cloud-provider-hystrix-payment是注册进Eureka中的其他服务的服务名称，它的名称在Provider模块的application.yml里有配置，即spring.application.name的值，/payment/hystrix/ok/1为请求量路径，我们通过网关地址+服务名称+请求路径，就可以通过Zuul网关访问注册进Eureka中的其他服务了。

3.路由访问映射规则

这里的服务名称，是直接暴露出来的，有时，我们并不希望直接暴露服务名称，有没有办法解决这个问题呢？

找到Zuul模块，在application.yml里，添加如下内容，做一个服务名称的路由映射规则。

zuul:
  routes:
    serviceTempName.serviceId: cloud-provider-hystrix-payment
    serviceTempName.path: /provider8001/**
  ignored-services: cloud-provider-hystrix-payment
  prefix: /atguigu

这段配置的serviceTempName是随便取的，相当于给的当前服务临时起一个名称，serviceId的值就是注册进Eureka的真实服务名称，path是虚拟路径，表示通过浏览器访问/provider8001/**的所有请求，实际都发给了cloud-provider-hystrix-payment这个服务名。

prefix可以给经过Zuul的请求加一个访问前缀，即服务名称前面需要带上这个前缀才能正确访问到资源。我们必须在provider8001前加一个/atguigu才能正常访问，如果没有，肯定是报错的。

我们发送一个请求http://localhost:5555/atguigu/provider8001/payment/hystrix/ok/1，可以正常获取到结果，映射规则生效。

这里的ignored-services的作用是将原服务名进行隐藏，如果不隐藏的话，provider8001和cloud-provider-hystrix-payment都可以访问到，没有彻底解决之前的问题，所以，在做服务名称映射的时候，通常将原始名称给隐藏起来。如果这里有多个微服务原始名称需要隐藏，只需要把ignored-services的值改成"*"即可。

4.查看路由信息

在application.yml中加入如下信息，将actuator的routes和filters信息暴露出来方便查看。

# 默认情况下，actuator只会暴露health和info，让actuator暴露出routes, filters端点
management:
  endpoints:
    web:
      exposure:
        include: routes, filters

浏览器访问http://localhost:5555/actuator/routes可以查看到路由信息，访问http://localhost:5555/actuator/filters可以查看到过滤器信息。

5.过滤器

创建MyZuulFilter，继承ZuulFilter，实现对应的方法，并把MyZuulFilter加到容器中。

package com.atguigu.springcloud.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;

import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.ROUTE_TYPE;

@Component
public class MyZuulFilter extends ZuulFilter {
    /**
     * ERROR_TYPE:出现错误时候执行
     * POST_TYPE:在ROUTE或ERROR执行之后执行
     * PRE_TYPE:在代理执行之前执行
     * ROUTE_TYPE:在代理执行的时候执行
     */
    @Override
    public String filterType() {
        return ROUTE_TYPE;
    }

    /**
     * 如果定义了多个同类型的ZuulFilter，根据filterOrder()方法的返回值，确定执行先后顺序
     * 返回值越小，优先级越高，越先执行
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * true:开启过滤器
     * false:不开启过滤器
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器执行什么操作
     */
    @Override
    public Object run() throws ZuulException {
        System.out.println("MyZuulFilterConfig.run");
        return null;
    }
}

通过浏览器访问http://localhost:5555/atguigu/provider8001/payment/hystrix/ok/1，在控制台看到有输出，表明run()方法执行了。