如何动态忽略 Spring MVC JSON 响应中的字段？

在 Spring MVC JSON 响应中动态忽略 Java 对象中的字段

在 Spring MVC 中，您可能会遇到需要在序列化时动态忽略 Java 对象中的特定字段的场景它们作为 JSON。这在处理包含某些客户端或端点的敏感或不相关数据的对象时特别有用。

考虑以下使用 Hibernate 的 @Entity 注释的 Java 模型类：

<code class="java">@Entity
@Table(name = "user", catalog = "userdb")
@JsonIgnoreProperties(ignoreUnknown = true)
public class User implements java.io.Serializable {

    // ... Class definition omitted for brevity
}</code>

在 Spring MVC 中在控制器中，您从数据库检索 User 对象并将其作为 JSON 响应返回：

<code class="java">@Controller
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/getUser/{userId}", method = RequestMethod.GET)
    @ResponseBody
    public User getUser(@PathVariable Integer userId) throws Exception {

        User user = userService.get(userId);
        user.setCreatedBy(null);
        user.setUpdatedBy(null);
        return user;
    }
}</code>

默认情况下，User 对象的 JSON 表示形式将包含其所有字段。但是，您可能希望从某些响应中排除敏感字段，例如 cryptoPwd、createdBy 和 UpdatedBy。

实现此目的的一种方法是在返回对象之前手动将不需要的字段设置为 null。然而，这种方法容易出错且效率低下。

更优雅的解决方案是使用 @JsonIgnoreProperties 注解。您可以使用注释中的属性名称来指定要忽略的字段：

<code class="java">@Entity
@Table(name = "user", catalog = "userdb")
@JsonIgnoreProperties(ignoreUnknown = true, value = {"encryptedPwd", "createdBy", "updatedBy"})
public class User implements java.io.Serializable {

    // ... Class definition omitted for brevity
}</code>

使用此注释，字段encryptedPwd、createdBy 和updatedBy 将从JSON 表示中排除。

或者，您可以在各个字段上使用 @JsonIgnore 注释：

<code class="java">@Entity
@Table(name = "user", catalog = "userdb")
@JsonIgnoreProperties(ignoreUnknown = true)
public class User implements java.io.Serializable {

    @JsonIgnore
    private String encryptedPwd;
    private String createdBy;

    // ... Class definition omitted for brevity
}</code>

通过使用 @JsonIgnore 注释 cryptoPwd 字段，您可以显式地将其从 JSON 响应中排除。

Github 示例: [JsonIgnore 示例](https://github.com/java089/spring-mvc-exclude-fields-json)

以上是如何动态忽略 Spring MVC JSON 响应中的字段？的详细内容。更多信息请关注PHP中文网其他相关文章！