springCloud(15):使用Zuul构建微服务网关-Header与文件上传和过滤器

本文涉及的产品
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
简介:

一、Header

1.1、敏感header的设置

一般来说,可在同一个系统中的服务之间共享Header,不过应尽量防止让一些敏感的Header外泄。

1
2
3
4
zuul:
   routes:
     provide-user: 
      sensitive-headers: Cookie,Set-Cookie

说明:敏感的header不会传播到下游去,也就是说此处的Cookie,Set-Cookie不会传播的其它的微服务中去

1.2、忽略的Header

可以使用zuul.ignored-headers属性丢弃一些Header,如:

1
2
3
4
5
zuul:
   routes:
     provide-user: 
      sensitive-headers: Cookie,Set-Cookie
   ignored-headers: Authorization

说明:忽略的header不会传播到下游去,也就是说此处的Authorization不会传播的其它的微服务中去,作用与上面敏感的Header差不多事实上sensitive-headers会被添加到ignored-headers中。


注意:

 1、默认情况下zuul.ignored-headers是空的

 2、如果Spring Security在项目的classpath中,那么zuul.ignored-headers的默认值就是Pragma,Cache-Control,X-Frame-Options,X-Content-Type-Options,X-XSS-Protection,Expires,所以,当Spring Security在项目的classpath中,同时又需要使用下游微服务的Spring Security的Header时,可以将zuul.ignoreSecurity-Headers设置为false

二、使用Zuul上传文件

1、对于小文件(1M以内)上传,无须任何处理,即可正常上传。

2、对于大文件(10M以上)上传,需要为上传路径添加/zuul前缀。

注意:这里的上传路径添加/zuul前缀无须配置


zuul的配置:

1
2
3
zuul:
   routes:
     file-upload: /file/**


测试上传:上传文件200多M

  wKioL1mdJ8ODXYe_AACJcUHRmwQ578.png

zuul端抛出超时异常:

1
Caused by: com.netflix.hystrix.exception.HystrixRuntimeException: file-upload timed-out and  no  fallback available.

解决:在zuul的yml配置文件中加入如下配置:

1
2
3
4
hystrix.command. default .execution.isolation.thread.timeoutInMilliseconds: 60000
ribbon:
   ConnectTimeout: 3000
   ReadTimeout: 60000

再次测试上传:上传文件200多M   

 wKiom1mdLLfSebcyAABnqzPW_58519.png

三、过滤器

3.1、过滤器类型与请求生命周期

Zuul大部分功能都是通过过滤器来实现的。Zuul中定义了4种标准过滤器类型,这些过滤器类型对应于请求的典型生命周期。

PRE

 这种过滤器在请求被路由之前调用。可利用这种过滤实现身份验证、在集群中选择请求的微服务、记录调试信息等。

ROUTING

 这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求,并使用Apache HttpClient或Netfilx Ribbon请求微服务。

POST

 这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

ERROR

 在其它阶段发送错误时执行该过滤器。


Zuul请求的生命周期如图:

  wKiom1mdM13i3jJcAACmQj_aSBA350.png

3.2、自定义过滤器

Zuul还允许创建自定义的过滤器类型。继承抽象类ZuulFilter即可。

自定义过滤器需要实现以下方法:

 a、filterType:返回过滤器的类型。有pre、route、post、error等,分别对应着上面的过滤器,详细可以参考com.netflix.zuul.ZuulFilter.filterType() 中的注释。

 b、filterOrder:返回一个int值来指定过滤器执行的顺序,不同的过滤器允许返回相同的顺序。

 c、shouldFilter:返回一个boolean值来判断该过滤器是否要执行,true表示执行。

 d、run:过滤器的具体逻辑。


这里编写一个记录请求日志的过滤器。

1、新建一个类LogFilter继承抽象类ZuulFilter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package  com.liuy.filter;
 
import  javax.servlet.http.HttpServletRequest;
 
import  org.slf4j.Logger;
import  org.slf4j.LoggerFactory;
 
import  com.netflix.zuul.ZuulFilter;
import  com.netflix.zuul.context.RequestContext;
 
/**
  * 打印请求日志
  * 记录请求日志的过滤器
  * @description 记录请求日志的过滤器
  * @author luis
  * @version 1.0
  * @date:2017年8月23日下午3:58:55
  */
public  class  LogFilter  extends  ZuulFilter {
     private  static  final  Logger LOG = LoggerFactory.getLogger(LogFilter. class );
 
     @Override
     public  Object run() {
         RequestContext ctx = RequestContext.getCurrentContext();
         HttpServletRequest request = ctx.getRequest();
         LogFilter.LOG.info(String.format( "打印日志 : send %s request to %s" , request.getMethod(), request.getRequestURL().toString()));
         return  null ;
     }
 
     @Override
     public  boolean  shouldFilter() {
         return  true ;
     }
 
     @Override
     public  int  filterOrder() {
         return  1 ;
     }
 
     @Override
     public  String filterType() {
         return  "pre" ;
     }
}

2、修改启动类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package  com.liuy;
 
