SpringCloud学习（九）Zuul服务网关

在生产环境中，不同的微服务可能会有不同的网络地址，那么引入Zuul，通过它根据用户请求转发到具体的服务中去。另外还能统一在Zuul对请求路由前进行一些操作，比如权限控制、限流等，而不用在每个微服务中都存在同样的一套代码。

由于Zuul1.0进入维护阶段以及性能相对来说不算很好，Spring官方提供了一个自己的API网关——Spring Cloud Gateway，以代替Zuul。但我们还是需要了解下Zuul，方便在下一篇中学习Spring Cloud Gateway。

（一）创建一个zuul-server服务网关子工程

新建工程后，在pom.xml文件中引入以下zuul依赖，基本上路由规则为根据注册中心的注册服务serviceId转发，所以还需依赖spring-cloud-starter-netflix-eureka-client（已从父pom.xml自动依赖了）：

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

创建一个application启动类：

package com.ningmeng.zuulserver;


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;

@EnableZuulProxy// 开启zuul的功能  也可以使用@EnableZuulServer，@EnableZuulProxy是@EnableZuulServer的超集，也就是说@EnableZuulProxy比@EnableZuulServer拥有更多的功能，基本使用的话用@EnableZuulServer也足够了
@EnableDiscoveryClient// 向注册中心注册
@SpringBootApplication
public class ZuulServerApplication {

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

application.yml配置文件：

#工程端口号
server:
  port: 7001

spring:
  application:
    name: zuul-server #工程名
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest
#eureka注册中心地址
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/ #eureka服务器所在的地址

# 创建路由规则（两种方式，利用注册中心serviceId的方式更好）  这里根据项目工程，我们只可以创建ribbon-consumer以及feign-consumer两个路由  创建规则可以参考源码中ZuulProperties类的属性

# url映射的方式  自行测试
#zuul:
#  routes:
#    ribbon:
#      path: /ribbon/**
#      url: http://localhost:3001/  #url对应的是ribbon-consumer服务的访问地址
#  feign:
#    path: /feign/**
#    url: http://localhost:4001/  #url对应的是feign-consumer服务的访问地址

#注册中心serviceId的映射方式
zuul:
  routes:
    ribbon: #自定义名称
      service-id: ribbon-consumer #ribbon-consumer服务的spring.application.name(所以前面说了个属性很重要，要注意) ant风格路径表达式，只能匹配一个层级
      path: /ribbon/**
    feign: #自定义名称
      service-id: feign-consumer #这里填的是feign-consumer服务的spring.application.name(所以前面说了个属性很重要，要注意) ant风格路径表达式，只能匹配一个层级
      path: /feign/**

可根据源码中ZuulProperties类去配置：

最后依次启动eureka-server、config-server、service-provider、ribbon-consumer、feign-consumer以及zuul-server工程，并访问http://localhost:7001/ribbon/ribbonConsumer?time=2017以及http://localhost:7001/ribbon/ribbonConsumer?time=2016，可看到获取数据成功！


在上述中，访问http://localhost:7001/ribbon/ribbonConsumer?time=2017时，zuul将请求路由到ribbon-consumer微服务的http://localhost:3001/ribbonConsumer?time=2017

（二）在zuul-server创建一个filter过滤器模拟认证功能
继承一个ZuulFilter：

package com.ningmeng.zuulserver.filter;

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

import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * 过滤器，实现ZuulFilter的四个方法，目的在请求被路由之前检查请求中是否携带有token参数，若有就进行路由，若没有就拒绝访问，返回错误信息
 */
@Component //注入filter
public class AccessFilter extends ZuulFilter {

    /**
     * 返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
     * pre：可以在请求被路由之前调用，可用来实现Authentication、选择源服务地址等
     * routing：在路由请求时候被调用，即返回Response后执行。用来实现对Response结果进行修改，收集统计数据以及把Response传输会客户端
     * post：在routing和error过滤器之后被调用
     * error：处理请求时发生错误时被调用，上面三个过程中任何一个出现错误都交由ERROR类型的filters进行处理
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 通过int值来定义过滤器的执行顺序  数值越小，执行顺序越前
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。在这里，我们直接返回true，所以该过滤器总是生效
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体逻辑。需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求，不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码，当然我们也可以进一步优化我们的返回，比如，通过ctx.setResponseBody(body)对返回body内容进行编辑等。
     * @return
     */
    @Override
    public Object run() throws ZuulException {
        // 引用的是zuul包下的RequestContext
        RequestContext ctx = RequestContext.getCurrentContext();
        // 避免中文乱码
        ctx.addZuulRequestHeader("Content-type", "text/json;charset=UTF-8");
        ctx.getResponse().setCharacterEncoding("UTF-8");
        HttpServletRequest request = ctx.getRequest();
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
            try {
                ctx.getResponse().getWriter().write("没有权限，访问失败");
            } catch (IOException e) {
                e.printStackTrace();
            }
            return null;
        }
        return null;
    }
}

依次启动eureka-server、config-server、service-provider、ribbon-consumer、feign-consumer以及zuul-server工程，并访问http://localhost:7001/ribbon/ribbonConsumer?time=2016以及http://localhost:7001/feign/feignConsumer?time=2017&token=123，可看到只有携带了token的请求才能访问到数据！

本篇完结！

github代码地址：https://github.com/huijunzeng/springCloudDemo.git