【Java】关于 FastJson

• Z时代
• 2024-01-10
• 分类：技术分享

因为公司提供的基础框架使用的是 FastJson 框架、而部门的架构师推荐使用 Jackson。所以特此了解下 FastJson 相关的东西。

FastJson 是阿里开源的 Json 解析库、可以进行序列化以及反序列化。

最广为人所知的一个特点就是快

贴上几张对比图

从上面可以看到无论是反序列化还是序列化 FastJson 和 Jackson 差距其实并不是很大。

为啥 FastJson 能够那么快

Fastjson中Serialzie的优化实现

1. 自行编写类似StringBuilder的工具类SerializeWriter。

   把java对象序列化成json文本，是不可能使用字符串直接拼接的，因为这样性能很差。比字符串拼接更好的办法是使用java.lang.StringBuilder。StringBuilder虽然速度很好了，但还能够进一步提升性能的，fastjson中提供了一个类似StringBuilder的类com.alibaba.fastjson.serializer.SerializeWriter。

   SerializeWriter提供一些针对性的方法减少数组越界检查。例如public void writeIntAndChar(int i, char c) {}，这样的方法一次性把两个值写到buf中去，能够减少一次越界检查。目前SerializeWriter还有一些关键的方法能够减少越界检查的，我还没实现。也就是说，如果实现了，能够进一步提升serialize的性能。

2. 使用ThreadLocal来缓存buf。

   这个办法能够减少对象分配和gc，从而提升性能。SerializeWriter中包含了一个char[] buf，每序列化一次，都要做一次分配，使用ThreadLocal优化，能够提升性能。

3. 使用asm避免反射

   获取java bean的属性值，需要调用反射，fastjson引入了asm的来避免反射导致的开销。fastjson内置的asm是基于objectweb asm 3.3.1改造的，只保留必要的部分，fastjson asm部分不到1000行代码，引入了asm的同时不导致大小变大太多。

4. 使用一个特殊的IdentityHashMap优化性能。

   fastjson对每种类型使用一种serializer，于是就存在class -> JavaBeanSerizlier的映射。fastjson使用IdentityHashMap而不是HashMap，避免equals操作。我们知道HashMap的算法的transfer操作，并发时可能导致死循环，但是ConcurrentHashMap比HashMap系列会慢，因为其使用volatile和lock。fastjson自己实现了一个特别的IdentityHashMap，去掉transfer操作的IdentityHashMap，能够在并发时工作，但是不会导致死循环。

5. 缺省启用sort field输出

   json的object是一种key/value结构，正常的hashmap是无序的，fastjson缺省是排序输出的，这是为deserialize优化做准备。

6. 集成jdk实现的一些优化算法

   在优化fastjson的过程中，参考了jdk内部实现的算法，比如int to char[]算法等等。

fastjson的deserializer的主要优化算法

