Spring Cloud Alibaba 学习笔记(十):网关全局过滤
本文最后更新于 2025-04-28,文章内容可能已经过时。
目录:Spring Cloud Alibaba 学习笔记(总) | 今日说码
上一篇:Spring Cloud Alibaba 学习笔记(九):路由网关(Gateway) | 今日说码
下一篇:Spring Cloud Alibaba 学习笔记(十一):服务配置(Nacos Config) | 今日说码
概述
全局过滤器作用于所有的路由,不需要单独配置,我们可以用它来实现很多统一化处理的业务需求,比如权限认证,IP访问限制等等。
声明周期
Spring Cloud Gateway 基于 Project Reactor 和 WebFlux,采用响应式编程风格,打开它的 Filter 的接口 GlobalFilter 你会发现它只有一个方法 filter。
创建全局过滤器
在 spring-cloud-alibaba-gateway 子模块启动类同级目录下,创建 filters文件夹,然后在该文件夹下创建 AuthFilter类,实现 GlobalFilter, Ordered 接口并在类上增加 @Component 注解就可以使用过滤功能了,非常简单方便。代码如下:
package com.xl.gateway.filters;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.HashMap;
import java.util.Map;
/**
* 鉴权过滤器
*/
@Component
public class AuthFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String token = exchange.getRequest().getQueryParams().getFirst("token");
// 如果请求参数中没有token,则提示错误信息
if (token == null || token.isEmpty()) {
ServerHttpResponse response = exchange.getResponse();
// 封装错误信息
Map<String, Object> responseData = new HashMap<>(3);
responseData.put("code", 401);
responseData.put("message", "非法请求");
responseData.put("cause", "Token is empty");
try {
// 将信息转换为JSON
ObjectMapper objectMapper = new ObjectMapper();
byte[] data = objectMapper.writeValueAsBytes(responseData);
// 输出错误信息到页面
DataBuffer buffer = response.bufferFactory().wrap(data);
response.setStatusCode(HttpStatus.UNAUTHORIZED);
response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
return response.writeWith(Mono.just(buffer));
} catch (JsonProcessingException e) {
e.printStackTrace();
}
}
return chain.filter(exchange);
}
/**
* 设置过滤器的执行顺序
*/
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE;
}
}
项目结构
项目最终目录结构如下:
测试网关全局过滤
重新启动 GatewayApplication 实例,等待出现 Started GatewayApplication in 8.466 seconds (JVM running for 9.539) 启动成功的提示后,访问http://localhost:9093/nacos-consumer/test/app/name,会出现以下响应:
访问http://localhost:9093/nacos-consumer/test/app/name?token=123,会出现以下响应:
说明网关全局过滤配置生效。
目录:Spring Cloud Alibaba 学习笔记(总) | 今日说码
上一篇:Spring Cloud Alibaba 学习笔记(九):路由网关(Gateway) | 今日说码
下一篇:Spring Cloud Alibaba 学习笔记(十一):服务配置(Nacos Config) | 今日说码