[BUG]通过ObjectReader定制反序列化后，其所对应的类型无法再使用JSONObject.to(...) 与 JSONObject.getObject(...) 方法

[jfinal]

问题描述

通过 ObjectReader 定制反序列化后，其所对应的类型无法再使用JSONObject.to(...) 与 JSONObject.getObject(...) 方法，必定抛出异常

环境信息

请填写以下信息：

• OS信息： [Mac OS 15.3.2]
• JDK信息： [jdk 1.8.0_312]
• 版本信息：[Fastjson2 2.0.60]

重现步骤

运行如下代码重现：

public class UserReader implements ObjectReader<Object> {
    public Object readObject(JSONReader jsonReader, Type fieldType, Object fieldName, long features) {
        // 这里返回 user 仅为示例，JSONObject.to(...) 不会走到这里
        return new User();
    }
}

public class User {
    String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

public class FastJsonTest {
    public static void main(String[] args) {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("name", "James");

        // 未注册 UserReader 之前功能正常
        User user = jsonObject.to(User.class);

        // 注册 UserReader
        JSON.register(User.class, new UserReader());

        // 注册后得先转成 String 才能使用 JSONObject.to(...)、JSONObject.getObject()
        user = JSON.parseObject(jsonObject.toJSONString(), User.class);

        // 注册后 JSONObject.to(...)、JSONObject.getObject() 都将无法使用
        user = jsonObject.to(User.class);

        System.out.println(user.getName());
    }
}

代码说明

只要 JSON.register(User.class, new UserReader()) 注册了 ObjectReader 定制反序列化实现，JSONObject.to(...) 与JSONObject.getObject() 就一定用不了。

但通过 JSONObject.toJSONString() 将先数据转成 json string，再通过 JSON.parseObject(...) 转换为 bean 是可以实现的。

[jfinal]

@jujn

这里的问题在于即便正确实现 createInstance 方法，仍然会出现另一个新的异常。

在 catch 中通过 JSON.parseObject(this.toJSONString(), clazz, features) 的方式一是抛出异常有性能损耗，二是多一次 toJSONString() 转换有性能损耗。

更希望是在实现 createInstance 方法的基础之上，能解决那另一个异常，这样起码性能上有保障。

[jujn]

@jujn

这里的问题在于即便正确实现 createInstance 方法，仍然会出现另一个新的异常。

在 catch 中通过 JSON.parseObject(this.toJSONString(), clazz, features) 的方式一是抛出异常有性能损耗，二是多一次 toJSONString() 转换有性能损耗。

更希望是在实现 createInstance 方法的基础之上，能解决那另一个异常，这样起码性能上有保障。

您实现了 createInstance 后会抛出什么异常呢？能否提供下用例？

[jfinal]

@jujn

实现 createInstance方法后抛出如下异常

Exception in thread "main" com.alibaba.fastjson2.JSONException: input not end, offset 1, character {, line 1, column 1, fastjson-version 2.0.60 {"name":"James"}
at com.alibaba.fastjson2.JSON.parseObject(JSON.java:940)
at cn.aifei._test.fastjson.FastJsonTest.main(FastJsonTest.java:18)

实现代码如下：

public class UserReader implements ObjectReader<Object> {
    // 这里返回 user 仅为示例，JSONObject.to(...) 不会走到这里
    public Object readObject(JSONReader jsonReader, Type fieldType, Object fieldName, long features) {
        return new User();
    }

    public Object createInstance(long features) {
        return new User();
    }
}

[jujn]

您需要在readObject中消费掉当前的 JSON 内容，如 jsonReader.readObject()，然后追加自定义的其它逻辑

[jfinal]

您需要在readObject中消费掉当前的 JSON 内容，如 jsonReader.readObject()，然后追加自定义的其它逻辑

这个我知道，所以我给了以下注释：
// 这里返回 user 仅为示例，JSONObject.to(...) 不会走到这里

程序不会走到readObject(...) ，就会抛出异常，还没到那一步

[jujn]

我没太理解您的意思，我本地运行下面单测是没问题的：

    public void test() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("name", "James");

        User user = jsonObject.to(User.class);

        JSON.register(User.class, new UserReader());

        user = JSON.parseObject(jsonObject.toJSONString(), User.class);

        user = jsonObject.to(User.class);

        System.out.println(user.getName());
    }

    @Data
    public class User {
        String name;
    }

    public class UserReader implements ObjectReader<Object> {
        // 这里返回 user 仅为示例，JSONObject.to(...) 不会走到这里
        public Object readObject(JSONReader jsonReader, Type fieldType, Object fieldName, long features) {
            jsonReader.readObject();  //去掉这个就抛： input not end
            return new User();
        }

        public Object createInstance(long features) {
            return new User();
        }
    }

[jujn]

JSON.praseObject 底层调用自定义的readObject()实现反序列化，JSONObject.to反序列化底层只调用createInstance。所以同样的逻辑也要写在createInstance中，但是我觉得框架不应该让用户去实现这个。但是我不清楚 to 方法这里的设计意图，要等温老师有时间来看下了

[jfinal]

@jujn @wenshao 研究了一下源码，尤其是 ObjectReader 接口，清单体再小结一下问题和需求：

1: 假定定制反序列化针对的是 User 这个 Bean

2: 按官文档通过 ObjectReader 接口定制了反序列化实现类 UserObjectReader
https://alibaba.github.io/fastjson2/register_custom_reader_writer_cn

3: 定制之后，User 将无法通过 JSONObject.to(...)、JSONObject.getObject() 转换成 User 对象。

4: 但定制之前 JSONObject.to(...)、JSONObject.getObject() 可正常转换出 User 对象。

5: 看了一下 ObjectReader 代码，其实就是缺一个支持 JSONObject 参数的 readObject 方法，原型如下：

default T readObject(JSONObject jsonObject, Type fieldType, ......) {
     // 这个方法需要给出默认实现，默认按传统 java bean 去转换就可以了
}

目前该接口中只有一个支持 String 的 readObject 方法，原型如下：

default T readObject(String str, JSONReader.Feature... features) {
     ...
}

使用这个方法就必须将 JSONObject 先转换成 String，这对 fastjson 追求极致性来说，就太浪费资源了。

6: 希望官方在 ObjectReader 中添加一个 readObject(JSONObject jsonObject, Type fieldType, ......) 方法，并且给出默认实现（按传统 java bean 的 setter 方法转换即可）。否则目前只能先转成 json String，再进一步转换。

7: 这个问题可能还不算 bug。但缺乏这个 readObject(JSONObject jsonObject, Type fieldType, ......) 功能的话，在定制反序列化场景下 JSONObject.to(...) 必定抛出异常，会让人误以为是 bug。