1. 概述
Jackson 提供了一套强大的注解，用于定制 Java 对象与 JSON 之间的序列化和反序列化过程。其中一个非常灵活的注解是@JsonSerialize，它用于为对象指定自定义序列化器。在本教程中，我们将通过一个员工管理系统来深入了解这个注解的使用。
@JsonSerialize 注解概览
Jackson 的@JsonSerialize 注解用于定义 Java 对象或属性的自定义序列化器。它赋予开发者对 JSON 输出更大的控制权，允许进行比 Jackson 默认提供的更精细的序列化定制。
2. 开发步骤
- 创建新 Maven 项目：建立一个新的 Maven 项目。
- 添加必要的 Jackson 依赖：引入所需的 Jackson 依赖项。
- 构建 Employee 类：应用@JsonSerialize 注解。
- 定义自定义序列化器类：编写处理特定序列化逻辑的类。
- 创建带有主方法的演示类：展示功能。
3. 创建 Maven 项目
创建简单的 Maven 项目可以通过以下几种方式：
- 使用命令行接口
- 使用 Eclipse IDE
- 使用 IntelliJ IDEA
4. Maven 依赖项
在 pom.xml 文件中添加如下 Jackson 数据绑定依赖项：
<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.0</version>
</dependency>
5. 代码示例
Employee.java
import com.fasterxml.jackson.databind.annotation.JsonSerialize;public class Employee {private int empId;private String empName;private double salary;// Using a custom serializer for the salary property@JsonSerialize(using = SalarySerializer.class)public double getSalary() {return salary;}public Employee(int empId, String empName, double salary) {this.empId = empId;this.empName = empName;this.salary = salary;}public int getEmpId() { return empId; }public String getEmpName() { return empName; }
}
SalarySerializer.java
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;public class SalarySerializer extends JsonSerializer<Double> {@Overridepublic void serialize(Double value, JsonGenerator gen, SerializerProvider serializers) throws IOException {// Display salary rounded to two decimal places as a stringgen.writeString(String.format("%.2f", value));}
}
MainClass.java
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;public class MainClass {public static void main(String[] args) {Employee employee = new Employee(1, "Alice", 5000.4567);ObjectMapper mapper = new ObjectMapper();try {String json = mapper.writeValueAsString(employee);System.out.println("序列化的 JSON: " + json);} catch (JsonProcessingException e) {e.printStackTrace();}}
}
输出结果将会是：
{"empId":1,"empName":"Alice","salary":"5000.46"}
代码解释
在 Employee 类中，salary 属性使用了@JsonSerialize 注解指定了 SalarySerializer 作为其序列化器。这个自定义序列化器修改了 salary 属性的序列化方式，将其值四舍五入到两位小数并以字符串形式表示。MainClass 展示了如何使用 ObjectMapper 来序列化 Employee 对象，并展示了自定义序列化的效果。
6. 结论
Jackson 的@JsonSerialize 注解提供了一种强大且灵活的方法来自定义对象或属性的序列化逻辑。通过实现自定义序列化器，开发者可以精确控制 JSON 输出的内容和格式，从而满足各种特殊需求。这在需要对数据进行特殊格式化、加密、转换等情况下特别有用。此外，这种做法也提高了代码的可维护性和复用性，因为序列化逻辑被封装到了独立的类中。
