SpringBoot 如何隐藏模型字段，避免返回敏感信息

Spring Boot 如何隐藏模型字段，避免返回敏感信息

在开发 Spring Boot 应用时，我们经常需要通过 API 返回模型数据。然而，有些字段可能包含敏感信息，例如密码或密钥，我们不希望这些信息暴露在 API 返回结果中。本文将介绍如何使用 @JsonIgnore 和 @JsonProperty 注解来隐藏模型字段，提高 API 安全性。

使用 @JsonIgnore 注解

@JsonIgnore 注解可以标记模型中不希望被序列化和反序列化的字段。这意味着，被 @JsonIgnore 标记的字段将不会出现在 API 返回结果中，也不会被用于反序列化请求数据。

**示例代码：**javapublic class User { private String username; @JsonIgnore private String password; // getters and setters}

在上述示例中，User 类的 password 字段被标记为 @JsonIgnore，因此在返回结果中将不会包含该字段。

注意： 使用 @JsonIgnore 注解会影响到该字段的序列化和反序列化，因此在需要对该字段进行操作时需要注意。

使用 @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 注解

如果我们只想在 API 返回结果中隐藏字段，但仍然希望在反序列化请求数据时使用该字段，可以使用 @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 注解。

**示例代码：**javapublic class User { private String username; @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) private String password; // getters and setters}

在上述示例中，User 类的 password 字段被标记为 @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)，因此在返回结果中将不会包含该字段，但在反序列化时会被忽略。

总结

通过使用 @JsonIgnore 和 @JsonProperty 注解，我们可以灵活地控制 Spring Boot 模型字段的返回，保护敏感信息，提高 API 安全性。选择哪种注解取决于具体的业务需求。