import  org.springframework.boot.SpringApplication;
import  org.springframework.boot.autoconfigure.SpringBootApplication;
import  org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import  org.springframework.context.annotation.Bean;
 
import  com.liuy.filter.LogFilter;
 
/**
  * Zuul微服务网关 - 过滤器
  * @description Zuul微服务网关 - 过滤器
  * @author luis
  * @version 1.0
  * @date:2017年8月22日下午2:54:04
  */
@SpringBootApplication
@EnableZuulProxy
public  class  Application {
     public  static  void  main(String[] args) {
         SpringApplication.run(Application. class , args);
     }
     
     /**自定义过滤器*/
     @Bean
     public  LogFilter preRequestLogFilter() {
      return  new  LogFilter();
     }
}

3、测试

 a、依次启动eureka-server(4010)、provide-user(4011)、hystrix-consumer-movie(5012)、microservice-gateway-zuul-filter(5017)

 b、访问http://localhost:5017/hystrix-consumer-movie/user/1 

 效果:

  wKioL1meO4iRTgcsAABhrBNVfco050.jpg

3.3、禁用过滤器

Spring Cloud默认为Zuul编写了一些过滤器,如DebugFilter、FormBodyWrap-perFilter等,这些过滤器都放在spring-cloud-netflix-core这个jar包的org.springframework.cloud.netflix.zuul.filters包中。在某些场景下,我们可能需要禁用某些过滤器。


禁用方法非常简单,只需设置zuul.<SimpleClassName>.<filterType>.disable=true即可禁用SimpleClassName对应的过滤器。


以org.springframework.cloud.netflix.zuul.filters.pre.DebugFilter为例,如:

1
zuul.DebugFilter.post.disable=true

以前面我们自定义的com.liuy.filter.LogFilter为例,如:

1
zuul.LogFilter.pre.disable=true

本文转自我爱大金子博客51CTO博客,原文链接http://blog.51cto.com/1754966750/1958684如需转载请自行联系原作者

我爱大金子
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
27天前
|
SpringCloudAlibaba Java 持续交付
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
121 0
|
18小时前
|
监控 JavaScript 安全
构建微服务架构下的API网关
【4月更文挑战第15天】在微服务架构中,API网关扮演着至关重要的角色。它作为系统的唯一入口,不仅负责请求的路由、负载均衡和认证授权,还涉及到监控、日志记录和服务熔断等关键功能。本文将探讨如何构建一个高效且可靠的API网关,涵盖其设计原则、核心组件以及实现策略,旨在为后端开发人员提供一套实用的指导方案。
14 4
|
14天前
|
负载均衡 网络协议 Java
构建高效可扩展的微服务架构:利用Spring Cloud实现服务发现与负载均衡
本文将探讨如何利用Spring Cloud技术实现微服务架构中的服务发现与负载均衡,通过注册中心来管理服务的注册与发现,并通过负载均衡策略实现请求的分发,从而构建高效可扩展的微服务系统。
|
23天前
|
消息中间件 缓存 API
微服务架构下的API网关性能优化实践
在现代的软件开发中,微服务架构因其灵活性和可扩展性被广泛采用。随着服务的细分与增多,API网关作为微服务架构中的关键组件,承担着请求路由、负载均衡、权限校验等重要职责。然而,随着流量的增长和业务复杂度的提升,API网关很容易成为性能瓶颈。本文将深入探讨API网关在微服务环境中的性能优化策略,包括缓存机制、连接池管理、异步处理等方面的具体实现,旨在为开发者提供实用的性能提升指导。
|
25天前
|
缓存 负载均衡 监控
构建高效微服务架构:API网关的作用与实践
【2月更文挑战第31天】 在当今的软件开发领域,微服务架构已成为实现系统高度模块化和易于扩展的首选方法。然而,随着微服务数量的增加,确保通信效率和管理一致性变得尤为重要。本文将探讨API网关在微服务架构中的核心角色,包括其在请求路由、安全性、负载均衡以及聚合功能方面的重要性。我们将通过具体案例分析,展示如何利用API网关优化后端服务,并讨论实施过程中的最佳实践和常见挑战。
|
27天前
|
SpringCloudAlibaba 负载均衡 Java
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(目录大纲)
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(目录大纲)
61 1
|
27天前
|
Java Nacos Sentinel
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(九)Nacos+Sentinel+Seata
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(九)Nacos+Sentinel+Seata
134 0
|
27天前
|
消息中间件 SpringCloudAlibaba Java
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(八)Config服务配置+bus消息总线+stream消息驱动+Sleuth链路追踪
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(八)Config服务配置+bus消息总线+stream消息驱动+Sleuth链路追踪
771 0
|
28天前
|
SpringCloudAlibaba Java 网络架构
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(二)Rest微服务工程搭建
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(二)Rest微服务工程搭建
43 0
|
1月前
|
SpringCloudAlibaba Dubbo Java
SpringCloud Alibaba集成Dubbo实现远程服务间调用
SpringCloud Alibaba集成Dubbo实现远程服务间调用