共计 7112 个字符,预计需要花费 18 分钟才能阅读完成。
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 高可用
[
](https://springcloud-oss.oss-c…
咱们理论应用 Zuul 的形式如上图,不同的客户端应用不同的负载将申请散发到后端的 Zuul,Zuul 在通过 Eureka 调用后端服务,最初对外输入。因而为了保障 Zuul 的高可用性,前端能够同时启动多个 Zuul 实例进行负载,在 Zuul 的前端应用 Nginx 或者 F5 进行负载转发以达到高可用性。