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

曾经终败给现在 2024-03-30 12:37 22阅读 0赞

### 概述 ###

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

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

### 声明周期 ###

![1c1751147d31a7dc514bd4a15f0d87cb.jpeg][]

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

### 创建全局过滤器 ###

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

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

### 测试过滤器 ###

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

![079cfc974054a447d677c894611eda6f.png][]

浏览器访问：`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

<table> 
 <thead> 
  <tr> 
   <th>Proxy</th> 
   <th>Avg Latency</th> 
   <th>Avg Req/Sec/Thread</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>gateway</td> 
   <td>6.61ms</td> 
   <td>3.24k</td> 
  </tr> 
  <tr> 
   <td>linkered</td> 
   <td>7.62ms</td> 
   <td>2.82k</td> 
  </tr> 
  <tr> 
   <td>zuul</td> 
   <td>12.56ms</td> 
   <td>2.09k</td> 
  </tr> 
  <tr> 
   <td>none</td> 
   <td>2.09ms</td> 
   <td>11.77k</td> 
  </tr> 
 </tbody> 
</table>

#### 说明 ####

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

[1c1751147d31a7dc514bd4a15f0d87cb.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4ec9d5dd3b134ac6a6c545e277553736.jpeg
[079cfc974054a447d677c894611eda6f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/d1565950452f439d9092e6a857db00fd.png