SpringCloud 基础教程(十)-Zuul 服务网关

我的博客:程序员笑笑生,欢迎浏览博客!,搜索博客可添加微信公众号。

   上一章 SpringCloud 基础教程(九)-Hystrix服务监控(下)当中,我们深入了解Hystrix的服务监控。实现了分布式环境下,监控多个服务的信息,本章节将探索微服务的另一个组件,网关。

    

前言

 什么是Zuul,Zuul可以说是一个大门,所有的来自前端的请求,经过Zuul时,能够实现动态路由转发,监控、安全的等边缘服务应用程序。比如可以作为统一资源的访问入口、负载均衡等。为什么需要需要这样的一个组件呢?Netflix开发这样的产品是考虑到了以下的原因:api的多样性和访问量大能够导致很多的问题,无法预警。所以我们需要这样的系统组件应付这些情况。

一、Zuul 提供的功能

  • 身份认证和安全-可以识别访问资源的每一个请求,拒绝不满足的请求
  • 洞察和监控,跟踪有意义的数据并统计,以便生成有意义的生产视图
  • 动态路由,根据需要将请求动态的路由到不同的后端集群,(最主要的功能)
  • 压力测试,逐渐增加集群的流量,评估性能
  • 限流,为每一个请求分配容量,并丢弃超过限制的请求
  • 处理静态响应,直接在边缘处构建响应,而不是转发给内部集群

二、Zuul 快速入门

 新建Maven项目,引入Zuul的依赖和Eureka的依赖,我们转发请求是需要从Eureka中获取服务的信息。Zuul的依赖默认集成了hystrix和ribbon

<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>

 新建GateWayApplication启动类,添加@EnableZuulProxy注解,@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker三个注解:表示是一个SpringBoot程序,启动服务发现功能和服务熔断功能,

import org.springframework.boot.SpringApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
@SpringCloudApplication
@EnableZuulProxy
public class GateWayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GateWayApplication.class);
    }
}

 当然我们可以使用@SpringCloudApplication一个注解,从源码上可以看出@SpringCloudApplication包含了@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker三个注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootApplication
@EnableDiscoveryClient
@EnableCircuitBreaker
public @interface SpringCloudApplication {
}

 配置applicaiton.yml,配置端口号,配置连接Eureka的url,配置zuul相关配置:

server:
  port: 9876
  
eureka:
  instance:
    instance-id: gateway1
    hostname: eureka7001.com  #服务端的实例名称
  client:
    service-url:
       defaultZone: http://eureka7001.com:7001/eureka/
zuul:
  ignored-services: "*"
  routes:
     server-provider:
        path:   /server-provider/*

 在routes下有以下几种的配置

第一种:

zuul:
  ignored-services: "*"
  routes:
     server-provider:   #配置服注册在Eureka的服务名称,指的是服务中spring.application.name的配置
         #将/server-provider/开头的都转发到服务名为server-provider的服务上,
      path:   /server-provider/*  

第二种:

zuul:
  ignored-services: "*"
  routes:
     server-a:   #名称随便起
         #将/server-provider/开头的都转发到服务名为server-provider的服务上,
      path:   /server-provider/*  
       #配置服注册在Eureka的服务名称,指的是服务中spring.application.name的配置
      serviceId:  server-provider  

第三种:

zuul:
  ignored-services: "*"
  routes:
     server-b:   #名称随便起
         #将/server-provider/开头的都转发到url为 http://localhost:5168/  #的服务上,
      path:   /server-provider/*  
       #配置服注册在Eureka的服务名称,指的是服务中spring.application.name的配置
      url:  http://localhost:5168/  #不通过Eureka

 接下来,我们启动Eureka中心,2个服务提供者: server-provider,启动Zuul网关服务,查看Eureka监控页面:

file

然后我们通过以下的URL访问:http://localhost:9876/server-provider/sayHello?name=1 ,可以看到我们通过了Zuul网关实现了路由,服务提供方也能返回请求的结果,并实现了负载均衡:

file

三、Zuul过滤器

3.1 过滤器简介

 上文我们实现了简单的路由转发,除了路由转发,在实际的企业应用中,需要结合不同的需求实现不同的功能,Zuul可以通过过滤器来实现接口权限验证、限流、统计等。Zuul定义了4种不同的过滤器类型:

file

我们可以理解为在请求的不同时间分别调用:

  • pre:这种过滤器在请求被转发之前调用,一般用来实现身份验证等
  • routing:这种路由是用来路由到不同的后端服务的,底层可以使用httpclient或者ribbon请求微服务
  • post:当请求转发到微服务以后,会调用当前类型的过滤器。通常用来为响应天啊及标椎的HTTP Header、收集统计信息,等
  • error:当发生错误是执行的过滤器

3.2 自定义过滤器实现Token验证

 自定义过滤器需要集成com.netflix.zuul.ZuulFilter类,并实现其抽象的方法达到所需要的目的,这里我们简单的实现通过Token的验证:

import com.alibaba.fastjson.JSONObject;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 *验证token
 */
