概述
全局过滤器作用于所有的路由,不需要单独配置,我们可以用它来实现很多统一化处理的业务需求,比如权限认证,IP 访问限制等等。
注意:截止2019年06月,Spring Cloud Gateway 正式版为 2.0.2 其文档并不完善,并且有些地方还要重新设计,这里仅提供一个基本的案例
Spring Cloud Gateway 基于 Project Reactor 和 WebFlux,采用响应式编程风格,打开它的 Filter 的接口 GlobalFilter 你会发现它只有一个方法 filter。
创建全局过滤器
基于spring-cloud-alibaba-gateway做修改:
实现 GlobalFilter, Ordered 接口并在类上增加 @Component 注解就可以使用过滤功能了,非常简单方便
package com.lb.gateway.filters;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.Maps;
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.Map;
/**
* @program: hello-spring-cloud-alibaba
* @description: 鉴权过滤器
* @author: lb
* @create: 2021-06-30 16:57
**/
@Component
public class AuthFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String token = exchange.getRequest().getQueryParams().getFirst("token");
if (token == null || token.isEmpty()) {
ServerHttpResponse response = exchange.getResponse();
// 封装错误信息
Map<String, Object> responseData = Maps.newHashMap();
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);
}
/**
* 设置过滤器的执行顺序
*
* @return
*/
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE;
}
}
测试过滤器:
浏览器访问:http://localhost:9000/nacos-consumer/test/app/name 网页显示
浏览器访问:http://localhost:9000/nacos-consumer/test/app/name?token=123456 网页显示
上面讲的是网关的基础的配置
在这里讲一下,网关的yml文件的配置详解
如果你是生产者,消费者模式的话,就需要在消费者代码工程中配置以下的文件配置
gateway:
routes:
##路由id
## 如果是生产者消费者,分模块的这种项目, 只需要在消费者端配置gateway的配置即可。
## id: 是你消费者在nacos上注册的名字
## uri: lb://consumer, 在这里lb://是固定的写法。consumer是你的消费者的服务名
- id: consumer
#### 基于lb负载均衡形式转发(通过注册中心服务名称,获取真实访问地址)
uri: lb://consumer
filters:
- StripPrefix=1
###匹配规则
## 在这里,下面的Path=/consumer/星星 这里是配置路径的前缀的匹配
predicates:
- Method=GET
- Path=/consumer/**