fastjson2 简单使用

news2024/10/5 21:56:12

参考

https://alibaba.github.io/fastjson2/
https://alibaba.github.io/fastjson2/annotations_cn.html
https://alibaba.github.io/fastjson2/features_cn

基本操作

json 字符串转为 jsonObject：

String json = "{\"name\":\"tom\",\"age\":18}";
JSONObject data = JSON.parseObject(json);

json 字符串转为 jsonArray：

String json = "[{\"name\":\"Alice\",\"age\":25,\"city\":\"Exampleville\"},{\"name\":\"Bob\",\"age\":30," +
        "\"city\":\"Sampleburg\"},{\"name\":\"Charlie\",\"age\":28,\"city\":\"Testington\"}]";
final JSONArray jsonArray = JSON.parseArray(json);

json 字符串转为 java 对象：

String json = "{\"name\":\"tom\",\"age\":18}";
User user = JSON.parseObject(json, User.class);

java 对象转为 json 字符串：

final User user = new User();
user.setName("tom");
user.setAge(18);
final String jsonString = JSON.toJSONString(user);

操作 json：

String json = "{\"name\":\"JohnDoe\",\"age\":30,\"city\":\"NewYork\",\"isStudent\":false,\"grades\":[85,90," +
        "78,92],\"address\":{\"street\":\"123MainSt\",\"zipCode\":\"10001\"},\"contact\":{\"email\":\"john" +
        ".doe@example.com\",\"phoneNumbers\":[\"555-1234\",\"555-5678\"]},\"balance\":1200.75}";
final JSONObject jsonObject = JSON.parseObject(json);
final String name = jsonObject.getString("name");
final Integer age = jsonObject.getInteger("age");
final JSONArray grades = jsonObject.getJSONArray("grades");
final JSONObject address = jsonObject.getJSONObject("address");
final String street = address.getString("street");
final Double balance = jsonObject.getDouble("balance");

fastjson2 中提供了 json 中对象和数组的对应表示，对象使用 JSONObject 表示，列表使用 JSONArray 表示，JSONObject、JSONArray 也都提供了相应的操作方法来实现获取值、添加值、更新值、删除值等操作（方法都很通俗易懂，get 开头就是获取值，set 开头的方法就是更新值，方法名和 remove 类似的就是删除操作，非常简单）。

高级操作

枚举类序列化时指定序列化使用的字段

第一种实现方法比较复杂，是使用自定义序列化器实现：

@Getter
public enum Season {
    SPRING("春天", "万物复苏"),
    SUMMER("夏天", "热"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬季", "冷");

    private final String description;

    private final String features;

    Season(String description, String features) {
        this.description = description;
        this.features = features;
    }

}

@Data
public class Student {
    public String name;
    public Integer age;
    public Season favoriteSeason;
}

// enum 默认序列化成 json
final Student student = new Student();
student.setAge(18);
student.setName("tom");
student.setFavoriteSeason(Season.SUMMER);
System.out.println(JSON.toJSONString(student));

// 使用序列化器指定枚举类序列化时使用的字段
final ObjectWriter<Season> seasonWriter = (jsonWriter, fieldValue, fieldName, type, l) -> {
    if (fieldValue instanceof Season) {
        jsonWriter.writeString(((Season) fieldValue).getDescription());
    } else {
        jsonWriter.writeAny(fieldValue);
    }
};

final ObjectWriterProvider objectWriterProvider = new ObjectWriterProvider();
objectWriterProvider.register(Season.class, seasonWriter);
final JSONWriter.Context writeContext = JSONFactory.createWriteContext(objectWriterProvider);
final String jsonString = JSON.toJSONString(student, writeContext);
System.out.println(jsonString);

从结果中可以看到，enum 默认序列化时使用的是枚举常量，我们使用自定义序列化器指定序列化 Season 枚举类时使用它的 description 字段作为字段值。

还有更简单的方法，就是使用 @JSONField(value = true)注解设置枚举类要序列化时使用的字段，下面的 jsonField 注解的使用这个章节中讲了。

jsonField 注解的使用

@Data
public class Student {
    @JSONField(ordinal = 2)
    private Integer age;
    private Season favoriteSeason;
    @JSONField(ordinal = 1)
    private String name;
    @JSONField(format = "yyyyMMdd")
    private Date birthday;
    @JSONField(serialize = false)
    private String address;
    @JSONField(deserialize = false)
    private String favoriteFood;
    @JSONField(name = "GENDER")
    private Gender gender;
}

@JSONField(ordinal = 2)注解设置了字段在序列化为 json 后的排列顺序，越小排在越前。
@JSONField(format = "yyyyMMdd")注解设置了在序列化 Date 类型的 birthday 字段时使用的日期格式。
@JSONField(serialize = false)注解设置了 address 字段不会被序列化，也就是序列化的结果中不会包含 address 字段。
@JSONField(deserialize = false)注解设置了将 json 序列化成 student 对象时不会序列化 favoriteFood 字段，也就是 favoriteFood 字段会为 null
@JSONField(name = "GENDER")注解设置了 gender 字段序列化成 json 时的字段名为 GENDER。

如果类的字段是 public 并且有 get 和 set 方法，@JSONField(deserialize = false) 会失效。bean 类都尽量标准一点，属性都设置为 private，提供 get 和 set 方法，这样会减少异常的发生。

@Getter
public enum Season {
    SPRING("春天", "万物复苏"),
    SUMMER("夏天", "热"),
    AUTUMN("秋天", "秋高气爽"),
    WINTER("冬季", "冷");

    private final String description;

    @JSONField(value = true)
    private final String features;

    Season(String description, String features) {
        this.description = description;
        this.features = features;
    }
}

@JSONField(value = true)设置了 Season 枚举类序列化成 json 时会使用 features 字段做为其值，而不是默认使用的枚举常量。

jsonPath 从 json 字符串中读取字段值

String str = "{\"address\":\"翻斗大街翻斗花园二号楼1001室\",\"favoriteFood\":\"炸小肉丸\",\"name\":\"图图\",\"age\":3,\"id\":10}";

JSONPath path = JSONPath.of("$.id");
JSONReader parser = JSONReader.of(str);
Integer result = (Integer) path.extract(parser);

System.out.println(result);