### @JsonFormat 注解的使用方式及 Shape.STRING 的作用 #### @JsonFormat 注解简介 `@JsonFormat` 是 Jackson 库中的一个重要注解，主要用于定制日期时间字段或其他复杂类型的序列化和反序列化的格式。它可以通过多种参数来控制 JSON 数据的输入输出形式[^6]。 #### 参数说明 - **shape**: 指定数据的表现形式，默认为 `Shape.ANY`，表示不强制指定形状。其他常见选项包括： - `Shape.OBJECT`: 将字段作为对象处理。 - `Shape.ARRAY`: 将字段作为数组处理。 - `Shape.NUMBER`: 将字段视为数值型。 - `Shape.STRING`: 强制将字段序列化为字符串[^7]。 当我们将 `shape` 设置为 `JsonFormat.Shape.STRING` 时，无论底层的数据结构是什么，都会将其转化为字符串的形式进行传输或存储。 #### 示例代码 假设我们有一个包含账户类型 (`accountType`) 的实体类，并希望通过 `@JsonFormat` 将其序列化为字符串： ```java import com.fasterxml.jackson.annotation.JsonFormat; public class Account { private String name; @JsonFormat(shape = JsonFormat.Shape.STRING) private AccountType accountType; // Getters and Setters public String getName() { return name; } public void setName(String name) { this.name = name; } public AccountType getAccountType() { return accountType; } public void setAccountType(AccountType accountType) { this.accountType = accountType; } } // 枚举类型 AccountType public enum AccountType { SAVINGS, CHECKING, CREDIT_CARD } ``` 在这个例子中，`accountType` 字段是一个枚举类型。通过添加 `@JsonFormat(shape = JsonFormat.Shape.STRING)` 注解，可以确保在序列化过程中，Jackson 不会尝试将整个枚举对象转成复杂的 JSON 结构，而是简单地将其名称（如 `"SAVINGS"`）作为字符串写入最终的 JSON 输出中[^8]。 #### 实际效果演示 下面展示了一个简单的测试案例，验证上述配置的效果： ```java import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; public class TestSerialization { public static void main(String[] args) throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); Account account = new Account(); account.setName("John Doe"); account.setAccountType(AccountType.SAVINGS); String jsonString = mapper.writeValueAsString(account); System.out.println(jsonString); // 输出 {"name":"John Doe","accountType":"SAVINGS"} } } ``` 可以看到，尽管 `accountType` 是一个枚举类型，但由于设置了 `@JsonFormat(shape = JsonFormat.Shape.STRING)`，它的值成功被序列化成了纯字符串形式。 --- ### 总结 通过对 `@JsonFormat(shape = JsonFormat.Shape.STRING)` 的合理运用，可以使某些特殊类型的字段更加简洁明了地表达出来，尤其适用于需要保持兼容性的外部接口或者简化内部逻辑的情况。此方法特别适合处理诸如日期、时间戳以及枚举等非基本数据类型的场合。 ---