作者:kosamino来源:cnblogs.com/jing99/p/11696192.html
<!-- spring cloud Eureka Client 启动器 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<artifactId>spring-cloud-starter-zuul</artifactId>
<!-- zuul网关的重试机制,不是使用ribbon内置的重试机制
是借助spring-retry组件实现的重试
开启zuul网关重试机制需要增加下述依赖
-->
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
/**
* @EnableZuulProxy - 开启Zuul网关。
* 当前应用是一个Zuul微服务网关。会在Eureka注册中心中注册当前服务。并发现其他的服务。
* Zuul需要的必要依赖是spring-cloud-starter-zuul。
*/
@SpringBootApplication
@EnableZuulProxy
public class ZuulApplication {
public static void main(String[] args) {
SpringApplication.run(ZuulApplication.class, args);
}
# URL pattern
# 使用路径方式匹配路由规则。
# 参数key结构:zuul.routes.customName.path=xxx
# 用于配置路径匹配规则。
# 其中customName自定义。通常使用要调用的服务名称,方便后期管理
# 可使用的通配符有: * ** ?
# ? 单个字符
# * 任意多个字符,不包含多级路径
# ** 任意多个字符,包含多级路径
zuul.routes.eureka-application-service.path=/api/**
# 参数key结构:zuul.routes.customName.url=xxx
# url用于配置符合path的请求路径路由到的服务地址。
zuul.routes.eureka-application-service.url=http://127.0.0.1:8080/
# service id pattern 通过服务名称路由
# key结构 :zuul.routes.customName.path=xxx
# 路径匹配规则
# key结构 :zuul.routes.customName.serviceId=xxx
# serviceId用于配置符合path的请求路径路由到的服务名称。
zuul.routes.eureka-application-service.serviceId=eureka-application-service
# simple service id pattern 简化配置方案
# 如果只配置path,不配置serviceId。则customName相当于服务名称。
# 符合path的请求路径直接路由到customName对应的服务上。
# ignored service id pattern
# 配置不被zuul管理的服务列表。多个服务名称使用逗号','分隔。
# 配置的服务将不被zuul代理。
zuul.ignored-services=eureka-application-service
# 此方式相当于给所有新发现的服务默认排除zuul网关访问方式,只有配置了路由网关的服务才可以通过zuul网关访问
# 通配方式配置排除列表。
zuul.ignored-services=*
# 使用服务名称匹配规则配置路由列表,相当于只对已配置的服务提供网关代理。
# 通配方式配置排除网关代理路径。所有符合ignored-patterns的请求路径都不被zuul网关代理。
zuul.ignored-patterns=/**/test/**
# prefix URL pattern 前缀路由匹配
# 配置请求路径前缀,所有基于此前缀的请求都由zuul网关提供代理。
zuul.prefix=/api
# 使用服务名称匹配方式配置请求路径规则。
# 这里的配置将为:http://ip:port/api/appservice/**的请求提供zuul网关代理,可以将要访问服务进行前缀分类。
# 并将请求路由到服务eureka-application-service中。
zuul.routes.eureka-application-service.path=/appservice/**
* Zuul过滤器,必须继承ZuulFilter父类。
* 当前类型的对象必须交由Spring容器管理。使用@Component注解描述。
* 继承父类后,必须实现父类中定义的4个抽象方法。
* shouldFilter、 run、 filterType、 filterOrder
@Component
public class LoggerFilter extends ZuulFilter {
private static final Logger logger = LoggerFactory.getLogger(LoggerFilter.class);
* 返回boolean类型。代表当前filter是否生效。
* 默认值为false。
* 返回true代表开启filter。
@Override
public boolean shouldFilter() {
return true;
* run方法就是过滤器的具体逻辑。
* return 可以返回任意的对象,当前实现忽略。(spring-cloud-zuul官方解释)
* 直接返回null即可。
public Object run() throws ZuulException {
// 通过zuul,获取请求上下文
RequestContext rc = RequestContext.getCurrentContext();
HttpServletRequest request = rc.getRequest();
logger.info("LogFilter1.....method={},url={}",
request.getMethod(),request.getRequestURL().toString());
// 可以记录日志、鉴权,给维护人员记录提供定位协助、统计性能
return null;
* 过滤器的类型。可选值有:
* pre - 前置过滤
* route - 路由后过滤
* error - 异常过滤
* post - 远程服务调用后过滤
public String filterType() {
return "pre";
* 同种类的过滤器的执行顺序。
* 按照返回值的自然升序执行。
public int filterOrder() {
return 0;
* 如果需要在Zuul网关服务中增加容错处理fallback,需要实现接口ZuulFallbackProvider
* spring-cloud框架,在Edgware版本(包括)之后,声明接口ZuulFallbackProvider过期失效,
* 提供了新的ZuulFallbackProvider的子接口 - FallbackProvider
* 在老版本中提供的ZuulFallbackProvider中,定义了两个方法。
* - String getRoute()
* 当前的fallback容错处理逻辑处理的是哪一个服务。可以使用通配符‘*’代表为全部的服务提供容错处理。
* 如果只为某一个服务提供容错,返回对应服务的spring.application.name值。
* - ClientHttpResponse fallbackResponse()
* 当服务发生错误的时候,如何容错。
* 新版本中提供的FallbackProvider提供了新的方法。
* - ClientHttpResponse fallbackResponse(Throwable cause)
* 如果使用新版本中定义的接口来做容错处理,容错处理逻辑,只运行子接口中定义的新方法。也就是有参方法。
* 是为远程服务发生异常的时候,通过异常的类型来运行不同的容错逻辑。
public class TestFallBbackProvider implements FallbackProvider {
* return - 返回fallback处理哪一个服务。返回的是服务的名称
* 推荐 - 为指定的服务定义特性化的fallback逻辑。
* 推荐 - 提供一个处理所有服务的fallback逻辑。
* 好处 - 服务某个服务发生超时,那么指定的fallback逻辑执行。如果有新服务上线,未提供fallback逻辑,有一个通用的。
public String getRoute() {
return "eureka-application-service";
* fallback逻辑。在早期版本中使用。
* Edgware版本之后,ZuulFallbackProvider接口过期,提供了新的子接口FallbackProvider
* 子接口中提供了方法ClientHttpResponse fallbackResponse(Throwable cause)。
* 优先调用子接口新定义的fallback处理逻辑。
public ClientHttpResponse fallbackResponse() {
System.out.println("ClientHttpResponse fallbackResponse()");
List<Map<String, Object>> result = new ArrayList<>();
Map<String, Object> data = new HashMap<>();
data.put("message", "服务正忙,请稍后重试");
result.add(data);
ObjectMapper mapper = new ObjectMapper();
String msg = "";
try {
msg = mapper.writeValueAsString(result);
} catch (JsonProcessingException e) {
msg = "";
return this.executeFallback(HttpStatus.OK, msg,
"application", "json", "utf-8");
* fallback逻辑。优先调用。可以根据异常类型动态决定处理方式。
public ClientHttpResponse fallbackResponse(Throwable cause) {
System.out.println("ClientHttpResponse fallbackResponse(Throwable cause)");
if(cause instanceof NullPointerException){
data.put("message", "网关超时,请稍后重试");
return this.executeFallback(HttpStatus.GATEWAY_TIMEOUT,
msg, "application", "json", "utf-8");
}else{
return this.fallbackResponse();
* 具体处理过程。
* @param status 容错处理后的返回状态,如200正常GET请求结果,201正常POST请求结果,404资源找不到错误等。
* 使用spring提供的枚举类型对象实现。HttpStatus
* @param contentMsg 自定义的响应内容。就是反馈给客户端的数据。
* @param mediaType 响应类型,是响应的主类型, 如:application、text、media。
* @param subMediaType 响应类型,是响应的子类型, 如:json、stream、html、plain、jpeg、png等。
* @param charsetName 响应结果的字符集。这里只传递字符集名称,如:utf-8、gbk、big5等。
* @return ClientHttpResponse 就是响应的具体内容。
* 相当于一个HttpServletResponse。
private final ClientHttpResponse executeFallback(final HttpStatus status,
String contentMsg, String mediaType, String subMediaType, String charsetName) {
return new ClientHttpResponse() {
* 设置响应的头信息
public HttpHeaders getHeaders() {
HttpHeaders header = new HttpHeaders();
MediaType mt = new MediaType(mediaType, subMediaType, Charset.forName(charsetName));
header.setContentType(mt);
return header;
* 设置响应体
* zuul会将本方法返回的输入流数据读取,并通过HttpServletResponse的输出流输出到客户端。
public InputStream getBody() throws IOException {
String content = contentMsg;
return new ByteArrayInputStream(content.getBytes());
* ClientHttpResponse的fallback的状态码 返回String
public String getStatusText() throws IOException {
return this.getStatusCode().getReasonPhrase();
* ClientHttpResponse的fallback的状态码 返回HttpStatus
public HttpStatus getStatusCode() throws IOException {
return status;
* ClientHttpResponse的fallback的状态码 返回int
public int getRawStatusCode() throws IOException {
return this.getStatusCode().value();
* 回收资源方法
* 用于回收当前fallback逻辑开启的资源对象的。
* 不要关闭getBody方法返回的那个输入流对象。
public void close() {
};
<groupId>com.marcosbarbero.cloud</groupId>
<artifactId>spring-cloud-zuul-ratelimit</artifactId>
<version>1.3.4.RELEASE</version>
# 开启限流保护
zuul.ratelimit.enabled=true
# 60s内请求超过3次,服务端就抛出异常,60s后可以恢复正常请求
zuul.ratelimit.default-policy.limit=3
zuul.ratelimit.default-policy.refresh-interval=60
# 针对IP进行限流,不影响其他IP
zuul.ratelimit.default-policy.type=origin
# hystrix-application-client服务60s内请求超过3次,服务抛出异常。
zuul.ratelimit.policies.hystrix-application-client.limit=3
zuul.ratelimit.policies.hystrix-application-client.refresh-interval=60
# 针对IP限流。
zuul.ratelimit.policies.hystrix-application-client.type=origin
# 开启zuul网关重试
zuul.retryable=true
# hystrix超时时间设置
# 线程池隔离,默认超时时间1000ms
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=8000
# ribbon超时时间设置:建议设置比Hystrix小
# 请求连接的超时时间: 默认5000ms
ribbon.ConnectTimeout=5000
# 请求处理的超时时间: 默认5000ms
ribbon.ReadTimeout=5000
# 重试次数:MaxAutoRetries表示访问服务集群下原节点(同路径访问);MaxAutoRetriesNextServer表示访问服务集群下其余节点(换台服务器)
ribbon.MaxAutoRetries=1
ribbon.MaxAutoRetriesNextServer=1
# 开启重试
ribbon.OkToRetryOnAllOperations=true
文章有问题?点此查看未经处理的缓存