SpringCloud网关Zuul

网关有点类似于java程序设计中的Filter，即进入服务之前把门的这么一个角色。它可以通过一个映射来决定是否将这个请求放到真正要请求的微服务地址中去，在这个过程中还可以加入一些可插拔的功能的扩展（必要的校验、控制），都可以在Zuul中去进行编写。zuul网关是整个微服务的周边，对请求进行过滤。

一、基础准备

eureka注册中心
服务提供者
服务消费者

二、创建项目

创建一个spring项目，在选择相关依赖的时候，选择Spring Cloud Routing下面的zuul网关

zuul

创建成功之后需要更换版本，因为最新版本会有一些兼容的问题，而我的其他项目都是用的boot1.5.6版本，所以：

pom文件.png

可以看到将原来系统自动生成的zuul的依赖拆成了两个

三、相关设置

1.yml文件

spring:
  application:
    name: dm-gateway-zuul
server:
  port: 7600
eureka:
  client:
    service-url:
      defaultZone: http://root:123456@localhost:7776/eureka/
zuul:
  routes:
    dm-user-consumer: /user/**
#      dm-xxxx-consumer: /xxxx/**

之前说过zuul网关类似于一个过滤器，所以在yml文件中我们在routes下面，设置对于某个consumer，要对其什么路径进行配置起作用，也相当于一个interceptor吧~

2.启动类

在启动类上，我们需要加入一个注解@EnableZuulProxy

四、测试

1.consumer

首先我在consumer中定义了这么一个接口：

@RestController
public class LoginController {

    @Autowired
    private UserFeignClient userFeignClient;

    @PostMapping("/userlogin")
    public String login(@RequestBody UserLoginInfo userLoginInfo){
        for (int i  = 0;i < 5;i++ ){
            userFeignClient.login(userLoginInfo);
        }
        return "负载均衡demo";
    }
}

注：我在consumer中的端口是8076

2.postman

在postman中我们就不能直接去访问userlogin这个接口了，不然就不会走zuul网关，因为我在zuul中定义了一个/user/**的路由配置，所以我们如果想要在zuul项目走consumer的userlogin请求，需要在其接口前面加“/user”即

postman测试

（7600是我zuul的端口）

四、小结

通过一个简单的测试我们只是引入了zuul，但是并不能直观地看到zuul的作用，其实zuul的作用是在请求服务调用之前做一个过滤器的作用，我们来看一下

过滤器的分类和特点

按照过滤器执行的时间点可以分为以下几种：

pre：从zuul到consumer接口的第一层过滤器，最开始执行的那个过滤器。
route：pre执行过程中会真正执行consumer的接口，然后consumer接口调用完之后会给route过滤器返回一个响应
post：在route执行完毕之后会进入到post过滤器，如果post执行完了就会将响应结果返回给客户端浏览器。
error：在整个执行过程中只要出现了错误便会进入到error这个过滤器中，有点像try...catch的感觉。但是有这样一点：error走完之后还是会进入到post中去，即在error处理完的后面还可以安排另一个post处理

过滤器

在filterConstans中我们也可以看到这四个过滤器

filterConstans

五、新建Filter

package com.tinner.dmgatewayzuul.filters;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

/**
 * @Author Tinner
 * @create 2019/7/30 17:14
 */
@Component
public class PreFilter extends ZuulFilter {
    @Override
    public String filterType() {
        //过滤器类型
        return FilterConstants.PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        //同类型的过滤器，数字越小，优先级越高
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        //希望这个过滤器发挥作用就设置为true，不希望发挥作用就设置为false
        return true;
    }

    @Override
    public Object run() {
        RequestContext context = RequestContext.getCurrentContext();
        HttpServletRequest request = context.getRequest();
        String token = request.getHeader("authorization");
        if (token != null ){
            //登录过
            return "过！";
        }else{
            //无效
            //告诉后面的过滤器，在当前就已经出问题了，没必要去进行路由转发了
            context.setSendZuulResponse(false);
            context.setResponseStatusCode(401);
            context.setResponseBody("{\"msg\":\"401,access without permission,please login first.\"}");
            return "access denied";
        }
    }
}

需要注意的几点：

在定义过滤器的时候，需要将其设置为spring的组件，所以必须要加注解@Component
需要继承ZuulFilter类来实现其方法（一共四个）
ZuulFilter，返回一个过滤器的类型，即我在上面列出来的四种过滤器类型
filterOrder，设置过滤器执行顺序，同类型的过滤器，数字越小，优先级越高
shouldFilter，设置一个布尔值，希望这个过滤器发挥作用就设置为true，不希望发挥作用就设置为false
run，此过滤器具体执行什么操作，返回一个Object，其实在框架中不会看你具体返回什么，所以返回null即可。
RequestContext是核心类，用于获取request对象以及设置响应结果，其中有一个方法setSendZuulResponse为通知其后面即将执行的过滤器要不要执行下去。它是过滤器执行中非常重要的一个类，可以负责过滤器之间的通信。他是基于hasmap的，因为它集成了ConcurrentHashMap

六、测试过滤器

postman

在图中可以看到，我在header中并没有加"authorization"，他会先让我去进行登录
然后我在header中加入token相关信息测试：

header中加入token

七、彩蛋

在配置文件中可以对过滤器的开关进行设置：
在zuul大节点下面，写出你想操作的过滤器名称，对应它的类型，然后设置是否执行

关闭second过滤器