SpringCloud笔记(Dalston)——Netflix之Zuul网关

API网关Zuul

在微服务架构中，通常会有多个服务提供者。设想一个电商系统，可能会有商品、订单、支付、用户等多个类型的服务，而每个类型的服务数量也会随着整个系统体量的增大也会随之增长和变更。作为UI端，在展示页面时可能需要从多个微服务中聚合数据，而且服务的划分位置结构可能会有所改变。网关就可以对外暴露聚合API，屏蔽内部微服务的微小变动，保持整个系统的稳定性。

简介

• Spring Cloud Zuul是Pivatal公司将Netflix公司 的Zuul方案整合于Spring Cloud体系的第一代网关组件，其在动态路由、监控、弹性、服务治理以及安全方面起着举足轻重的作用，是一个面向服务治理、服务编排的组件。
• Zuul是从设备和网站到后端应用程序所有请求的前门，为内部服务提供可配置的对外URL到服务的映射关系，基于JVM的后端路由器。其底层基于Servlet，本质组件是一系列Filter所构成的结构链，也就是说Zuul的逻辑引擎与Filter可用其他基于JVM的语言编写，比如Groovy。基本具备以下功能：认证和鉴权+压力控制+金丝雀测试+动态路由+负载均衡+静态响应处理+主动流量控制+限流+文件上传+参数转换+其他逻辑与业务处理等。

代码示例

准备工作

其中注册中心和Provider使用前面创建的eureka-server和eureka-provider。
新建一个spring-boot工程，取名为zuul，在pom文件引入需要的依赖。

添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<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>

开启zuul功能

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApplication {

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

}

路由配置

Zuul提供了一套简单且强大路由配置策略，利用路由配置我们可以完成对微服务和URL更精确的控制。

通过path和url访问具体服务器

zuul:
  routes:
    url-test:
      path: /api/**
      url: http://http://www.baidu.com/

serviceId微服务配置（使用负载均衡）

zuul:
  routes:
    eureka-provider:
      path: /eureka-provider/**
      serviceId: eureka-provider
eureka-provider:
  ribbon:
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule # 策略类(全路径名)

忽略路径或服务配置（不对它们进行路由）

#忽略eureka-provider服务
zuul:
  routes:
    # 使用'*'可忽略所有微服务
    ignored-services: '*'

zuul:
  routes:
    # 忽略/test/下所有路径
    ignored-patterns: /test/**
    

添加前缀

zuul:
  routes:
    #添加zuul前缀
    prefix: zuul

敏感头的传递

有些时候我们微服务上游可能想传递一些请求头到下游的服务，比如Token、Cookie等值。默认情况下，zuul 不会将Cookie、Set-Cookie、Authorization这三个头传递到下游服务，如果需要传递，就需要忽略这些敏感头。

zuul:
  routes:
    eureka-provider:
      path: /eureka-provider/**
      serviceId: eureka-provider
      sensitive-headers:  #局部配置，取消全局定义的敏感头，使之能向下游传递请求头
    url-test:
      path: /api/**
      url: http://www.baidu.com/
  sensitive-headers: Cookie,Set-Cookie,Authorization #全局配置，zuul不会向下游传递这三个请求头

忽略请求头

有些时候，我们不想将某个头传递到其它所有的微服务中，就可以使用忽略头，忽略头是全局配置的，如果想在某个服务中忽略某个头，可以使用敏感头忽略。

zuul:
  routes:
    eureka-provider:
      path: /eureka-provider/**
      serviceId: eureka-provider
  ignored-headers: token  #全局忽略头，忽略token这个请求头，不向下游服务传递这个token请求头

请求过滤配置

我们请求服务，也可以来设置身份验证，也就是过滤非法请求；Zuul通过ZuulFilter过滤器实现，每次经过Zuul服务网关 我们都对带来的token进行有效性验证。

public class AuthFilter extends ZuulFilter {

    /**
     * 过滤器的类型，它决定过滤器在请求的哪个生命周期中执行。
     * pre：在请求被路由之前执行
     * routing：在路由请求时被调用
     * post：在routing和error过滤器之后被调用
     * error：处理请求时发生错误时被调用
     *
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤器的执行顺序，请求在一个阶段中存在多个过滤器时，需要根据该方法返回的值来依次执行
     *
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 判断过滤器是否需要被执行，返回了true,因此该过滤器对所有请求都会生效。实际运用中我们可以利用该函数来指定过滤器的有效范围
     *
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体执行逻辑，这里判断请求是否携带token，如果不携带则令zuul过滤该请求，不对其进行路由
     *
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        //获取token
        Object accessToken = request.getParameter("accessToken");
        if (accessToken == null) {
            //过滤该请求
            ctx.setSendZuulResponse(false);
            //设置未授权返回响应码
            ctx.setResponseStatusCode(401);
            return null;
        }
        return null;
    }
}

@Configuration
public class ZuulFilterConfig {

    @Bean
    public AuthFilter authFilter(){
        return new AuthFilter();
    }

}