博客

fastjson转换对象实体@JsonProperty不生效问题及解决

  • Post category:http

下面我将详细介绍“Fastjson转换对象实体@JsonProperty不生效问题及解决”的完整攻略。

问题描述：

在使用Fastjson进行对象转换时，发现@JsonProperty注解不生效，导致无法将JSON字符串转换成对应的Java对象。具体表现为：

  • 对象转JSON字符串时，实体类属性使用了@JsonProperty注解，但是最终生成的JSON字符串中并没有按照指定的属性名进行序列化。
  • JSON字符串转对象时，实体类属性使用了@JsonProperty注解，但是转换时对应的值并未映射到实体类对应的属性上。

原因分析：

Fastjson默认是根据JavaBean规范进行序列化和反序列化的，因此对于@JsonProperty注解不会进行特殊处理。但是Jackson框架支持@JsonProperty注解，原因是Jackson框架本身设计时就考虑到了JavaBean规范之外的情况。

因此，如果我们希望Fastjson也能够支持@JsonProperty注解，需要进行特殊的配置。

解决方案：

Fastjson在注解映射时，会首先判断@JsonField注解，如果没有则使用JavaBean规范进行映射，因此我们可以使用@JsonField注解代替@JsonProperty注解。

public class User {
  @JsonField(name = "userName")
  private String name;
  @JsonField(name = "userAge")
  private int age;

  // Getter and Setter methods
}

一般情况下，我们可能会希望@JsonProperty注解能够直接生效，而不是通过替代注解的方式。

因此，我们可以通过自定义序列化和反序列化的方式，实现Fastjson对@JsonProperty注解的支持。

  1. 实现反序列化器：
public class JsonPropertyProcessor implements ObjectDeserializer {
  @Override
  public <T> T deserialze(DefaultJSONParser parser, Type type, Object fieldName) {
    JSONObject object = parser.parseObject();
    T t = JSON.parseObject(object.toJSONString(), type);
    return t;
  }

  @Override
  public int getFastMatchToken() {
    return JSONToken.LBRACE;
  }
}
  1. 实现序列化器：
public class JsonPropertyProcessor implements ObjectSerializer {
  @Override
  public void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features) throws IOException {
    JSONObject jsonObject = new JSONObject();
    Class<?> clazz = object.getClass();
    Field[] fields = clazz.getDeclaredFields();
    for (Field field : fields) {
      String name = field.getName();
      JsonProperty jsonProperty = field.getAnnotation(JsonProperty.class);
      if (jsonProperty != null) {
        name = jsonProperty.value();
      }
      field.setAccessible(true);
      try {
        jsonObject.put(name, field.get(object));
      } catch (IllegalAccessException e) {
        e.printStackTrace();
      }
    }
    serializer.write(jsonObject, fieldType);
  }

  @Override
  public boolean writeDirect(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features) throws IOException {
    write(serializer, object, fieldName, fieldType, features);
    return true;
  }
}
  1. 注册反序列化器和序列化器：
ParserConfig.getGlobalInstance().putDeserializer(User.class, new JsonPropertyProcessor());
SerializeConfig.getGlobalInstance().put(User.class, new JsonPropertyProcessor());

这样，我们就能够在Fastjson中使用@JsonProperty注解进行属性映射了。

示例说明：

以下是使用@GetMapping注解获取请求参数并将JSON字符串转换为Java对象的示例：

@GetMapping("/user")
public Object getUser(@RequestParam("jsonStr") String jsonStr) {
  JsonPropertyProcessor jsonPropertyProcessor = new JsonPropertyProcessor();
  User user = jsonPropertyProcessor.deserialze(new DefaultJSONParser(jsonStr), User.class, null);
  return user;
}

以下是使用@PostMapping注解将Java对象转换为JSON字符串的示例：

@PostMapping("/user")
public Object saveUser(@RequestBody User user) {
  JsonPropertyProcessor jsonPropertyProcessor = new JsonPropertyProcessor();
  String jsonStr = JSON.toJSONString(user, jsonPropertyProcessor, SerializerFeature.WriteMapNullValue);
  return jsonStr;
}

这两个示例都是基于对Fastjson进行特殊配置的情况下使用@JsonProperty注解进行属性映射的。

Tags: