feign 调用第三方服务中部分特殊符号未转义问题

 更新时间:2022年03月07日 09:38:49   作者:0D  
这篇文章主要介绍了feign 调用第三方服务中部分特殊符号未转义问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
(福利推荐:【腾讯云】服务器最新限时优惠活动,云服务器1核2G仅99元/年、2核4G仅768元/3年,立即抢购>>>:9i0i.cn/qcloud

(福利推荐:你还在原价购买阿里云服务器?现在阿里云0.8折限时抢购活动来啦!4核8G企业云服务器仅2998元/3年,立即抢购>>>:9i0i.cn/aliyun

调用第三方部分特殊符号未转义

开发过程中,发现+(加号)这个符号没有转义,导致再调用服务的时候把加号转义成空格了。导致后台获取到的数据会不正确。

1. 问题发现过程

feign 解析参数的时候,使用的标准是 RFC 3986,这个标准的加号是不需要被转义的。其具体的实现是 feign.template.UriUtils#encodeReserved(String value, String reserved, Charset charset)

2. 解决办法

feign 调用过程

1. feign核心先将(定义好的feign接口)接口中的参数解析出来

2. 对接实际参数和接口参数(入参调用的参数)

3. 对入参的参数进行编码(UriUtils#encodeReserved)(问题出在这里)

4. 调用注册的 RequestInterceptor(自定义)

5. Encoder 实现类,这里是body里面的内容才会有调用(自定义)

6. 具体的http网络请求逻辑

依据上面的过程,我们可以实现一个 RequestInterceptor 拦截器,在这里对参数再次进行转义即可。

public void apply(RequestTemplate template) {
? ? Map<String, Collection<String>> _queries = template.queries();
? ? if (!_queries.isEmpty()) {
? ? ? ? //由于在最新的 ?RFC 3986 ?规范,+号是不需要编码的,因此spring 实现的是这个规范,这里就需要参数中进行编码先,兼容旧规范。
? ? ? ? Map<String, Collection<String>> encodeQueries = new HashMap<String, Collection<String>>(_queries.size());
? ? ? ? Iterator<String> iterator = _queries.keySet().iterator();
? ? ? ? Collection<String> encodeValues = null;
? ? ? ? while (iterator.hasNext()) {
? ? ? ? ? ? encodeValues = new ArrayList<>();
? ? ? ? ? ? String key = iterator.next();
? ? ? ? ? ? Collection<String> values = _queries.get(key);
? ? ? ? ? ? for (String _str : values) {
? ? ? ? ? ? ? ? _str = _str.replaceAll("\\+", "%2B");
? ? ? ? ? ? ? ? encodeValues.add(_str);
? ? ? ? ? ? }
? ? ? ? ? ? encodeQueries.put(key, encodeValues);
? ? ? ? }
? ? ? ? template.queries(null);
? ? ? ? template.queries(encodeQueries);
? ? }
}

上面是代码片段,详细请查看 FeignRequestInterceptor.java

3. 疑问

3.1 是否可以使用 HTTPClient 的实现就可以解决问题?

也不行,如果不做上面的实现,直接改用HTTPClient实现的话,也只是在发送的过程中起到作用,还是需要在前进行处理。

@RequestParams & 符号未转义

feign-core 版本

        <!-- https://mvnrepository.com/artifact/io.github.openfeign/feign-core -->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-core</artifactId>
            <version>10.4.0</version>
        </dependency>

调用路径

源码分析

1.Template 类

package feign.template;
...
public class Template {
  protected String resolveExpression(Expression expression, Map<String, ?> variables) {
    String resolved = null;
    Object value = variables.get(expression.getName());
    // 1. 调用 SimpleExpression 的 expand() 方法
    return expression.expand(value, this.encode.isEncodingRequired());
  }
}
public final class Expressions {
  static class SimpleExpression extends Expression {
    private final FragmentType type;
    String encode(Object value) {
      // 2. 调用 UriUtils.encodeReserved() 方法,type 参数是 FragmentType.PATH_SEGMENT
      return UriUtils.encodeReserved(value.toString(), type, Util.UTF_8);
    }
    @Override
    String expand(Object variable, boolean encode) {
      StringBuilder expanded = new StringBuilder();
      expanded.append((encode) ? encode(variable) : variable);
      String result = expanded.toString();
      return result;
    }
  }
}

public class UriUtils {  
  public static String encodeReserved(String value, FragmentType type, Charset charset) {
    return encodeChunk(value, type, charset);
  }  
  private static String encodeChunk(String value, FragmentType type, Charset charset) {
    byte[] data = value.getBytes(charset);
    ByteArrayOutputStream encoded = new ByteArrayOutputStream();
    for (byte b : data) {
      if (type.isAllowed(b)) {
      // 3.1 如果不需要转义,则不进行转义操作
        encoded.write(b);
      } else {
        /* percent encode the byte */
        // 3.2 否则,进行编码
        pctEncode(b, encoded);
      }
    }
    return new String(encoded.toByteArray());
  }
  
  enum FragmentType {
    URI {
      @Override
      boolean isAllowed(int c) {
        return isUnreserved(c);
      }
    },
    PATH_SEGMENT {
      @Override
      boolean isAllowed(int c) {
        return this.isPchar(c) || (c == '/');
      }
    }
    abstract boolean isAllowed(int c);
    protected boolean isAlpha(int c) {
      return (c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z');
    }
    protected boolean isDigit(int c) {
      return (c >= '0' && c <= '9');
    }
    protected boolean isSubDelimiter(int c) {
      return (c == '!') || (c == '$') || (c == '&') || (c == '\'') || (c == '(') || (c == ')')
          || (c == '*') || (c == '+') || (c == ',') || (c == ';') || (c == '=');
    }
    protected boolean isUnreserved(int c) {
      return this.isAlpha(c) || this.isDigit(c) || c == '-' || c == '.' || c == '_' || c == '~';
    }
    protected boolean isPchar(int c) {
      return this.isUnreserved(c) || this.isSubDelimiter(c) || c == ':' || c == '@';
    }
  }
}

从源码上可以看出,& 字符属于 isSubDelimiter(),所以不会被转义。

测试

package feign.template;
import feign.Util;
public class UriUtilsDemo {
? ? public static void main(String[] args) {
? ? ? ? String str = "aa&aa";
? ? ? ? // 输出:aa&aa
? ? ? ? System.out.println(UriUtils.encodeReserved(str, UriUtils.FragmentType.PATH_SEGMENT, Util.UTF_8));
? ? ? ? // 输出:aa%26aa
? ? ? ? System.out.println(UriUtils.encodeReserved(str, UriUtils.FragmentType.URI, Util.UTF_8));
? ? }
}

解决方案

1、升级 feign-core 版本,feign-core-10.12 已经没有这个问题。

2、使用 @RequestBody 替换 @RequestParam。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持程序员之家。

相关文章

  • Java将Object转换为数组的代码

    Java将Object转换为数组的代码

    这篇文章主要介绍了Java将Object转换为数组的情况,今天在使用一个别人写的工具类,这个工具类,主要是判空操作,包括集合、数组、Map等对象是否为空的操作,需要的朋友可以参考下
    2022-09-09
  • Java控制台实现猜拳游戏

    Java控制台实现猜拳游戏

    这篇文章主要为大家详细介绍了Java控制台实现猜拳游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-01-01
  • Mybatis结果集映射一对多简单入门教程

    Mybatis结果集映射一对多简单入门教程

    本文给大家介绍Mybatis结果集映射一对多简单入门教程,包括搭建数据库环境的过程,idea搭建maven项目的代码详解,本文通过实例代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-06-06
  • Java 生成随机验证码图片的示例

    Java 生成随机验证码图片的示例

    这篇文章主要介绍了Java 生成随机验证码图片的示例,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-10-10
  • Java正则表达式(匹配、切割、替换、获取)等方法

    Java正则表达式(匹配、切割、替换、获取)等方法

    这篇文章主要介绍了Java正则表达式(匹配、切割、替换、获取)等方法的相关资料,需要的朋友可以参考下
    2017-06-06
  • SpringBoot集成mybatis实例

    SpringBoot集成mybatis实例

    本篇文章主要介绍了SpringBoot集成mybatis实例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • Java Web开发之基于Session的购物商店实现方法

    Java Web开发之基于Session的购物商店实现方法

    这篇文章主要介绍了Java Web开发之基于Session的购物商店实现方法,涉及Java针对session的操作及数据库操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-10-10
  • mybatis通过中间表实现一对多查询功能

    mybatis通过中间表实现一对多查询功能

    这篇文章主要介绍了mybatis通过中间表实现一对多查询,通过一个学生的id查询出该学生所学的所有科目,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2021-08-08
  • Java 线程池详解及创建简单实例

    Java 线程池详解及创建简单实例

    这篇文章主要介绍了Java 线程池详解及创建简单实例的相关资料,需要的朋友可以参考下
    2017-02-02
  • Java中的FileInputStream 和 FileOutputStream 介绍_动力节点Java学院整理

    Java中的FileInputStream 和 FileOutputStream 介绍_动力节点Java学院整理

    FileInputStream 是文件输入流,它继承于InputStream。FileOutputStream 是文件输出流,它继承于OutputStream。接下来通过本文给大家介绍Java中的FileInputStream 和 FileOutputStream,需要的朋友可以参考下
    2017-05-05

最新评论

?


http://www.vxiaotou.com