SpringCloud-Gateway自定义局部 GatewayFilter

迈不过友情╰ 2021-06-10 20:40 645阅读 0赞

有两种方式：

1、继承GatewayFilter，实现后使用java方式配置路由；

2、继承AbstractGatewayFilterFactory，注入为bean即可（推荐）

另外可参考：

[https://www.cnblogs.com/chenglc/p/13139407.html][https_www.cnblogs.com_chenglc_p_13139407.html]

[https://www.cnblogs.com/cloudxlr/p/11820638.html][https_www.cnblogs.com_cloudxlr_p_11820638.html]

## 自定义过滤器工厂 ##

过滤器工厂的顶级接口是GatewayFilterFactory，我们可以直接继承它的两个抽象类来简化开发AbstractGatewayFilterFactory和AbstractNameValueGatewayFilterFactory，这两个抽象类的区别就是前者接收一个参数（像StripPrefix和我们创建的这种），后者接收两个参数（像AddResponseHeader）。

![image][]

1、AbstractNameValueGatewayFilterFactory

![11da92469c33235ec2a803ac3e576eb5.png][]  
复制进来提前准备好的类  
![dd35fab54e3bb4cdffab3223401d608b.png][]  
去掉一些没有用到的包  
![7c36f38a5574cebaf89f9d22517b05e5.png][]  
类名的结尾  
![b83889913c0b17702bb5d899d0b13145.png][]  
继承类，并自定义Config  
![a56ae1a6da506fc5bb7560a24c086359.png][]  
Config是来承载我们的参数的  
![cc8da778ddbae6afa80a22f7242c338e.png][]  
自定义请求的一个name和value。当name和value都能匹配的上的时候，就返回true继续往下走。匹配不上就报错。这个绝大多数我们不是在parameter里面做的 巨大多数是在header头里面做的。jwt要验证token是否正确。这个时候需要验证我们有没有authorization的信息。同时把它的内容取出来。紧接着跟我的jwt服务器 作比较。看看jwt是否有效。  
  
在之类先给大家演示的是一个比较简单的  
![467e69065e690c3f8e62d0890d1eec44.png][]  
匹配的两个值  
![35fadf3e6bb3fbf8c55f838db087d926.png][]  
这两个常量是在上面来定义的  
![ee537835a8384304f02d890888cb5eb9.png][]  
  
这是具体的业务处理  
![1ef2b2e82948c2a3cf021df5f4086f61.png][]  
  
把所有请求的parameters都打印出来了  
![243088e0df63c0f6c6b4988f9f9d7776.png][]  
请求的头里面获取configParameter  
![942d1518b34e3f6f49a3f88c47fedbd5.png][]  
如果和我定义的值不相同就返回无效的请求。直接Response回去了。 就不继续处理下一个逻辑了。   
![3f925411378b161b97ca881320f0af32.png][]  
本身加了@Component的注解了。所以不需要在config内注入。  
![df7b571a03cf3c69110c9b69450d06de.png][]  
要求参数内必须有个imooc。值必须是jiangzh  
![2750f3141afc138aed329bfd3f87e4d1.png][]  
  
![5fdf78d1b67447f68e2282ada8c4c1cb.png][]  
  
重启gateway测试  
  
测试一个失败的   
![d50d419d8e1f318b5206977f2304564c.png][]  
  
![6cf34d144fc96c71df668fe993306280.png][]  
   
  
![fcacc422619fec48396f4d913a5252a9.png][]  
  
![602dd87f09e6ca9fee22425839152dca.png][]  
  
  
  
![a0812eeac3a182923a0fdab15c917afd.png][]

2、AbstractGatewayFilterFactory

做一个可配置是否开启的打印请求耗时的过滤器

import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import org.springframework.cloud.gateway.filter.GatewayFilter;
    import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
    import reactor.core.publisher.Mono;
    
    import java.util.Arrays;
    import java.util.List;
    
    
    public class RequestTimeGatewayFilterFactory extends AbstractGatewayFilterFactory<RequestTimeGatewayFilterFactory.Config> {
    
    
        private static final Log log = LogFactory.getLog(GatewayFilter.class);
        private static final String REQUEST_TIME_BEGIN = "requestTimeBegin";
        private static final String KEY = "withParams";
    
        @Override
        public List<String> shortcutFieldOrder() {
            return Arrays.asList(KEY);
        }
    
        public RequestTimeGatewayFilterFactory() {
            super(Config.class);
        }
    
        @Override
        public GatewayFilter apply(Config config) {
            return (exchange, chain) -> {
                exchange.getAttributes().put(REQUEST_TIME_BEGIN, System.currentTimeMillis());
                return chain.filter(exchange).then(
                        Mono.fromRunnable(() -> {
                            Long startTime = exchange.getAttribute(REQUEST_TIME_BEGIN);
                            if (startTime != null) {
                                StringBuilder sb = new StringBuilder(exchange.getRequest().getURI().getRawPath())
                                        .append(": ")
                                        .append(System.currentTimeMillis() - startTime)
                                        .append("ms");
                                if (config.isWithParams()) {
                                    sb.append(" params:").append(exchange.getRequest().getQueryParams());
                                }
                                log.info(sb.toString());
                            }
                        })
                );
            };
        }
    
        public static class Config {
    
            private boolean withParams;
    
            public boolean isWithParams() {
                return withParams;
            }
    
            public void setWithParams(boolean withParams) {
                this.withParams = withParams;
            }
    
        }
    }

在上面的代码中 apply(Config config)方法内创建了一个GatewayFilter的匿名类，具体的实现逻辑跟之前一样，只不过加了是否打印请求参数的逻辑，而这个逻辑的开关是config.isWithParams()。静态内部类类Config就是为了接收那个boolean类型的参数服务的，里边的变量名可以随意写，但是要重写List shortcutFieldOrder()这个方法。

需要注意的是，在类的构造器中一定要调用下父类的构造器把Config类型传过去，否则会报ClassCastException

最后，需要在工程的启动文件Application类中，向Srping Ioc容器注册RequestTimeGatewayFilterFactory类的Bean。

@Bean
        public RequestTimeGatewayFilterFactory elapsedGatewayFilterFactory() {
            return new RequestTimeGatewayFilterFactory();
        }

配置项：

spring:
      cloud:
        gateway:
          routes:
          - id: elapse_route
            uri: http://httpbin.org:80/get
            filters:
            - RequestTime=false
            predicates:
            - After=2017-01-20T17:42:47.789-07:00[America/Denver]
      profiles: elapse_route

现在可以通过配置来决定是否开启打印时间的日志

[https_www.cnblogs.com_chenglc_p_13139407.html]: https://www.cnblogs.com/chenglc/p/13139407.html
[https_www.cnblogs.com_cloudxlr_p_11820638.html]: https://www.cnblogs.com/cloudxlr/p/11820638.html
[image]: /images/20210527/b3927c4421154dcb9277eaf928d9db9a.png
[11da92469c33235ec2a803ac3e576eb5.png]: /images/20210527/68d7ecb253e648dea23b613be4cc3657.png
[dd35fab54e3bb4cdffab3223401d608b.png]: /images/20210527/def2e7161e6f433aa338a6c62d34ef7a.png
[7c36f38a5574cebaf89f9d22517b05e5.png]: /images/20210527/3240313563c04bfca8d8ab19b32f306a.png
[b83889913c0b17702bb5d899d0b13145.png]: /images/20210527/1e041d99f0ce4048860cd8a52459c485.png
[a56ae1a6da506fc5bb7560a24c086359.png]: /images/20210527/cf39c95fee754021833ea8eee1e07d25.png
[cc8da778ddbae6afa80a22f7242c338e.png]: /images/20210527/3707c449c41d4d6b8710f36d24e35d4c.png
[467e69065e690c3f8e62d0890d1eec44.png]: /images/20210527/0b18242ff8b644bd90d2682e71c88a1d.png
[35fadf3e6bb3fbf8c55f838db087d926.png]: /images/20210527/15607f6b35f643b29d923f3d35302ea9.png
[ee537835a8384304f02d890888cb5eb9.png]: /images/20210527/71a538bf5d7f4331962ceadf65900fe8.png
[1ef2b2e82948c2a3cf021df5f4086f61.png]: /images/20210527/87ecaf062741467c98c3d92493c87106.png
[243088e0df63c0f6c6b4988f9f9d7776.png]: /images/20210527/fea1315fbf6d4d8d992831572aa02571.png
[942d1518b34e3f6f49a3f88c47fedbd5.png]: /images/20210527/0938e4d1f7a54cfe9d85e97fc58a2281.png
[3f925411378b161b97ca881320f0af32.png]: /images/20210527/6b745b2f296d46669aeea058c59f8fb9.png
[df7b571a03cf3c69110c9b69450d06de.png]: /images/20210527/5ef76dc8e577429d86c6fc9a3095ef08.png
[2750f3141afc138aed329bfd3f87e4d1.png]: /images/20210527/9ec82fbb933a4c4b961203bbf916db09.png
[5fdf78d1b67447f68e2282ada8c4c1cb.png]: /images/20210527/b84232ad7661404781a5e50bd3e05154.png
[d50d419d8e1f318b5206977f2304564c.png]: /images/20210527/a867c1d9ac67403eac8f45a756eb92c9.png
[6cf34d144fc96c71df668fe993306280.png]: /images/20210527/e67c77bdc45246f39b47c5979d20a3c8.png
[fcacc422619fec48396f4d913a5252a9.png]: /images/20210527/d784ad3ae856436ca81f9c8099341089.png
[602dd87f09e6ca9fee22425839152dca.png]: /images/20210527/909c19de9a2a4946acdd2e073db66935.png
[a0812eeac3a182923a0fdab15c917afd.png]: /images/20210527/037016b93555401b86ddd27dc051877c.png