1.1 自定义过滤器
即使 Spring Cloud Gateway
自带许多实用的 GatewayFilter Factory、Gateway Filter、Global Filter
,但是在很多情景下我们仍然希望可以自定义自己的过滤器,实现一些骚操作。
1.1.1 自定义网关过滤器
自定义网关过滤器需要实现以下两个接口 :GatewayFilter
,Ordered
。
【1】创建过滤器:CustomGatewayFilter.java
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/**
* 自定义网关过滤器
*/
public class CustomGatewayFilter implements GatewayFilter, Ordered {
/**
* 过滤器业务逻辑
*
* @param exchange
* @param chain
* @return
*/
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("自定义网关过滤器被执行");
return chain.filter(exchange); // 继续向下执行
}
/**
* 过滤器执行顺序,数值越小,优先级越高
*
* @return
*/
@Override
public int getOrder() {
return 0;
}
}
【2】注册过滤器
import com.example.filter.CustomGatewayFilter;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 网关路由配置类
*/
@Configuration
public class GatewayRoutesConfiguration {
@Bean
public RouteLocator routeLocator(RouteLocatorBuilder builder) {
return builder.routes().route(r -> r
// 断言(判断条件)
.path("/product/**")
// 目标 URI,路由到微服务的地址
.uri("lb://product-service")
// 注册自定义网关过滤器
.filters(new CustomGatewayFilter())
// 路由 ID,唯一
.id("product-service"))
.build();
}
}
【3】访问:注释配置文件中所有网关配置,重启并访问:http://localhost:9000/product/1
1.1.2 自定义全局过滤器
自定义全局过滤器需要实现以下两个接口 :GlobalFilter
,Ordered
。通过全局过滤器可以实现权限校验,安全性验证等功能。
【1】创建过滤器实现指定接口,添加 @Component
注解即可。
CustomGlobalFilter.java
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/**
* 自定义全局过滤器
*/
@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {
/**
* 过滤器业务逻辑
*
* @param exchange
* @param chain
* @return
*/
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("自定义全局过滤器被执行");
return chain.filter(exchange); // 继续向下执行
}
/**
* 过滤器执行顺序,数值越小,优先级越高
*
* @return
*/
@Override
public int getOrder() {
return 0;
}
}
访问:http://localhost:9000/product/1 控制台结果如下:
自定义全局过滤器被执行
1.1.3 统一鉴权
接下来我们在网关过滤器中通过 token 判断用户是否登录,完成一个统一鉴权案例。
【1】创建过滤器:AccessFilter.java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* 权限验证过滤器
*/
@Component
public class AccessFilter implements GlobalFilter, Ordered {
private Logger logger = LoggerFactory.getLogger(AccessFilter.class);
/**
* 过滤器业务逻辑
*
* @param exchange
* @param chain
* @return
*/
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 获取请求参数
String token = exchange.getRequest().getQueryParams().getFirst("token");
// 业务逻辑处理
if (null == token) {
logger.warn("token is null...");
ServerHttpResponse response = exchange.getResponse();
// 响应类型
response.getHeaders().add("Content-Type", "application/json; charset=utf-8");
// 响应状态码,HTTP 401 错误代表用户没有访问权限
response.setStatusCode(HttpStatus.UNAUTHORIZED);
// 响应内容
String message = "{\"message\":\"" + HttpStatus.UNAUTHORIZED.getReasonPhrase() + "\"}";
DataBuffer buffer = response.bufferFactory().wrap(message.getBytes());
// 请求结束,不在继续向下请求
return response.writeWith(Mono.just(buffer));
}
// 使用 token 进行身份验证
logger.info("token is OK!");
return chain.filter(exchange);
}
/**
* 过滤器执行顺序,数值越小,优先级越高
*
* @return
*/
@Override
public int getOrder() {
return 1;
}
}
【2】访问:http://localhost:9000/product/1 结果如下: