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

Java中的@JSONField注解详解：用法、场景与实践

news 来源：原创 2025/6/8 5:49:27

1. 注解引入

2. 常用属性及用法

2.1 name 属性

2.2 format 属性

2.3 serialize 和 deserialize 属性

2.4 ordinal 属性

3. 使用场景

3.1 数据交互

3.2 数据安全

3.3 日期格式化

4. 实践注意事项

@JSONField 是阿里巴巴开源的 JSON 处理库 FastJSON 提供的一个注解，用于在 Java 对象和 JSON 数据之间进行序列化和反序列化时，对字段的行为进行更精细的控制。以下是关于 @JSONField 注解的详细介绍：

1. 注解引入

在使用 @JSONField 注解之前，需要在项目中引入 FastJSON 依赖。如果你使用的是 Maven 项目，可以在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>2.0.33</version>
</dependency>

2. 常用属性及用法

2.1 `name` 属性

作用：指定该字段在 JSON 数据中的名称，当 Java 对象的字段名与 JSON 数据中的字段名不一致时，可以使用该属性进行映射。
示例：

import com.alibaba.fastjson.annotation.JSONField;

public class User {
    @JSONField(name = "user_name")
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

import com.alibaba.fastjson.JSON;

public class Main {
    public static void main(String[] args) {
        User user = new User("John", 25);
        String jsonStr = JSON.toJSONString(user);
        System.out.println(jsonStr); 
        // 输出: {"user_name":"John","age":25}
    }
}

2.2 `format` 属性

作用：用于指定日期类型字段的格式化方式，在序列化和反序列化时，将日期类型按照指定的格式进行转换。
示例：

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

public class Event {
    private String eventName;
    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    private Date eventTime;

    public Event(String eventName, Date eventTime) {
        this.eventName = eventName;
        this.eventTime = eventTime;
    }

    // Getters and Setters
    public String getEventName() {
        return eventName;
    }

    public void setEventName(String eventName) {
        this.eventName = eventName;
    }

    public Date getEventTime() {
        return eventTime;
    }

    public void setEventTime(Date eventTime) {
        this.eventTime = eventTime;
    }
}

import com.alibaba.fastjson.JSON;
import java.util.Date;

public class Main {
    public static void main(String[] args) {
        Event event = new Event("Conference", new Date());
        String jsonStr = JSON.toJSONString(event);
        System.out.println(jsonStr); 
        // 输出: {"eventName":"Conference","eventTime":"2024-10-01 12:34:56"}（日期根据实际情况）
    }
}

2.3 `serialize` 和 `deserialize` 属性

作用：serialize 用于控制该字段在序列化时是否包含在 JSON 数据中，deserialize 用于控制该字段在反序列化时是否从 JSON 数据中读取。
示例：

import com.alibaba.fastjson.annotation.JSONField;

public class Product {
    private String productName;
    @JSONField(serialize = false)
    private double costPrice;
    private double sellingPrice;

    public Product(String productName, double costPrice, double sellingPrice) {
        this.productName = productName;
        this.costPrice = costPrice;
        this.sellingPrice = sellingPrice;
    }

    // Getters and Setters
    public String getProductName() {
        return productName;
    }

    public void setProductName(String productName) {
        this.productName = productName;
    }

    public double getCostPrice() {
        return costPrice;
    }

    public void setCostPrice(double costPrice) {
        this.costPrice = costPrice;
    }

    public double getSellingPrice() {
        return sellingPrice;
    }

    public void setSellingPrice(double sellingPrice) {
        this.sellingPrice = sellingPrice;
    }
}

import com.alibaba.fastjson.JSON;

public class Main {
    public static void main(String[] args) {
        Product product = new Product("Laptop", 500, 800);
        String jsonStr = JSON.toJSONString(product);
        System.out.println(jsonStr); 
        // 输出: {"productName":"Laptop","sellingPrice":800}
    }
}

2.4 `ordinal` 属性

作用：指定字段在 JSON 数据中的顺序，数值越小越靠前。
示例：

import com.alibaba.fastjson.annotation.JSONField;

public class Book {
    @JSONField(ordinal = 2)
    private String title;
    @JSONField(ordinal = 1)
    private String author;

    public Book(String author, String title) {
        this.author = author;
        this.title = title;
    }

    // Getters and Setters
    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
}

import com.alibaba.fastjson.JSON;

public class Main {
    public static void main(String[] args) {
        Book book = new Book("J.K. Rowling", "Harry Potter");
        String jsonStr = JSON.toJSONString(book);
        System.out.println(jsonStr); 
        // 输出: {"author":"J.K. Rowling","title":"Harry Potter"}
    }
}