@Component
public class TokenFilter extends ZuulFilter {
    private Logger logger=LoggerFactory.getLogger(TokenFilter.class);
    /**
     * 返回过滤器类型   "pre" / "route" / "post"  / “ error”
     *
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }
    /**
     * 过滤器的顺序,不同的过滤器顺序可以相同
     *
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }
    /**
     * 判断是否要执行  true表示执行 run方法
     *
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }
    /**
     * 当 shouldFilter() 返回true时候
     * 执行run中的具体逻辑、返回值在当前的版本中没有意义
     *
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
         RequestContext context = RequestContext.getCurrentContext();
         HttpServletRequest request = context.getRequest();
         HttpServletResponse response = context.getResponse();
        //获取header中的token
        String token = request.getHeader("token");
        JSONObject jsonObject=new JSONObject();
      //如果token为空,设置返回状态为401,返回json的信息
        if (StringUtils.isEmpty(token)) {
            context.setSendZuulResponse(false);
            context.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
            jsonObject.put("code",401);
            jsonObject.put("msg","UNAUTHORIZED");
            context.setResponseBody(jsonObject.toJSONString());
            logger.info("msg:{}",jsonObject);
        } else {
            //否则执行请求
            logger.info("msg:{}","ok");
            return null;
        }
        return null;
    }
}

  • filterType:返回过滤器类型 “pre” / “route” / “post” / “ error”
  • filterOrder:过滤器的顺序
  • shouldFilter:为true时候,执行run方法
  • run:具体的逻辑,在方法中我们可以获取到RequestContext对象,通过该对象获取请求头的信息,并设置返回信息

 接下来,我们启动相应的服务,并发送请求,如果没有token,则返回如下的信息:

file

这样我们就能实现一个简单的通过Token的过滤验证了。

 对于启用/禁用过滤器,我们不可能去修改过滤器的代码,我们可以通过配置文件配置进行过滤的控制,在applicaiton.yml中我们可以这样配置:

zuul:
   #过滤器的名称
  TokenFilter:
     pre :
     #true表示禁用
       disable : true

3.3 请求重试

 当Zuul转发失败时,可以通过配置使Ribbon的客户端进行重试,默认是false

zuul:
  retryable: true

3.4 敏感Header的过滤

 在请求的转发过程中,默认会转发HTTP的Header信息,有时候我们不希望这些信息被转发,比如Cookie,token,我们可以通过sensitiveHeaders配置,多项之间用逗号隔开:

zuul:
  sensitive-headers: Cookie,token

3.5 设置统一的前缀

zuul:
  prefix: /api

四、总结

 本章分享了Zuul组件在微服务架构中担任的角色,并通过示例的方式实现了通过Token简单的过滤请求,当然Zuul的功能不知于此,Zuul经历过各大互联网公司的检验,能够和Spring Cloud生态完美的融合,是微服务不可或缺的一个关键节点。

                                                                               ----END----

以就是本期的分享,你还可以关注公众号: 程序员笑笑生,关注更多精彩内容!

file

file

SpringCloud基础教程(一)-微服务与SpringCloud

SpringCloud基础教程(二)-服务发现 Eureka

SpringCloud基础教程(三)-Eureka进阶

SpringCloud 基础教程(四)-配置中心入门

SpringCloud基础教程(五)-配置中心热生效和高可用

SpringCloud 基础教程(六)-负载均衡Ribbon

SpringCloud 基础教程(七)-Feign声明式服务调用

SpringCloud 基础教程(八)-Hystrix熔断器(上)

SpringCloud 基础教程(九)-Hystrix服务监控(下)

SpringCloud 基础教程(十)-Zull服务网关

更多精彩内容,请期待…

本文由博客一文多发平台 OpenWrite 发布!

https://juejin.im/post/5e36eb6df265da3df716e83a

「点点赞赏,手留余香」

    还没有人赞赏,快来当第一个赞赏的人吧!
0 条回复 A 作者 M 管理员
    所有的伟大,都源于一个勇敢的开始!
欢迎您,新朋友,感谢参与互动!欢迎您 {{author}},您在本站有{{commentsCount}}条评论