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

下面给你详细讲解" fastjson转换对象实体@JsonProperty不生效问题及解决 "的完整攻略。

问题描述

在使用fastjson进行对象序列化和反序列化的过程中，我们可能会遇到@JsonProperty注解不生效的问题。通常情况下，使用这个注解可以将java对象序列化成json字符串时使用自定义的属性名，反之，也可以将自定义的属性名反序列化成java对象的属性名。但有些时候，@JsonProperty注解却不生效，导致序列化和反序列化结果不符合预期。这时候，就需要我们进行解决，下面是解决方法。

解决方法

方法一：使用@JSONField注解代替@JsonProperty注解

fastjson也提供了@JSONField注解，它与@JsonProperty注解的作用是相似的。下面举个例子。

public class User {
    @JSONField(name = "userId")
    private int id;
    @JSONField(name = "userName")
    private String name;

    // Getter、Setter 省略
}

上面的代码就使用了@JSONField注解来指定json数据中的属性名，可以发现，使用@JSONField注解同样可以达到反序列化和序列化自定义属性名的目的。

方法二：启用globalAutoDetect属性

fastjson的全局配置有一个属性globalAutoDetect，当它被设定为true时，fastjson会自动识别@JsonProperty注解。下面举个例子。

public static void main(String[] args) {
    User user = new User();
    user.setId(1);
    user.setName("Tom");

    // 启用 globalAutoDetect 属性
    JSON.DEFAULT_PARSER_FEATURE |= Feature.AutoDetectField.getMask();

    // 序列化和反序列化过程
    String userJson = JSON.toJSONString(user);
    User newUser = JSON.parseObject(userJson, User.class);

    System.out.println(userJson);
    System.out.println(newUser);
}

上面的代码展示了如何启用globalAutoDetect属性，通过设置JSON.DEFAULT_PARSER_FEATURE属性的值来实现，然后使用同样的方式进行序列化和反序列化。这样JsonProperty注解就会生效了。

示例说明

示例一

下面是一个User类的定义，使用@JsonProperty注解标注了id属性和name属性的属性名。

public class User {
    @JsonProperty("userId")
    private int id;
    @JsonProperty("userName")
    private String name;

    // Getter、Setter 省略
}

我们将它序列化为json字符串，代码如下。

User user = new User();
user.setId(1);
user.setName("Tom");

String userJson = JSON.toJSONString(user);
System.out.println(userJson);

输出结果为：

{"name":"Tom","id":1}

可以发现，@JsonProperty注解不生效，导致输出结果与我们预期的不符。

我们可以使用第一种方式，将@JsonProperty注解替换为@JSONField注解，实现我们的需求，代码如下。

public class User {
    @JSONField(name = "userId")
    private int id;
    @JSONField(name = "userName")
    private String name;

    // Getter、Setter 省略
}

User user = new User();
user.setId(1);
user.setName("Tom");

String userJson = JSON.toJSONString(user);
System.out.println(userJson);

输出结果为：

{"userId":1,"userName":"Tom"}

可以发现，@JSONField注解生效了，输出结果与我们预期的一致。

示例二

下面的代码是一个User类的定义，使用了@JsonProperty注解。

public class User {
    @JsonProperty("userId")
    private int id;
    @JsonProperty("userName")
    private String name;

    // Getter、Setter 省略
}

我们将一个自定义属性名的json字符串反序列化为java对象，代码如下。

String userJson = "{\"userName\":\"Tom\",\"userId\":1}";

User newUser = JSON.parseObject(userJson, User.class);
System.out.println(newUser.getName() + "," + newUser.getId());

输出结果为：

Tom,0

可以发现，虽然我们使用了@JsonProperty注解，但是它依然没有生效，反序列化没有按照预期进行。

我们可以使用第二种方式，启用globalAutoDetect属性，代码如下。

String userJson = "{\"userName\":\"Tom\",\"userId\":1}";

// 启用 globalAutoDetect 属性
JSON.DEFAULT_PARSER_FEATURE |= Feature.AutoDetectField.getMask();

User newUser = JSON.parseObject(userJson, User.class);
System.out.println(newUser.getName() + "," + newUser.getId());

输出结果为：

Tom,1

可以发现，启用globalAutoDetect属性后，@JsonProperty注解生效了，反序列化结果按照预期进行。