011 SpringCloud 学习笔记7-----Zuul网关

1.Zuul网关概述

通过前面的学习，使用Spring Cloud实现微服务的架构基本成型，大致是这样的：

我们使用Spring Cloud Netflix中的Eureka实现了服务注册中心以及服务注册与发现；而服务间通过Ribbon或Feign实现服务的消费以及均衡负载。为了使得服务集群更为健壮，使用Hystrix的融断机制来避免在微服务架构中个别服务出现异常时引起的故障蔓延。

服务网关是微服务架构中一个不可或缺的部分。通过服务网关统一向外系统提供REST API的过程中，除了具备服务路由、均衡负载功能之外，它还具备了权限控制等功能。Spring Cloud Netflix中的Zuul就担任了这样的一个角色，为微服务架构提供了前门保护的作用，同时将权限控制这些较重的非业务逻辑内容迁移到服务路由层面，使得服务集群主体能够具备更高的可复用性和可测试性。

Zuul加入后的架构

2.入门案例

(1)新建模块：lucky-zuul

(2)修改配置文件application.yml

server:
  port: 10010 #服务端口
spring:
  application:
    name: service-zuul  #注册到eureka后的微服务的名称

(3)修改引导类

package lucky.zuul;

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

@SpringBootApplication
@EnableZuulProxy  //启用zuul组件
public class LuckyZuulApplication {

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

}

(4)编写路由规则

server:
  port: 10010 #服务端口
spring:
  application:
    name: service-zuul  #注册到eureka后的微服务的名称
zuul:
  routes:
    service-provider: # 这里是路由id，可以随意写，但习惯上写服务名称
      path: /service-provider/** # 这里是映射路径
      url: http://localhost:8081 # 映射路径对应的实际url地址

我们将符合path 规则的一切请求，都代理到 url参数指定的地址

(5)启动测试

访问的路径中需要加上配置规则的映射路径。

我们访问：http://localhost:10010/service-provider/users/queryUsersById?id=1

最后解析为：http://localhost:8081/users/queryUsersById?id=1

3.面向服务的路由

在入门案例的路由规则中，我们把路径对应的服务地址写死了！如果同一服务有多个实例的话，这样做显然就不合理了。我们应该根据服务的名称，去Eureka注册中心查找服务对应的所有实例列表，然后进行动态路由才对！

对lucky-zuul模块进行优化：

(1)添加Eureka客户端依赖

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

(2)在lucky-zuul模块的application.xml文件中添加Eureka配置，获取服务信息

server:
  port: 10010 #服务端口
spring:
  application:
    name: service-zuul  #注册到eureka后的微服务的名称
zuul:
  routes:
    service-provider: #这里是路由id，可以随意写，但习惯上写服务名称
      path: /service-provider/** # 映射路径
      url: http://localhost:8081 # 映射路径对应的实际url地址
eureka:
  client:
    registry-fetch-interval-seconds: 5 # 获取服务列表的周期：5s
    service-url:
      defaultZone: http://localhost:10086/eureka

(3)开启Eureka客户端发现功能

package lucky.zuul;

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  //启用zuul组件
@EnableDiscoveryClient
public class LuckyZuulApplication {

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

}

注意：以上3步是将lucky-zuul模块注册eureka注册中心中。

(4)修改映射配置，通过服务名称获取

因为已经将lucky-zuul配置成了Eureka客户端，我们就可以从Eureka获取服务的地址信息，因此映射时无需指定IP地址，而是通过服务名称来访问，而且Zuul已经集成了Ribbon的负载均衡功能。

server:
  port: 10010 #服务端口
spring:
  application:
    name: service-zuul  #注册到eureka后的微服务的名称
zuul:
  routes:
    service-provider: #这里是路由id，可以随意写，但习惯上写服务名称
      path: /service-provider/** # 映射路径
      serviceId: service-provider # 映射路径对应的服务名
eureka:
  client:
    registry-fetch-interval-seconds: 5 # 设置获取服务列表的周期为5s
    service-url:
      defaultZone: http://localhost:10086/eureka

(5)测试

再次启动，这次Zuul进行代理时，会利用Ribbon进行负载均衡访问：

4.过滤器

Zuul作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作我们往往是通过Zuul提供的过滤器来实现的。

(1)ZuulFilter

ZuulFilter是过滤器的顶级父类。在这里我们看一下其中定义的2个最重要的方法：

package com.netflix.zuul;

import com.netflix.zuul.exception.ZuulException;

public interface IZuulFilter {
    boolean shouldFilter();

    Object run() throws ZuulException;
}

shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true执行，返回false不执行。
run：过滤器的具体业务逻辑。

(2)过滤器执行生命周期

这张是Zuul官网提供的请求生命周期图，清晰的表现了一个请求在各个过滤器的执行顺序。

正常流程：
- 请求到达首先会经过pre类型过滤器，而后到达route类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。

异常流程：
- 整个过程中，pre或者route过滤器出现异常，都会直接进入error过滤器，在error处理完毕后，会将请求交给POST过滤器，最后返回给用户。
- 如果是error过滤器自己出现异常，最终也会进入POST过滤器，将最终结果返回给请求客户端。
- 如果是POST过滤器出现异常，会跳转到error过滤器，但是与pre和route不同的是，请求不会再到达POST过滤器了。

(3)使用场景

场景非常多：
- 请求鉴权：一般放在pre类型，如果发现没有访问权限，直接就拦截了
- 异常处理：一般会在error类型和post类型过滤器中结合来处理。
- 服务调用时长统计：pre和post结合使用。

(4)自定义过滤器

接下来我们来自定义一个过滤器，模拟一个登录的校验。基本逻辑：如果请求中有access-token参数，则认为请求有效，放行。

package lucky.zuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import io.micrometer.core.instrument.util.StringUtils;
import org.apache.http.HttpStatus;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

@Component  //将该类放入spring容器
public class LoginFilter extends ZuulFilter {

    /**
     * 过滤器的类型： pre、route、post、error
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**执行顺序：返回值越小，优先级越高
     * @return
     */
    @Override
    public int filterOrder() {
        return 10;
    }

    /**
     * 是否执行run方法
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 编写过滤器的业务逻辑
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        // 获取zuul提供的上下文对象
        RequestContext context = RequestContext.getCurrentContext();
        // 从上下文对象中获取请求对象
        HttpServletRequest request = context.getRequest();
        // 获取token信息
        String token = request.getParameter("access-token");
        // 判断
        if (StringUtils.isBlank(token)) {
            // 过滤该请求，不对其进行路由
            context.setSendZuulResponse(false);
            // 设置响应状态码，401
            context.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
            // 设置响应信息
            context.setResponseBody("request error");
        }
        // 校验通过，把登陆信息放入上下文信息，继续向后执行
        context.set("token", token);
        return null;
    }
}