1. 读取token基于预测。

   所有的parser基本上都需要做词法处理，json也不例外。fastjson词法处理的时候，使用了基于预测的优化算法。比如key之后，最大的可能是冒号":"，value之后，可能是有两个，逗号","或者右括号"}"。在com.alibaba.fastjson.parser.JSONScanner中提供了这样的方法

    ​
    public void nextToken(int expect) {
     for (;;) {
     switch (expect) {
     case JSONToken.COMMA: //
     if (ch == ',') {
     token = JSONToken.COMMA;
     ch = buf[++bp];
     return;
     }
    
     if (ch == '}') {
     token = JSONToken.RBRACE;
     ch = buf[++bp];
     return;
     }
    
     if (ch == ']') {
     token = JSONToken.RBRACKET;
     ch = buf[++bp];
     return;
     }
    
     if (ch == EOI) {
     token = JSONToken.EOF;
     return;
     }
     break;
     // ... ...
     }
    }

   从上面摘抄下来的代码看，基于预测能够做更少的处理就能够读取到token。

2. sort field fast match算法

   fastjson的serialize是按照key的顺序进行的，于是fastjson做deserializer时候，采用一种优化算法，就是假设key/value的内容是有序的，读取的时候只需要做key的匹配，而不需要把key从输入中读取出来。通过这个优化，使得fastjson在处理json文本的时候，少读取超过50%的token，这个是一个十分关键的优化算法。基于这个算法，使用asm实现，性能提升十分明显，超过300％的性能提升。

    { "id" : 123, "name" : "魏加流", "salary" : 56789.79}
     ------      --------          ----------

   在上面例子看，虚线标注的三个部分是key，如果key_id、key_name、key_salary这三个key是顺序的，就可以做优化处理，这三个key不需要被读取出来，只需要比较就可以了。

   这种算法分两种模式，一种是快速模式，一种是常规模式。快速模式是假定key是顺序的，能快速处理，如果发现不能够快速处理，则退回常规模式。保证性能的同时，不会影响功能。

   在这个例子中，常规模式需要处理13个token，快速模式只需要处理6个token。

   演示 sort field fast match 算法的代码

    // 用于快速匹配的每个字段的前缀
    char[] size_   = ""size":".toCharArray();
    char[] uri_    = ""uri":".toCharArray();
    char[] titile_ = ""title":".toCharArray();
    char[] width_  = ""width":".toCharArray();
    char[] height_ = ""height":".toCharArray();
    
    // 保存parse开始时的lexer状态信息
    int mark = lexer.getBufferPosition();
    char mark_ch = lexer.getCurrent();
    int mark_token = lexer.token();
    
    int height = lexer.scanFieldInt(height_);
    if (lexer.matchStat == JSONScanner.NOT_MATCH) {
     // 退出快速模式, 进入常规模式
     lexer.reset(mark, mark_ch, mark_token);
     return (T) super.deserialze(parser, clazz);
    }
    
    String value = lexer.scanFieldString(size_);
    if (lexer.matchStat == JSONScanner.NOT_MATCH) {
     // 退出快速模式, 进入常规模式
     lexer.reset(mark, mark_ch, mark_token);
     return (T) super.deserialze(parser, clazz);
    }
    Size size = Size.valueOf(value);
    
    // ... ...
    
    // batch set
    Image image = new Image();
    image.setSize(size);
    image.setUri(uri);
    image.setTitle(title);
    image.setWidth(width);
    image.setHeight(height);
    
    return (T) image;

3. 使用asm避免反射

   deserialize的时候，会使用asm来构造对象，并且做batch set，也就是说合并连续调用多个setter方法，而不是分散调用，这个能够提升性能。

4. 对utf-8的json bytes，针对性使用优化的版本来转换编码。

   这个类是com.alibaba.fastjson.util.UTF8Decoder，来源于JDK中的UTF8Decoder，但是它使用ThreadLocal Cache Buffer，避免转换时分配char[]的开销。 ThreadLocal Cache的实现是这个类com.alibaba.fastjson.util.ThreadLocalCache。第一次1k，如果不够，会增长，最多增长到128k。

    //代码摘抄自com.alibaba.fastjson.JSON
    public static final <T> T parseObject(byte[] input, int off, int len, CharsetDecoder charsetDecoder, Type clazz,
     Feature... features) {
     charsetDecoder.reset();
    
     int scaleLength = (int) (len * (double) charsetDecoder.maxCharsPerByte());
     char[] chars = ThreadLocalCache.getChars(scaleLength); // 使用ThreadLocalCache，避免频繁分配内存
    
     ByteBuffer byteBuf = ByteBuffer.wrap(input, off, len);
     CharBuffer charByte = CharBuffer.wrap(chars);
     IOUtils.decode(charsetDecoder, byteBuf, charByte);
    
     int position = charByte.position();
    
     return (T) parseObject(chars, position, clazz, features);
    }

5. symbolTable算法。

   我们看xml或者javac的parser实现，经常会看到有一个这样的东西symbol table，它就是把一些经常使用的关键字缓存起来，在遍历char[]的时候，同时把hash计算好，通过这个hash值在hashtable中来获取缓存好的symbol，避免创建新的字符串对象。这种优化在fastjson里面用在key的读取，以及enum value的读取。这是也是parse性能优化的关键算法之一。

   以下是摘抄自JSONScanner类中的代码，这段代码用于读取类型为enum的value。

    int hash = 0;
    for (;;) {
     ch = buf[index++];
     if (ch == '"') {
     bp = index;
     this.ch = ch = buf[bp];
     strVal = symbolTable.addSymbol(buf, start, index - start - 1, hash); // 通过symbolTable来获得缓存好的symbol，包括fieldName、enumValue
     break;
     }
    
     hash = 31 * hash + ch; // 在token scan的过程中计算好hash
    
     // ... ...
    }

   以上这一大段内容都是来源于 FastJson 的作者 温少 的 blog

为啥经常被爆出漏洞

对于 Json 框架来说、想要把一个 Java 对象转换成字符串、有两种选择

• 基于属性
• 基于 setter/getter

FastJson 和 Jackson 在把对象序列化成 json 字符串的时候、是通过遍历该类中所有 getter 方法进行的。Gson并不是这么做的，他是通过反射遍历该类中的所有属性，并把其值序列化成json。

 class Store {
  private String name;
  private Fruit fruit;
  public String getName() {
  return name;
  }
  public void setName(String name) {
  this.name = name;
  }
  public Fruit getFruit() {
  return fruit;
  }
  public void setFruit(Fruit fruit) {
  this.fruit = fruit;
  }
 }
 ​
 interface Fruit {
 }
 ​
 class Apple implements Fruit {
  private BigDecimal price;
  //省略 setter/getter、toString等
 }

当我们要对他进行序列化的时候，fastjson会扫描其中的getter方法，即找到getName和getFruit，这时候就会将name和fruit两个字段的值序列化到JSON字符串中。

那么问题来了，我们上面的定义的Fruit只是一个接口，序列化的时候fastjson能够把属性值正确序列化出来吗？如果可以的话，那么反序列化的时候，fastjson会把这个fruit反序列化成什么类型呢？

我们尝试着验证一下，基于(fastjson v 1.2.68)：

 {"fruit":{"price":0.5},"name":"Hollis"}

那么，这个fruit的类型到底是什么呢，能否反序列化成Apple呢？我们再来执行以下代码：

 Store newStore = JSON.parseObject(jsonString, Store.class);
 System.out.println("parseObject : " + newStore);
 Apple newApple = (Apple)newStore.getFruit();
 System.out.println("getFruit : " + newApple);

执行结果如下：

 toJSONString : {"fruit":{"price":0.5},"name":"Hollis"}
 parseObject : Store{name='Hollis', fruit={}}
 Exception in thread "main" java.lang.ClassCastException: com.hollis.lab.fastjson.test.$Proxy0 cannot be cast to com.hollis.lab.fastjson.test.Apple
 at com.hollis.lab.fastjson.test.FastJsonTest.main(FastJsonTest.java:26)

可以看到，在将store反序列化之后，我们尝试将Fruit转换成Apple，但是抛出了异常，尝试直接转换成Fruit则不会报错，如：

 Fruit newFruit = newStore.getFruit();
 System.out.println("getFruit : " + newFruit);

以上现象，我们知道，当一个类中包含了一个接口（或抽象类）的时候，在使用fastjson进行序列化的时候，会将子类型抹去，只保留接口（抽象类）的类型，使得反序列化时无法拿到原始类型。

那么有什么办法解决这个问题呢，fastjson引入了AutoType，即在序列化的时候，把原始类型记录下来。

使用方法是通过SerializerFeature.WriteClassName进行标记，即将上述代码中的

 String jsonString = JSON.toJSONString(store,SerializerFeature.WriteClassName);

 {
  "@type":"com.hollis.lab.fastjson.test.Store",
  "fruit":{
  "@type":"com.hollis.lab.fastjson.test.Apple",
  "price":0.5
  },
  "name":"Hollis"
 }

可以看到，使用SerializerFeature.WriteClassName进行标记后，JSON字符串中多出了一个@type字段，标注了类对应的原始类型，方便在反序列化的时候定位到具体类型。

但是，也正是这个特性，因为在功能设计之初在安全方面考虑的不够周全，也给后续fastjson使用者带来了无尽的痛苦

AutoType 何错之有？

因为有了autoType功能，那么fastjson在对JSON字符串进行反序列化的时候，就会读取@type到内容，试图把JSON内容反序列化成这个对象，并且会调用这个类的setter方法。

那么就可以利用这个特性，自己构造一个JSON字符串，并且使用@type指定一个自己想要使用的攻击类库。

举个例子，黑客比较常用的攻击类库是com.sun.rowset.JdbcRowSetImpl，这是sun官方提供的一个类库，这个类的dataSourceName支持传入一个rmi的源，当解析这个uri的时候，就会支持rmi远程调用，去指定的rmi地址中去调用方法。

而fastjson在反序列化时会调用目标类的setter方法，那么如果黑客在JdbcRowSetImpl的dataSourceName中设置了一个想要执行的命令，那么就会导致很严重的后果。

如通过以下方式定一个JSON串，即可实现远程命令执行（在早期版本中，新版本中JdbcRowSetImpl已经被加了黑名单）

 {"@type":"com.sun.rowset.JdbcRowSetImpl","dataSourceName":"rmi://localhost:1099/Exploit","autoCommit":true}

这就是所谓的远程命令执行漏洞，即利用漏洞入侵到目标服务器，通过服务器执行命令。

在早期的fastjson版本中（v1.2.25 之前），因为AutoType是默认开启的，并且也没有什么限制，可以说是裸着的。

从v1.2.25开始，fastjson默认关闭了autotype支持，并且加入了checkAutotype，加入了黑名单+白名单来防御autotype开启的情况。

但是，也是从这个时候开始，黑客和fastjson作者之间的博弈就开始了。

因为fastjson默认关闭了autotype支持，并且做了黑白名单的校验，所以攻击方向就转变成了"如何绕过checkAutotype"。

绕过checkAutotype，黑客与fastjson的博弈

在fastjson v1.2.41 之前，在checkAutotype的代码中，会先进行黑白名单的过滤，如果要反序列化的类不在黑白名单中，那么才会对目标类进行反序列化。

但是在加载的过程中，fastjson有一段特殊的处理，那就是在具体加载类的时候会去掉className前后的L和;，形如Lcom.lang.Thread;。

而黑白名单又是通过startWith检测的，那么黑客只要在自己想要使用的攻击类库前后加上L和;就可以绕过黑白名单的检查了，也不耽误被fastjson正常加载。

如Lcom.sun.rowset.JdbcRowSetImpl;，会先通过白名单校验，然后fastjson在加载类的时候会去掉前后的L和，变成了com.sun.rowset.JdbcRowSetImpl`。

为了避免被攻击，在之后的 v1.2.42版本中，在进行黑白名单检测的时候，fastjson先判断目标类的类名的前后是不是L和;，如果是的话，就截取掉前后的L和;再进行黑白名单的校验。

看似解决了问题，但是黑客发现了这个规则之后，就在攻击时在目标类前后双写LL和;;，这样再被截取之后还是可以绕过检测。如LLcom.sun.rowset.JdbcRowSetImpl;;

魔高一尺，道高一丈。在 v1.2.43中，fastjson这次在黑白名单判断之前，增加了一个是否以LL未开头的判断，如果目标类以LL开头，那么就直接抛异常，于是就又短暂的修复了这个漏洞。

黑客在L和;这里走不通了，于是想办法从其他地方下手，因为fastjson在加载类的时候，不只对L和;这样的类进行特殊处理，还对[也被特殊处理了。

后续几个也是围绕 AutoType 进行攻击的、感兴趣可直接查看原文。以上内容文段来自一下链接

AutoType 安全模式？

可以看到，这些漏洞的利用几乎都是围绕AutoType来的，于是，在 v1.2.68版本中，引入了safeMode，配置safeMode后，无论白名单和黑名单，都不支持autoType，可一定程度上缓解反序列化Gadgets类变种攻击。

设置了safeMode后，@type 字段不再生效，即当解析形如{"@type": "com.java.class"}的JSON串时，将不再反序列化出对应的类。

开启safeMode方式如下：

 ParserConfig.getGlobalInstance().setSafeMode(true);

 Exception in thread "main" com.alibaba.fastjson.JSONException: safeMode not support autoType : com.hollis.lab.fastjson.test.Apple
 at com.alibaba.fastjson.parser.ParserConfig.checkAutoType(ParserConfig.java:1244)

以上内容均为整理所得

以上是 【Java】关于 FastJson 的全部内容， 来源链接： utcz.com/a/106971.html