zl程序教程

您现在的位置是:首页 >  后端

当前栏目

Spring Cloud Alibaba-Spring Cloud Gateway-使用路由网关的全局过滤功能

SpringCloud路由gateway 功能 过滤 全局 网关
2023-09-14 09:14:12 时间

概述

全局过滤器作用于所有的路由,不需要单独配置,我们可以用它来实现很多统一化处理的业务需求,比如权限认证,IP 访问限制等等。

注意:截止博客发表时间 2019 年 01 月 10 日,Spring Cloud Gateway 正式版为 2.0.2 其文档并不完善,并且有些地方还要重新设计,这里仅提供一个基本的案例

声明周期

Spring Cloud Gateway 基于 Project Reactor 和 WebFlux,采用响应式编程风格,打开它的 Filter 的接口 GlobalFilter 你会发现它只有一个方法 filter。

创建全局过滤器

实现 GlobalFilterOrdered 接口并在类上增加 @Component 注解就可以使用过滤功能了,非常简单方便

  1. package cn.dandelioncloud.hello.spring.cloud.gateway.filters;
  2. import com.fasterxml.jackson.core.JsonProcessingException;
  3. import com.fasterxml.jackson.databind.ObjectMapper;
  4. import com.google.common.collect.Maps;
  5. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
  6. import org.springframework.cloud.gateway.filter.GlobalFilter;
  7. import org.springframework.core.Ordered;
  8. import org.springframework.core.io.buffer.DataBuffer;
  9. import org.springframework.http.HttpStatus;
  10. import org.springframework.http.server.reactive.ServerHttpResponse;
  11. import org.springframework.stereotype.Component;
  12. import org.springframework.web.server.ServerWebExchange;
  13. import reactor.core.publisher.Mono;
  14. import java.util.Map;
  15. /**
  16. * 鉴权过滤器
  17. */
  18. @Component
  19. public class AuthFilter implements GlobalFilter, Ordered {
  20. @Override
  21. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  22. String token = exchange.getRequest().getQueryParams().getFirst("token");
  23. if (token == null || token.isEmpty()) {
  24. ServerHttpResponse response = exchange.getResponse();
  25. // 封装错误信息
  26. Map<String, Object> responseData = Maps.newHashMap();
  27. responseData.put("code", 401);
  28. responseData.put("message", "非法请求");
  29. responseData.put("cause", "Token is empty");
  30. try {
  31. // 将信息转换为 JSON
  32. ObjectMapper objectMapper = new ObjectMapper();
  33. byte[] data = objectMapper.writeValueAsBytes(responseData);
  34. // 输出错误信息到页面
  35. DataBuffer buffer = response.bufferFactory().wrap(data);
  36. response.setStatusCode(HttpStatus.UNAUTHORIZED);
  37. response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
  38. return response.writeWith(Mono.just(buffer));
  39. } catch (JsonProcessingException e) {
  40. e.printStackTrace();
  41. }
  42. }
  43. return chain.filter(exchange);
  44. }
  45. /**
  46. * 设置过滤器的执行顺序
  47. * @return
  48. */
  49. @Override
  50. public int getOrder() {
  51. return Ordered.LOWEST_PRECEDENCE;
  52. }
  53. }

测试过滤器

浏览器访问:http://localhost:9000/nacos-consumer/echo/app/name 网页显示

浏览器访问:http://localhost:9000/nacos-consumer/echo/app/name?token=123456 网页显示

  1. Hello Nacos Discovery nacos-consumer i am from port 8082

附:Spring Cloud Gateway Benchmark

Spring 官方人员提供的网关基准测试报告 GitHub

ProxyAvg LatencyAvg Req/Sec/Thread
gateway6.61ms3.24k
linkered7.62ms2.82k
zuul12.56ms2.09k
none2.09ms11.77k

说明

  • 这里的 Zuul 为 1.x 版本,是一个基于阻塞 IO 的 API Gateway
  • Zuul 已经发布了 Zuul 2.x,基于 Netty,非阻塞的,支持长连接,但 Spring Cloud 暂时还没有整合计划
  • Linkerd 基于 Scala 实现的、目前市面上仅有的生产级别的 Service Mesh(其他诸如 Istio、Conduit 暂时还不能用于生产)。