
当json数据中存在一个字段,其值本身是一个表示json数组的字符串时,jackson的默认反序列化机制无法直接将其解析为java的`list`对象。本文将深入探讨这一常见问题,并提供一种健壮的解决方案。我们将通过实现自定义的`jsondeserializer`和`contextualdeserializer`,动态获取目标类型信息,从而实现将嵌套的json字符串正确反序列化为指定类型的`list`集合。
问题场景:嵌套JSON字符串的处理
在处理复杂的JSON数据时,我们有时会遇到一种特殊情况:某个字段的值不是标准的JSON数组或对象,而是一个包含JSON数组或对象内容的“字符串”。例如,考虑以下JSON结构:
{ "name": "g1", "users": "[{"name":"u1","id":1},{"name":"u2","id":2}]"}
在这个JSON中,users字段的值是一个字符串,但该字符串内部实际上是一个标准的JSON数组,包含了两个用户对象。如果我们尝试将其反序列化为如下Java对象:
static class User { private String name; private Long id; // Getters and Setters public String getName() { return name; } public void setName(String name) { this.name = name; } public Long getId() { return id; } public void setId(Long id) { this.id = id; }}static class Group { private String name; private List users; // Getters and Setters public String getName() { return name; } public void setName(String name) { this.name = name; } public List getUsers() { return users; } public void setUsers(List users) { this.users = users; }}
并使用Jackson的ObjectMapper进行默认反序列化:
ObjectMapper objectMapper = new ObjectMapper();String jsonString = "{"name":"g1","users":"[{"name":"u1","id":1},{"name":"u2","id":2}]"}";Group group = objectMapper.readValue(jsonString, Group.class);
此时,Jackson会尝试将users字段的整个字符串值作为单个字符串处理,而不是将其解析为List。这会导致反序列化失败或得到一个空列表(取决于Jackson的版本和配置),因为Jackson期望在users字段处直接看到一个JSON数组([),而不是一个字符串(”)。
解决方案:自定义JsonDeserializer
为了正确处理这种嵌套的JSON字符串,我们需要编写一个自定义的Jackson反序列化器。这个反序列化器需要能够识别users字段是一个字符串,然后将这个字符串的内容作为独立的JSON数据再次解析。
JsonDeserializer与ContextualDeserializer
Jackson提供了JsonDeserializer接口,允许我们为特定类型T定义自定义的反序列化逻辑。然而,对于像List这样带有泛型参数的类型,仅仅实现JsonDeserializer<List>是不够的,因为在反序列化器初始化时,我们可能无法知道List内部的具体类型(例如,User)。
这时,ContextualDeserializer接口就派上了用场。通过实现ContextualDeserializer,我们的反序列化器可以在运行时获取到其被应用到的属性(BeanProperty)的上下文信息,包括其完整的泛型类型。这使得我们能够动态地确定需要解析的内部类型。
实现RawJsonDeserializer
以下是一个通用的RawJsonDeserializer实现,它能够处理将字符串形式的JSON内容反序列化为任何指定类型的对象,包括泛型列表:
JSON.NET 简单的使用 中文WORD版
本文档主要讲述的是JSON.NET 简单的使用;JSON.NET使用来将.NET中的对象转换为JSON字符串(序列化),或者将JSON字符串转换为.NET中已有类型的对象(反序列化?)。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看
0 查看详情
import com.fasterxml.jackson.core.JsonParser;import com.fasterxml.jackson.databind.BeanProperty;import com.fasterxml.jackson.databind.DeserializationContext;import com.fasterxml.jackson.databind.JavaType;import com.fasterxml.jackson.databind.JsonDeserializer;import com.fasterxml.jackson.databind.JsonMappingException;import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.databind.deser.ContextualDeserializer;import com.fasterxml.jackson.databind.type.SimpleType;import java.io.IOException;import java.util.List;public class RawJsonDeserializer extends JsonDeserializer implements ContextualDeserializer { private final JavaType type; // 存储目标类型 // 默认构造器,用于Jackson初始化 public RawJsonDeserializer() { // 初始类型设置为Object.class,会在createContextual中被更新 this.type = SimpleType.constructUnsafe(Object.class); } // 带类型参数的构造器,由createContextual调用 public RawJsonDeserializer(JavaType type) { this.type = type; } /** * createContextual方法是ContextualDeserializer的核心。 * 它在反序列化器被应用到特定属性时调用,允许我们根据属性的上下文信息创建 * 一个新的、具有特定类型参数的反序列化器实例。 */ @Override public JsonDeserializer createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException { // property.getType() 获取当前属性的完整类型信息,例如 List // 我们创建一个新的RawJsonDeserializer实例,并将此类型传递给它 return new RawJsonDeserializer(property.getType()); } /** * deserialize方法执行实际的反序列化逻辑。 * 它接收当前JSON字段的JsonParser和DeserializationContext。 */ @Override public T deserialize(JsonParser p, DeserializationContext ctxt) throws IOException { // p.getText() 获取当前JSON字段的原始字符串值 // p.getCodec() 获取当前使用的ObjectMapper实例 // 然后,我们使用这个ObjectMapper将获取到的字符串再次解析为之前在createContextual中确定的目标类型 (this.type) return ((ObjectMapper) p.getCodec()).readValue(p.getText(), type); }}
代码解析:
RawJsonDeserializer() 构造器: 这是一个无参构造器,Jackson在初步加载反序列化器时会调用它。此时我们不知道具体的泛型类型,所以暂时将type设置为Object.class。RawJsonDeserializer(JavaType type) 构造器: 这是一个带JavaType参数的构造器,用于在createContextual方法中创建新的反序列化器实例,并传入具体的类型信息。createContextual(DeserializationContext ctxt, BeanProperty property):这个方法是ContextualDeserializer接口的核心。当Jackson发现某个属性需要使用此自定义反序列化器时,它会调用此方法。property.getType():这是关键所在!它返回当前被反序列化的Java属性的完整类型信息,例如,对于List users;,它将返回一个代表List的JavaType对象。我们利用这个JavaType创建一个新的RawJsonDeserializer实例,并将其返回。Jackson会使用这个新的实例来处理当前属性的反序列化。deserialize(JsonParser p, DeserializationContext ctxt):这是实际执行反序列化逻辑的方法。p.getText():获取当前JSON token(在这里是users字段的字符串值)的文本内容,即”[{“name”:”u1″,”id”:1},{“name”:”u2″,”id”:2}]”。((ObjectMapper) p.getCodec()):从当前的JsonParser中获取正在使用的ObjectMapper实例。readValue(p.getText(), type):使用获取到的ObjectMapper,将p.getText()(即那个嵌套的JSON字符串)再次解析,这次是解析成在createContextual中确定的type(例如List)。这样,Jackson就能正确地将内部字符串解析为List对象。
应用自定义反序列化器
将上述自定义反序列化器应用到我们的Group类中的users字段上,需要使用@JsonDeserialize注解:
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;import java.util.List;static class User { private String name; private Long id; public String getName() { return name; } public void setName(String name) { this.name = name; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } @Override public String toString() { return "User{name='" + name + "', id=" + id + '}'; }}static class Group { private String name; // 使用@JsonDeserialize注解指定自定义反序列化器 @JsonDeserialize(using = RawJsonDeserializer.class) private List users; public String getName() { return name; } public void setName(String name) { this.name = name; } public List getUsers() { return users; } public void setUsers(List users) { this.users = users; } @Override public String toString() { return "Group{name='" + name + "', users=" + users + '}'; }}
现在,当Jackson反序列化Group对象时,遇到users字段,它会调用RawJsonDeserializer来处理。RawJsonDeserializer会先获取users字段的字符串值,然后将其重新解析为List。
完整示例代码:
import com.fasterxml.jackson.core.JsonParser;import com.fasterxml.jackson.databind.BeanProperty;import com.fasterxml.jackson.databind.DeserializationContext;import com.fasterxml.jackson.databind.JavaType;import com.fasterxml.jackson.databind.JsonDeserializer;import com.fasterxml.jackson.databind.JsonMappingException;import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.databind.annotation.JsonDeserialize;import com.fasterxml.jackson.databind.deser.ContextualDeserializer;import com.fasterxml.jackson.databind.type.SimpleType;import java.io.IOException;import java.util.List;public class JacksonNestedJsonStringToList { // ... (RawJsonDeserializer, User, Group classes as defined above) ... public static void main(String[] args) throws IOException { ObjectMapper objectMapper = new ObjectMapper(); String jsonString = "{"name":"g1","users":"[{"name":"u1","id":1},{"name":"u2","id":2}]"}"; Group group = objectMapper.readValue(jsonString, Group.class); System.out.println("Deserialized Group: " + group); if (group != null && group.getUsers() != null) { System.out.println("Users list size: " + group.getUsers().size()); group.getUsers().forEach(user -> System.out.println(" " + user)); } }}
运行上述代码,将得到以下输出:
Deserialized Group: Group{name='g1', users=[User{name='u1', id=1}, User{name='u2', id=2}]}Users list size: 2 User{name='u1', id=1} User{name='u2', id=2}
这表明嵌套的JSON字符串已成功反序列化为List对象。
注意事项与最佳实践
性能开销: 这种方法涉及两次JSON解析:第一次是Jackson解析外部JSON结构时将users字段作为字符串读取,第二次是自定义反序列化器将这个字符串再次解析为内部的List。这会带来一定的性能开销。如果性能是关键考量,并且你有能力修改原始JSON结构,最好将users字段直接修改为JSON数组而不是字符串。适用场景: 此方法特别适用于你无法控制JSON源数据格式,但又必须处理这种“JSON字符串中嵌套JSON”的情况。例如,某些遗留系统或第三方API可能返回此类数据。错误处理: deserialize方法内部的readValue可能会抛出IOException。在实际应用中,你可能需要添加更健壮的错误处理逻辑,例如捕获异常并转换为JsonMappingException,或者返回一个默认值。通用性: RawJsonDeserializer设计得非常通用,它可以用于反序列化任何以字符串形式存在的JSON内容到任何Java类型,不仅仅是List。
总结
通过实现Jackson的JsonDeserializer和ContextualDeserializer接口,我们成功地解决了将嵌套在字符串中的JSON数组反序列化为Java List对象的问题。ContextualDeserializer的强大之处在于其能够在运行时动态获取属性的类型信息,从而使得自定义反序列化器能够适应各种泛型类型。虽然这种方法会引入双重解析的性能开销,但它为处理不规范的JSON数据提供了一个灵活且强大的解决方案。
以上就是Jackson反序列化:将嵌套JSON字符串解析为List对象的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1024019.html
微信扫一扫
支付宝扫一扫