SpringCloud微服务（学习笔记）：网关 Zuul

测试用项目环境

框架	版本
Idea	2019.2
JDK	1.8
SpringBoot	2.1.6.RELEASE
SpringCloud	Greenwich.SR2

网关

为服务调用封装统一接口，可以在网关层实现登陆鉴权，权限校验，限流等，降低服务压力

Zuul

Zuul网关开发

maven依赖

使用maven依赖管理，使用最新的springcloud Greenwich.SR2版本

<dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>Greenwich.SR2</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
</dependencyManagement>

网关同样需要注册到注册中心去所以需要eureka依赖

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

zuul网关依赖

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

启动类注解

@EnableZuulProxy

网关配置

路由

zuul:
  routes:
  	# 此处配置在注册中心注册的服务名
  	# 将test-service的api接口代理在 /api/v1.0/test/ 下
  	# 现在访问服务的方式是访问网关所在ip端口后加上/api/v1.0/test/ 再加上原来的api接口
    test-service: /api/v1.0/test/**
  # 即无法从外网直接访问忽略服务的所有接口
  ignored-services:
    - data-service
#  ignored-patterns:  正则表达式忽略匹配

请求头配置

zuul网关默认配置了过滤的请求头，即一次请求在通过网关时，请求头中的某些字段会被过滤，服务中便获取不到这些head
在网关的配置类：org.springframework.cloud.netflix.zuul.filters.ZuulProperties中能够看到默认过滤的请求头

解决方案
手动配置这个过滤集合：

zuul:
  # 此处可以不配置任何值，便会将Zuul的这个属性置唯空，表示不过滤任何请求头
  sensitive-headers:

进阶

zuul网关本质是一系列的过滤器
有点类似于SpringSecurity
因此可以编写自己Filter实现在网关层进行登陆鉴权等功能

编写过滤器实现网关鉴权

写一个LoginFilter继承ZuulFilter并交给Spring管理，实现抽象方法

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.PRE_TYPE;
@Component
public class LoginFilter extends ZuulFilter {
	/**
     * 过滤器类型，前置，后置，等
     * @return
     */
    @Override
    public String filterType() {
        return PRE_TYPE;
    }

    /**
     * 过滤器顺序
     * order越小越先执行
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 是否生效
     * 某些请求不需要经过这个过滤器
     * @return
     */
    @Override
    public boolean shouldFilter() {

		// 这个RequestContext是com.netflix.zuul.context包下的
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        System.out.println(request.getRequestURI());
        System.out.println(request.getRequestURL());
		// 请求筛选，返回true的请求才会执行下面的run方法
		// 此处如果工程体系过于庞大需要设计ACL，在redis中进行查询筛选
        if("/api/v1.0/anonymous/test/".equalsIgnoreCase(request.getRequestURI())){
            return true;
        }

        return false;
    }

    /**
     * 业务逻辑
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        // 执行业务逻辑校验
        // 直接返回null表示放行
        // 若不满足校验需求 设置sendZuulResponse为false
        if(false){
        	RequestContext currentContext = RequestContext.getCurrentContext();
        	// 设置返回
        	currentContext.setSendZuulResponse(false);
        	// 设置返回头
        	currentContext.setResponseStatusCode(HttpStatus.FORBIDDEN.value());
        }
        return null;
    }
}

ACL

访问控制列表（Access Control Lists,ACL）是应用在路由器接口的指令列表。这些指令列表用来告诉路由器哪些数据包可以收、哪些数据包需要拒绝。至于数据包是被接收还是拒绝，可以由类似于源地址、目的地址、端口号等的特定指示条件来决定。

网关层限流

编写限流Filter

import com.google.common.util.concurrent.RateLimiter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.PRE_TYPE;
@Component
public class OrderDateLimiterFilter extends ZuulFilter {

    // QPS
    // 每秒产生的令牌数
    private static final RateLimiter RATE_LIMITER = RateLimiter.create(1000);
	// 前置类型
    @Override
    public String filterType() {
        return PRE_TYPE;
    }
	// 最先执行
    @Override
    public int filterOrder() {
        return -4;
    }

    @Override
    public boolean shouldFilter() {
        // 所有服务都限流
        return true;
    }

    @Override
    public Object run() throws ZuulException {

        // 非阻塞获取令牌
        // 获取不到令牌返回false
        if(!RATE_LIMITER.tryAcquire()){ // 无令牌时进行限流处理
            RequestContext currentContext = RequestContext.getCurrentContext();
            currentContext.setSendZuulResponse(false);
            currentContext.setResponseStatusCode(HttpStatus.TOO_MANY_REQUESTS.value());
        }
        return null;
    }
}