Spring-Cloud 网关Zuul原理及示例

本文中的网关校验基于上篇博文 认证授权-Spring-Cloud Security。
网关的作用相当于一个过虑器、拦截器，它可以拦截多个系统的请求。本文主要使用网关校验用户的身份是否合法。

1. Zuul 介绍

1.1 什么是Zuul？

Spring Cloud Zuul是整合Netflix公司的Zuul开源项目实现的微服务网关，它实现了请求路由、负载均衡、校验过虑等 功能。官网：https://github.com/Netflix/zuul

1.2 什么是网关？

服务网关是在微服务前边设置一道屏障，请求先到服务网关，网关会对请求进行过虑、校验、路由等处理。有了服务网关可以提高微服务的安全性，网关校验请求的合法性，请求不合法将被拦截，拒绝访问。

1.3 Zuul与Nginx怎么配合使用？

Zuul与Nginx在实际项目中需要配合使用，如下图，Nginx的作用是反向代理、负载均衡，Zuul的作用是保障微服务的安全访问，拦截微服务请求，校验合法性及负载均衡。

2. 搭建网关工程

spring-cloud-zuul官网：https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.2.1.RELEASE/reference/html/#router-and-filter-zuul

2.1 创建一个微服务工程引入依赖

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>

2.2 添加注解

在启动类上使用@EnableZuulProxy注解标识此工程为Zuul网关，启动类代码如下：

package com.qqxhb.springcloud.gateway;

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

@SpringBootApplication
@EnableZuulProxy // 此工程是一个zuul网关
public class GatewayApplication {
   

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

2.3 配置路由

zuul:
  prefix: /api #一般暴露出的微服务都是接口，所以加一个统一的前缀
  ignored-services: * #一般启用zuul后会禁止服务名调用只能通过网关调用，*表示所有服务（建议），也可以配置具体某些服务
  routes:
    service-provider-course: #路由名称，名称任意，保持所有路由名称唯一
      path: /course/**	#/**代表是所有层级； /* 是代表一层；如果是/*的话/course/xxx/getCourse 就不会被路由
      serviceId: service-provider-course #微服务名称，网关会从eureka中获取该服务名称下的服务实例的地址
      #url: http://www.baidu.com #也可指定url，此url也可以是外网地址\
      strip-prefix: false #true：代理转发时去掉前缀，false:代理转发时不去掉前缀
      sensitiveHeaders:  #默认zuul会屏蔽cookie，cookie不会传到下游服务，这里设置为空则取消默认的黑名单，如果设置了具体的头信息则不会传到下游服务
      #   ignoredHeaders: 默认为空表示不过虑任何头
    service-provider-teacher: 
      path: /teacher/**
      serviceId: service-provider-teacher #指定服务id，从Eureka中找到服务的ip和端口
      strip-prefix: false #转发到具体微服务是否去掉前缀，默认true去掉
      sensitiveHeaders:

2.4 过虑器

Zuul的核心就是过虑器，通过过虑器实现请求过虑，身份校验等。在zuul中过滤器分为四种：

• PRE Filters(前置过滤器) ：当请求会路由转发到具体后端服务器前执行的过滤器，比如鉴权过滤器，日志过滤器，还有路由选择过滤器
• ROUTING Filters （路由过滤器）：该过滤器作用是把请求具体转发到后端服务器上，一般是通过Apache HttpClient 或者 Netflix Ribbon把请求发送到具体的后端服务器上
• POST Filters（后置过滤器）：当把请求路由到具体后端服务器后执行的过滤器；场景有添加标准http 响应头，收集一些统计数据（比如请求耗时等），写入请求结果到请求方等。
• ERROR Filters（错误过滤器）：当上面任何一个类型过滤器执行出错时候执行该过滤器

自定义过虑器需要继承 ZuulFilter，ZuulFilter是一个抽象类，需要覆盖它的四个方法，如下：

• shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true表示要执行此过虑器，否则不执行。
• run：过滤器的业务逻辑。
• filterType：返回字符串代表过滤器的类型
• filterOrder：此方法返回整型数值，通过此数值来定义过滤器的执行顺序，数字越小优先级越高。

package com.qqxhb.springcloud.gateway.filter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServