Json序列化和反序列化还有这种玩法

时间：2022-06-01 19:33:12

Json序列化和反序列化还有这种玩法

Mixin对于前端开发者可不陌生，Vue、React等知名前端框架都使用了Mixin。而对于后端开发，尤其是Java后端开发来说Mixin却是一个很陌生的概念。今天来我们通过Jackson让后端开发者也来认识一下Mixin。

场景

比如我们引用了一个Jar包，其中的某个类在某个场景需要反序列化，但是这个类没有提供默认构造。咋办呢?把原来的项目拉下来，重写一下?下下策! 你可以使用Jackson提供的Mixin特性来解决这个问题。

Jackson中的Mixin

Jackson中的Mixin(混入)我们可以这样解读它：将目标对象无法实现的序列化或反序列化功能通过一个混入对象进行配置，在序列化或反序列化的时候把这些个性化配置混入到目标对象中。混入不改变目标对象本身的任何特性，混入对象和目标对象是映射的关系。接下来我们来实现一个混入的DEMO。

Mixin的实现

我们有一个User类，为了演示需要，我们极端一些，实际开发中不太会出现这种极端情况。这个User没有无参构造，也没有属性的getter方法。

  1. public class User {
  2. private final String name;
  3. private final Integer age;
  5. public User(String name, Integer age) {
  6. this.name = name;
  7. this.age = age;
  8. }
  9. @Override
  10. public String toString() {
  11. return "User{" +
  12. "name='" + name + '\'' +
  13. ", age=" + age +
  14. '}';
  15. }
  16. }

编写Mixin类

我想对这个极端的User进行序列化和反序列化。按以前的玩法我们在User类上加上@JsonAutoDetect注解就可以实现序列化了;加上@JsonDeserialize注解并指定反序列化类就可以反序列化了。不过今天我们不需要对User进行任何更改，只需要编写一个Mixin类把上述两个注解配置好就可以了。

  1. @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
  2. isGetterVisibility = JsonAutoDetect.Visibility.NONE)
  3. @JsonIgnoreProperties(ignoreUnknown = true)
  4. @JsonDeserialize(using = UserMixin.UserDeserializer.class)
  5. public abstract class UserMixin {
  7. /**
  8. * 反序列化类
  9. **/
  10. static class UserDeserializer extends JsonDeserializer<User> {
  12. @Override
  13. public User deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
  14. ObjectMapper mapper = (ObjectMapper) p.getCodec();
  15. JsonNode jsonNode = mapper.readTree(p);
  17. String name = readJsonNode(jsonNode, "name").asText(null);
  18. String age = readJsonNode(jsonNode, "age").asText(null);
  19. Integer ageVal = Objects.isNull(age)? null: Integer.valueOf(age);
  20. return new User(name,ageVal);
  21. }
  23. private JsonNode readJsonNode(JsonNode jsonNode, String field) {
  24. return jsonNode.has(field) ? jsonNode.get(field) : MissingNode.getInstance();
  25. }
  26. }
  28. }

其它注解可以参考往期的Jackson文章的介绍

Mixin映射目标类

编写完Mixin类后，我们通过ObjectMapper中的addMixIn方法把UserMixin和User映射起来。并编写一个序列化和反序列化的例子。

  1. ObjectMapper objectMapper = new ObjectMapper();
  2. objectMapper.addMixIn(User.class, UserMixin.class);
  4. User felord = new User("felord", 12);
  5. String json = objectMapper.writeValueAsString(felord);
  6. //{"name":"felord","age":12}
  7. System.out.println("json = " + json);
  9. String jsonStr = "{\"name\":\"felord\",\"age\":12}";
  11. User user = objectMapper.readValue(jsonStr, User.class);
  12. // User{name='felord', age=12}
  13. System.out.println("user = " + user);

这样我们在不对目标类进行任何改变的情况下实现了个性化的JSON序列化和反序列化。

Jackson中的Module

Jackson还提供了模块化功能，可以将个性化配置进行模块化统一管理，而且可以按需引用，甚至可插拔。它同样能够管理一组Mixin。声明一个Jackson Module非常简单，继承SimpleModule覆写它的一些方法即可。针对Mixin我们可以这样写：

  1. public class UserModule extends SimpleModule {
  2. public UserModule() {
  3. super(UserModule.class.getName());
  4. }
  6. @Override
  7. public void setupModule(SetupContext context) {
  8. context.setMixInAnnotations(User.class,UserMixin.class);
  9. }
  10. }

Module同样可以注册到ObjectMapper中，同样也能实现我们想要的效果：

  1. ObjectMapper objectMapper = new ObjectMapper();
  2. objectMapper.registerModule(new UserModule());
  3. // 省略

Module的功能更加强大。平常我们会使用以下几个Module:

  • jackson-module-parameter-names 此模块能够访问构造函数和方法参数的名称
  • jackson-datatype-jdk8 除了Java8的时间API外其它新特性的的支持
  • jackson-datatype-jsr310 用以支持Java8新增的JSR310时间API

另外Spring Security也提供了Module支持SecurityJackson2Modules，它包含了下面的一些模块：

  1. ObjectMapper mapper = new ObjectMapper();
  2. mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
  3. mapper.registerModule(new CoreJackson2Module());
  4. mapper.registerModule(new CasJackson2Module());
  5. mapper.registerModule(new WebJackson2Module());
  6. mapper.registerModule(new WebServletJackson2Module());
  7. mapper.registerModule(new WebServerJackson2Module());
  8. mapper.registerModule(new OAuth2ClientJackson2Module());

建议看一下SecurityJackson2Modules源码，研究并模仿一下Module的使用。

原文链接：https://mp.weixin.qq.com/s/WlOFyInuHtNjeGZhVjz5ZA

标签：

相关文章