当前位置：首页 > article >正文

序列化和反序列化 Json 字符串 @JSONField

article 2025/1/17 16:52:37

@JSONField 是 FastJSON 库中的一个注解，用于控制 JSON 序列化和反序列化过程中字段的映射。它提供了多种属性，可以灵活地定制 JSON 数据的生成和解析行为。以下是对 @JSONField 注解的详细说明和常见用法：

常见属性

name

作用：指定 JSON 键名。
示例：

@JSONField(name = "Mid")
private String mid;

说明：在 JSON 序列化和反序列化时，将 Java 类中的 mid 字段映射为 JSON 对象中的 "Mid" 键。

format

作用：指定日期格式。
示例：

@JSONField(format = "yyyy-MM-dd HH:mm:ss")
private Date createTime;

说明：在 JSON 序列化和反序列化时，将 createTime 字段格式化为 "yyyy-MM-dd HH:mm:ss" 格式的字符串。

serialize

作用：控制是否进行序列化。
示例：

@JSONField(serialize = false)
private String sensitiveInfo;

说明：在 JSON 序列化时，不包含 sensitiveInfo 字段。

deserialize

作用：控制是否进行反序列化。
示例：

@JSONField(deserialize = false)
private String internalInfo;

说明：在 JSON 反序列化时，不解析 internalInfo 字段。

ordinal

作用：指定字段的顺序。
示例：

@JSONField(ordinal = 1)
private String name;

@JSONField(ordinal = 2)
private int age;

说明：在生成 JSON 字符串时，name 字段会出现在 age 字段之前。

示例

假设我们有一个 User 类，其中包含多个字段，我们希望在 JSON 序列化和反序列化时进行一些定制：

import com.alibaba.fastjson.annotation.JSONField;
import java.util.Date;
@Data

public class User {
    @JSONField(name = "user_id")
    private int userId;

    @JSONField(name = "user_name")
    private String userName;

    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    @JSONField(serialize = false)
    private String password;

    @JSONField(deserialize = false)
    private String token;
}

序列化和反序列化示例

序列化

import com.alibaba.fastjson.JSON;

public class Main {
    public static void main(String[] args) {
        User user = new User(1, "Alice", new Date(), "secretPassword");
        String json = JSON.toJSONString(user);
        System.out.println(json);
    }
}

输出的 JSON 字符串将是：

{
  "user_id": 1,
  "user_name": "Alice",
  "createTime": "2025-01-15 12:00:00"
}

反序列化

import com.alibaba.fastjson.JSON;

public class Main {
    public static void main(String[] args) {
        String json = "{\"user_id\":1,\"user_name\":\"Alice\",\"createTime\":\"2025-01-15 12:00:00\"}";
        User user = JSON.parseObject(json, User.class);
        System.out.println(user.getUserId()); // 输出: 1
        System.out.println(user.getUserName()); // 输出: Alice
        System.out.println(user.getCreateTime()); // 输出: 2025-01-15 12:00:00
        System.out.println(user.getPassword()); // 输出: null
        System.out.println(user.getToken()); // 输出: null
    }
}