基于SpringCloud GateWay 3.1.2 版本
-
软件定制开发供应商内置过滤器
Spring Cloud GateWay 软件定制开发供应商内置了下图中的过滤器,软件定制开发供应商具体的内置过滤器如何使用,可参考,描述都很简单,本文重点在自定义过滤器的使用中。
-
自定义过滤器
官网文档地址:
创建自定义过滤器类,实现GlobalFilter, Ordered。并实现filter、getOrder两个方法。
getOrder方法返回 【-2147483648~2147483647】范围内的一个整数,数值越小优先级越高,越先执行。
filter方法,则是我们这个过滤器要处理的业务逻辑。该方法有两个参数ServerWebExchange exchange, GatewayFilterChain chain。
ServerWebExchange接口中主要是获取当前请求的request、response、attributes
通过exchange.getRequest()方法,可获取到请求发送的一些参数等信息。
通过exchange.getResponse()方法,可对当前请求进行处理,根据具体的业务逻辑调用是否直接返回某些信息。
通过chain.filter(exchange)方法,对当前请求进行放行。
-
- /**
- * @author songzerong
- * @desc 自定义GateWay过滤器 DemoFilter
- */
- @Component
- @Slf4j
- public class DemoFilter implements GlobalFilter, Ordered {
- @SneakyThrows
- @Override
- public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
- log.info("demo global filter");
- String str = exchange.getRequest().getQueryParams().getFirst("str");
- if (null == str) {
- // 若请求参数为null,则返回一个状态码,前台处理,否则继续执行后续的操作
- ServerHttpResponse response = exchange.getResponse();
- boolean b = response.setStatusCode(HttpStatus.METHOD_NOT_ALLOWED);
- if (b) {
- return exchange.getResponse().setComplete();
- } else {
- throw new Exception("设置状态码出错");
- }
- }
- return chain.filter(exchange);
-
- }
-
- @Override
- public int getOrder() {
- return -1;
- }
- }
若请求地址不带请求参数,则进入filter会直接返回405错误码。
若请求地址带请求参数,则进入filter则会放行,并继续执行后续处理逻辑。
将自定义过滤器加入Spring容器,有两种方式一种是直接在过滤器类中添加@Component注解,另一种是官方文档中写的,通过添加@Bean注解的形式进行注入使用。
-
- /**
- * @author songzerong
- * @desc 自定义GateWay过滤器 DemoFilter
- */
- @Slf4j
- public class DemoFilter implements GlobalFilter, Ordered {
-
- @Bean
- public GlobalFilter demoFilter(){
- return new DemoFilter();
- }
-
-
- @SneakyThrows
- @Override
- public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
- log.info("demo global filter");
- String str = exchange.getRequest().getQueryParams().getFirst("str");
- if (null == str) {
- // 若请求参数为null,则返回一个状态码,前台处理,否则继续执行后续的操作
- ServerHttpResponse response = exchange.getResponse();
- boolean b = response.setStatusCode(HttpStatus.METHOD_NOT_ALLOWED);
- if (b) {
- return exchange.getResponse().setComplete();
- } else {
- throw new Exception("设置状态码出错");
- }
- }
- return chain.filter(exchange);
-
- }
-
- @Override
- public int getOrder() {
- return -1;
- }
- }
至此,自定义过滤器添加完成。