springcloud（三）网关zuul

zuul介绍

zuul：网关，用于分布式架构，提供了权限、限流、路由、监控等功能，同时还能对简化前端对后端的请求，为什么这么说呢？这里就是zuul路由的功劳，在如今分布式横行的时代，一个前端可能对应着即使或者上百个后端服务，如果不使用网关或者ngxin，那么前端将要记住几十或者上百的域名，这样如果域名发生变化，维护就会变得很糟糕，那使用网关之后有什么不同呢？前端只需要和网关做交互，网关负责做路由转发，这样，前端只需要维护一个域名，后端也会轻松很多，到这里可能有疑问了，nginx同样能实现，为什么不选用nginx而选用网关呢？nginx是需要在配置文件中配置多个location来指定跳转的，二网关不同，网关既可以通过别名跳转，同时也支持服务名跳转，什么意思？你的请求路径只要匹配到服务名，就可以省略一大堆的配置，而且zuul市java编写的，集成更好。

搭建注册中心

eureka：springcloud（一）注册中心eureka

搭建配置中心

cloud-config：springcloud（二）配置中心config

搭建zuul

1.新建springcloud工程

2.pom.xml引入依赖

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <!--连接配置中心所需要的依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>

        <!--eureka客户端-->
        <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>
        </dependency>

3.编写配置文件bootstrap.yml

server:
  port: 8400
spring:
  application:
    name: cloud-zuul
  cloud:
    config:
      discovery:
        enabled: true   #如果希通过在配置中心找服务名的方式招待配置中心，那么这个属性就要设置成 true  默认false
        service-id: cloud-config #配置中心的服务名
      fail-fast: true   #将这个设置成true 表示连接配置中心失败，让程序启动失败
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/ #注册中心地址
zuul:
  routes: #路由
    user:  #随意命名，用于区分多个路由的唯一标识
      path: /user/**   #需要被转发的规则
      serviceId: cloud-user   #需要被转发的服务名称
    order:
      path: /order/**
      serviceId: cloud-order

这里我配置了cloud.config，但是我在git上面并没有新建zuul服务的配置文件，因为到目前没有使用到配置文件，但是后续很顶会用到，所以在这里配置了，如果你不需要这一段，可以删除，同时移除spring-cloud-starter-config的依赖。

需要注意的就是下面这段代码：

路由的转发由这里完成，如果不配置，zuul也能做转发，但是路径就有限制，必须是ip（zuul）+端口（zuul）+服务名+uri，例如：127.0.0.1:8400/cloud-user/test,这样也是可以访问的。

4.编辑启动类

package com.ymy;

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

@SpringBootApplication
@EnableZuulProxy 
@EnableDiscoveryClient
public class CloudZuulApplication {

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

}

@SpringBootApplication：springboot启动注解
@EnableZuulProxy：开启zuul网关注解
@EnableDiscoveryClient：将zuul网关注册到注册中心

启动cloud-eureka、cloud-config、cloud-user、cloud-order

访问：localhost:8400/user/test:

访问：localhost:8400/order/test:

这就已经说明请求已经被网关转发到各自的服务。

ZuulFilter

ZuulFilter是什么？它主要负责路由、权限校验等等。

新建MyFilter：

package com.ymy.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 lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

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

@Component
@Slf4j
public class MyFilter extends ZuulFilter {

    private static final RateLimiter RATE_LIMITER = RateLimiter.create(1);
    @Override
    public String filterType() {
        return PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        return SIMPLE_HOST_ROUTING_FILTER_ORDER -1;
    }

    /**
     * 判断哪些请求需要校验，哪些请求直接放行
     * true：需要校验    false：直接放行
     * @return
     */
    @Override
    public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        //我这里模拟一下   请求uri携带nofilter的直接放行  否者需要校验
        if( ctx.getRequest().getRequestURI().indexOf("nofilter") != -1){
            //放行
            return false;
        }
        //进入run方法进行校验
        return true;
    }


    /**
     * 执行校验的方法
     * 返回null表示放行
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {

        log.info("校验开始==========>");
        RequestContext ctx = RequestContext.getCurrentContext();
        boolean flag = RATE_LIMITER.tryAcquire();
        if(!flag){
            ctx.setSendZuulResponse(false);// 过滤该请求，不对其进行路由
            ctx.setResponseStatusCode(401);// 返回错误码
            ctx.getResponse().setHeader("Content-Type", "application/json;charset=UTF-8");
            ctx.setResponseBody("{\"result\":\"请求过于频繁!\"}");// 返回错误内容
            ctx.set("isSuccess", false);
            return null;
        }
        log.info("放行=========>");
        return null;
    }
}

RateLimiter：令牌
RateLimiter.create(1)：表示一秒钟创建一个令牌
RATE_LIMITER.tryAcquire()：返回当前的请求数是否超过了令牌的数量，如果一秒钟请求>=两次，那么返回false,否者返回true
filterType：按类型对筛选器进行分类。Zuul中的标准类型是用于预路由筛选的“pre”，“路由”用于路由到源，“post”用于路由后过滤器，“error”用于错误处理，也支持静态响应的“静态”类型
filterOrder：优先级，数字越小，优先级越高 
shouldFilter：是否需要进行校验（如认证）  false：不需要校验，直接放行；true：需要校验，进入run()
run:具体的校验逻辑
测试：