Spring Gateway自定义请求参数封装

一、需求

在使用spring gateway作为网关时，我们需要在经过网关的请求中添加一些需要传递给后续服务的公共参数，这个时候就可以用到spring gateway提供的自定义请求参数功能了。

二、寻找解决途径

1、参考官方文档

• 我们可以猜测，spring gateway作为网关功能，肯定会提供很多处理请求参数的功能，于是我们查询文档得到如下内容：
  
  image

2、探索GatewayFilterFactory实现规律

• 通过查询spring官方文档可以看到，spring gateway为我们提供了很多xxxGatewayFilterFactory,而这些factory都有相同点，都是以GatewayFilterFactory结尾的。
• 在类名中，我们可以根据类名进行大胆的猜测，前面的几个单词是描述他的功能的。
• 右侧的yml配置文件可以看到，filter的配置也是呈现出一定的规律的。

3、从源码获取实现原理

既然我们是要解决自定义请求参数封装问题，那么我们通过上面描述规律，可以很大胆的猜测AddRequestParameteGatewayFilterFactory就是我们要找的目标。那么我们查看一下他的源码，看看他是如何实现的。

• 首先看看AddRequestParameteGatewayFilterFactory的继承关系，大概了解一下他的组成
  
  image

从继承关系来看，还是比较复杂，有点懵逼，那直接进入代码看看他的实现。

• 我们只粘贴比较核心的代码进行分析，其他代码暂时不用关心。

@Override
    public GatewayFilter apply(NameValueConfig config) {
        return new GatewayFilter() {
            @Override
            public Mono filter(ServerWebExchange exchange,
                    GatewayFilterChain chain) {
                URI uri = exchange.getRequest().getURI();
                StringBuilder query = new StringBuilder();
                //获取请求uri的请求参数（GET请求参数通过拼接key=value形式进行传参）
                String originalQuery = uri.getRawQuery(); 
                
                //判断最后一个字符是否是&，如果不是则拼接一个&，以备后续的参数进行连接
                if (StringUtils.hasText(originalQuery)) {
                    query.append(originalQuery);
                    if (originalQuery.charAt(originalQuery.length() - 1) != '&') {
                        query.append('&');
                    }
                }
                //获取config中的key、value，然后拼接到uri请求参数后面
                String value = ServerWebExchangeUtils.expand(exchange, config.getValue());
                // TODO urlencode?
                query.append(config.getName());
                query.append('=');
                query.append(value);
                //把请求参数重新拼接回去，并放入request中传递到过滤链的下一个请求中去
                try {
                    URI newUri = UriComponentsBuilder.fromUri(uri)
                            .replaceQuery(query.toString()).build(true).toUri();

                    ServerHttpRequest request = exchange.getRequest().mutate().uri(newUri)
                            .build();

                    return chain.filter(exchange.mutate().request(request).build());
                }
                catch (RuntimeException ex) {
                    throw new IllegalStateException(
                            "Invalid URI query: \"" + query.toString() + "\"");
                }
            }

• 此方法是用于封装请求参数的具体实现，代码的具体实现步骤已经通过注释进行说明。

那config中的key：value又是如何传递进来的呢？

4、filter的配置和参数传递

代码实现中出现了config参数的封装，那这个参数是如何获得的呢？这时候我们就要去查看这个filter是如何使用的了。

image

• 从图中可以看到，我们的filter就是在这个配置文件中配置使用的。那为什么配置文件中只有AddRequestParameter配置，而不是AddRequestParameterGatewayFilterFactory呢？？？
• 其实这是spring的一种约定，实现了GatewayFilterFactory接口的类在配置使用的时候，需要省略掉后面的GatewayFilterFactory，仅配置前缀即可。
• 同时，配置文件中的red，blue又是做什么的？？？
• 这就是我们需要传递的请求参数了，他以key=red，value=blue的方式进行配置。
• 然后spring会帮我们把这个键值传入到上面的apply方法的config中。我们通过config的源码就能看到究竟：
  
  image

可以看到，config类的实现就是一个name 和value，分别对应了配置文件中的两个参数。

三、基于官方实现进行自定义拓展

我们看到，spring利用同种方式，实现了各种filter。但如果这些都不能满足我们的要求，那该怎么办？？？

1、自定义参数惨景预设

我们现在看到的参数信息都是写死在配置文件中的，无法进行动态参数的传递。我们可以设想一个很普通的场景： 我们需要把用户的登录信息封装到请求参数中，供其他服务使用。那这又该如何实现呢？？？

2、参考官方实现进行自定义

其实如果我们只要模仿官方实现，在uri上拼接我们要传递的动态参数就可以了。具体实现如下：

  @Override
            public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                URI uri = exchange.getRequest().getURI();
                StringBuilder query = new StringBuilder();
                String originalQuery = uri.getRawQuery();

                if (StringUtils.hasText(originalQuery)) {
                    query.append(originalQuery);
                    if (originalQuery.charAt(originalQuery.length() - 1) != '&') {
                        query.append('&');
                    }
                }

                String value = ServerWebExchangeUtils.expand(exchange, config.getValue());
                // TODO urlencode?
                query.append(config.getName());
                query.append('=');
                query.append(value);

                //获取redis中用户的缓存信息，拼接到请求参数后面
                String token = exchange.getRequest().getHeaders().getFirst("token");
                if (StringUtils.hasText(token)) {
                    AccountEntity accountEntity = accountAdminApiService.loginAccountAdmin(token);
                    //通过发射拿到bean的属性和值，以备后面进行传递参数拼接
                    Map beanMap = beanValue(accountEntity);
                    if (!CollectionUtils.isEmpty(beanMap)) {
                        for (String key : beanMap.keySet()) {
                            query.append('&').append(key).append('=').append(beanMap.get(key));
                        }
                    }
                }

              //以下与官方代码一样，省略...
            }

• 在固定传参参数拼接后面，直接通过token去获取缓存中的用户登陆信息，然后依次拼接对应的属性和值即可。

四、自定义filter的应用。

网上看了很多人写的自定义，其实和本文差不多。但是有点没有提到，定义好了怎么用啊？？？

• 通过使用注解@bean的方式进行配置，具体可以自己百度。
• 这里用一个简易的配置，套用yml配置的规律，直接在配置文件中配置。

 default-filters:
        - AccountRequestParameter=k, v

因为我是全局使用的，所以使用的是default-filters进行配置

• 此外还应该注意，此时自定的filter并不会被spring boot加载，所以在启动的时候会报错。
• 解决办法：此时还要在对应的类上加上注解@Component,把bean交给spring管理。

至此，我们自定义请求参数封装完成！！！