1. Zuul的核心
Zuul的核心是Filter,用来实现对外服务的控制。分别是“PRE”、“ROUTING”、“POST”、“ERROR”,整个生命周期可以用下图来表示。
Zuul大部分功能都是通过过滤器来实现的。Zuul中定义了四种标准过滤器类型,这些过滤器类型对应于请求的典型生命周期。
-
PRE: 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
-
ROUTING: 这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求,并使用Apache HttpClient或Netfilx Ribbon请求微服务。
-
OST: 这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
-
ERROR: 在其他阶段发生错误时执行该过滤器。
2. Zuul中默认实现的Filter
pre | -3 | ServletDetectionFilter | 标记处理Servlet的类型 |
pre | -2 | Servlet30WrapperFilter | 包装HttpServletRequest请求 |
pre | -1 | FormBodyWrapperFilter | 包装请求体 |
route | 1 | DebugFilter | 标记调试标志 |
route | 5 | PreDecorationFilter | 处理请求上下文供后续使用 |
route | 10 | RibbonRoutingFilter | serviceId请求转发 |
route | 100 | SimpleHostRoutingFilter | url请求转发 |
route | 500 | SendForwardFilter | forward请求转发 |
post | 0 | SendErrorFilter | 处理有错误的请求响应 |
post | 1000 | SendResponseFilter | 处理正常的请求响应 |
2.1 禁用指定的Filter
可以在application.yml中配置需要禁用的filter,格式:
zuul: FormBodyWrapperFilter: pre: disable: true
3. 自定义Filter
实现自定义Filter,需要继承ZuulFilter的类,并覆盖其中的4个方法。
package com.springcloud.zuulsimple.filter; import com.netflix.zuul.ZuulFilter; import com.netflix.zuul.exception.ZuulException; /** * Created with IntelliJ IDEA. * * @User: weishiyao * @Date: 2019/7/6 * @Time: 16:10 * @email: inwsy@hotmail.com * Description: */ public class MyFilter extends ZuulFilter { @Override public String filterType() { return null; } @Override public int filterOrder() { return 0; } @Override public boolean shouldFilter() { return false; } @Override public Object run() throws ZuulException { return null; } }
4. 自定义Filter示例
我们假设有这样一个场景,因为服务网关应对的是外部的所有请求,为了避免产生安全隐患,我们需要对请求做一定的限制,比如请求中含有Token便让请求继续往下走,如果请求不带Token就直接返回并给出提示。
4.1 zuul-simple修改
首先,将上一篇的zuul-simple copy到一个新的文件夹中,自定义一个Filter,在run()方法中验证参数是否含有Token。
package com.springcloud.zuulsimple.filter; 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 javax.servlet.http.HttpServletRequest; /** * Created with IntelliJ IDEA. * * @User: weishiyao * @Date: 2019/7/6 * @Time: 16:11 * @email: inwsy@hotmail.com * Description: */ public class TokenFilter extends ZuulFilter { private final Logger logger = LoggerFactory.getLogger(TokenFilter.class); @Override public String filterType() { return "pre"; // 可以在请求被路由之前调用 } @Override public int filterOrder() { return 0; // filter执行顺序,通过数字指定 ,优先级为0,数字越大,优先级越低 } @Override public boolean shouldFilter() { return true;// 是否执行该过滤器,此处为true,说明需要过滤 } @Override public Object run() throws ZuulException { RequestContext ctx = RequestContext.getCurrentContext(); HttpServletRequest request = ctx.getRequest(); logger.info("--->>> TokenFilter {},{}", request.getMethod(), request.getRequestURL().toString()); String token = request.getParameter("token");// 获取请求的参数 if (StringUtils.isNotBlank(token)) { ctx.setSendZuulResponse(true); //对请求进行路由 ctx.setResponseStatusCode(200); ctx.set("isSuccess", true); return null; } else { ctx.setSendZuulResponse(false); //不对其进行路由 ctx.setResponseStatusCode(400); ctx.setResponseBody("token is empty"); ctx.set("isSuccess", false); return null; } } }
将TokenFilter加入到请求拦截队列,在启动类中添加以下代码:
@Bean public TokenFilter tokenFilter() { return new TokenFilter(); }
这样就将我们自定义好的Filter加入到了请求拦截中。
4.2 测试
将Eureka和producer都CV到新的文件夹下面,依次启动。
打开浏览器,我们访问:http://localhost:8080/spring-cloud-producer/hello?name=spring, 返回:token is empty ,请求被拦截返回。
访问地址:http://localhost:8080/spring-cloud-producer/hello?name=spring&token=123,返回:hello spring,producer is ready,说明请求正常响应。
通过上面这例子我们可以看出,我们可以使用“PRE”类型的Filter做很多的验证工作,在实际使用中我们可以结合shiro、oauth2.0等技术去做鉴权、验证。
5. 路由熔断
当我们的后端服务出现异常的时候,我们不希望将异常抛出给最外层,期望服务可以自动进行降级处理。Zuul给我们提供了这样的支持。当某个服务出现异常时,直接返回我们预设的信息。
我们通过自定义的fallback方法,并且将其指定给某个route来实现该route访问出问题的熔断处理。主要继承FallbackProvider接口来实现,FallbackProvider默认有两个方法,一个用来指明熔断拦截哪个服务,一个定制返回内容。
/* * Copyright 2013-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.cloud.netflix.zuul.filters.route; import org.springframework.http.client.ClientHttpResponse; /** * Provides fallback when a failure occurs on a route. * * @author Ryan Baxter * @author Dominik Mostek */ public interface FallbackProvider { /** * The route this fallback will be used for. * @return The route the fallback will be used for. */ String getRoute(); /** * Provides a fallback response based on the cause of the failed execution. * @param route The route the fallback is for * @param cause cause of the main method failure, may be <code>null</code> * @return the fallback response */ ClientHttpResponse fallbackResponse(String route, Throwable cause); }
实现类通过实现getRoute方法,告诉Zuul它是负责哪个route定义的熔断。而fallbackResponse方法则是告诉 Zuul 断路出现时,它会提供一个什么返回值来处理请求。
我们以上面的spring-cloud-producer服务为例,定制它的熔断返回内容。
package com.springcloud.zuulsimple.component; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.client.ClientHttpResponse; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; /** * Created with IntelliJ IDEA. * * @User: weishiyao * @Date: 2019/7/6 * @Time: 16:25 * @email: inwsy@hotmail.com * Description: */ @Component public class ProducerFallback implements FallbackProvider { private final Logger logger = LoggerFactory.getLogger(FallbackProvider.class); //指定要处理的 service。 @Override public String getRoute() { return "spring-cloud-producer"; } public ClientHttpResponse fallbackResponse() { return new ClientHttpResponse() { @Override public HttpStatus getStatusCode() throws IOException { return HttpStatus.OK; } @Override public int getRawStatusCode() throws IOException { return 200; } @Override public String getStatusText() throws IOException { return "OK"; } @Override public void close() { } @Override public InputStream getBody() throws IOException { return new ByteArrayInputStream("The service is unavailable.".getBytes()); } @Override public HttpHeaders getHeaders() { HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); return headers; } }; } @Override public ClientHttpResponse fallbackResponse(String route, Throwable cause) { if (cause != null && cause.getCause() != null) { String reason = cause.getCause().getMessage(); logger.info("Excption {}",reason); } return fallbackResponse(); } }
当服务出现异常时,打印相关异常信息,并返回”The service is unavailable.”。
需要注意点,这里我们需要将Eureka的配置文件修改一下:
server: port: 8761 spring: application: name: eureka-serve eureka: # server: # enable-self-preservation: false client: register-with-eureka: false service-url: defaultZone: http://localhost:8761/eureka/
将Eureka的自我保护模式打开,如果这里不开启自我保护模式,producer一停止服务,这个服务直接在Eureka下线,Zuul会直接报错找不到对应的producer服务。
我们顺次启动这三个服务。
现在打开浏览器,访问链接:http://localhost:8080/spring-cloud-producer/hello?name=spring&token=123, 可以看到页面正常返回:hello spring,producer is ready,现在我们把producer这个服务停下,再刷新下页面,可以看到页面返回:The service is unavailable.。这样我们熔断也测试成功。
6. Zuul高可用
我们实际使用Zuul的方式如上图,不同的客户端使用不同的负载将请求分发到后端的Zuul,Zuul在通过Eureka调用后端服务,最后对外输出。因此为了保证Zuul的高可用性,前端可以同时启动多个Zuul实例进行负载,在Zuul的前端使用Nginx或者F5进行负载转发以达到高可用性。
(企业架构源码可以加求球:三五三六二四七二五九)
相关推荐
SpringCloud Zuul是基于Spring Cloud框架的一个核心组件,它扮演着API网关的角色,负责路由转发、过滤器处理以及安全控制等任务。Zuul的主要功能包括动态路由、过滤器机制、安全控制、负载均衡、健康检查等。下面将...
SpringCloud API网关zuul ,路由规则写在配置文件中。为了便于修改,把配置文件放到配置文件中心。使用springcloud config .后期可以使用携程的阿波罗 可视化操作界面 并且是中文的。
SpringCloud Zuul Gateway 服务网关是Spring Cloud生态系统中的一个重要组件,它主要负责微服务架构中的路由转发和过滤器功能。Zuul是Netflix开源的一个边缘服务,而Gateway则是Spring Cloud针对Zuul进行的升级版,...
Spring Cloud 使用 Zuul 实现 API 网关服务问题 在本文中,我们将主要介绍如何使用 Spring Cloud 的 Zuul 组件来实现 API 网关服务问题。 Zuul 是一个基于 Netflix Zuul 的 API 网关组件,它可以解决路由规则和服务...
springcloud入门代码基于Spring Cloud实现的服务网关Zuul源代码 安装教程 Zuul pom.xml <groupId>org.springframework.cloud <artifactId>spring-cloud-starter-netflix-zuul application.yml server:...
Spring Cloud 服务网关Zuul的实现 Spring Cloud 服务网关Zuul是Netflix开源的API网关组件,用于管理和路由API流量。Zuul提供了灵活的路由、过滤和安全机制,帮助开发者快速构建高性能、高可用性的API网关。 服务...
springcloud zuul 网关开发实践,模拟了在Spring Cloud微服务系统中,客户端的请求首先经过负载均衡(zuul、Ngnix),再到达服务网关(zuul集群),然后再到具体的服的实现过程。
SpringCloud-2.0-service-zuul-80 代表了Zuul服务网关,它是所有微服务请求的统一入口。Zuul的主要职责有: 1. 路由转发:根据请求路径将请求转发到对应的服务提供者,实现服务间的解耦。 2. 访问过滤:Zuul提供了...
**Zuul** 是Spring Cloud的一部分,作为一个边缘服务,它充当了微服务架构的入口网关。Zuul的主要功能包括路由转发、过滤器处理、负载均衡、熔断和限流等。在单点登录场景中,Zuul可以拦截所有请求,检查请求是否...
SpringCloud Zuul是Spring Cloud生态系统中的一个边缘服务和API网关组件。它的主要功能是作为微服务架构中的统一入口,负责路由转发、过滤器处理、负载均衡以及安全控制等任务。Zuul允许开发者在微服务架构中实现...
综上所述,这个项目利用SpringCloud的组件构建了一个具备服务发现、动态路由、负载均衡的微服务系统,通过Eureka管理服务注册,Zuul处理外部请求的路由,Feign简化了服务间调用,共同构建出高效、可扩展的微服务架构...
SpringCloud中集成Zuul网关。 添加相关依赖,编写路由地址,添加过滤器可以在过滤器中对请求做其他操作 如验证是否登录、解密请求中的数据等
.`SpringCloud系列研究-服务网关zuul.pdf
.`SpringCloud系列研究-服务网关zuul.docx
在本教程中,我们将深入探讨如何使用Spring Cloud构建微服务网关,这是Spring Cloud生态中的一个关键组件。Spring Cloud提供了一套工具集,用于简化分布式系统(如配置管理、服务发现、断路器、智能路由、微代理、...
SpringCloud 网关组件 Zuul 实例解析 SpringCloud 网关组件 Zuul 是一个基于 Netflix 的 Zuul 项目,提供了动态路由、监控、安全、有限流控等功能。 Zuul 实例解析是 SpringCloud 网关组件 Zuul 的一个重要组件,它...
Spring Cloud Zuul网关 Spring Cloud Zuul网关是微服务架构中的一种网关解决方案,主要用于解决微服务之间的调用和路由问题。在本章节中,我们将了解Zuul网关的基本概念和使用方法,以及如何将其应用于微服务架构...
SpringCloud Zuul网关功能实现解析 SpringCloud Zuul网关功能实现解析是基于 SpringCloud 生态系统的微服务架构中的一种网关解决方案。 Zuul 是 Netflix 公司开源的一个基于 Java 的 API Gateway 项目,旨在提供一...
2. **microservice-springcloud**:这个文件夹可能是Spring Cloud的通用组件或配置示例,包含了一些基础的Spring Cloud服务,如Eureka(服务发现)、Config Server(配置中心)等。 3. **microservice-gateway-zuul...