@JsonIgnore的使用及相关问题的解决

目录

1 前言

2 对比及其使用方法

3 遇到的相关问题及解决方法

---

1 前言

在我们编写的后端项目中，有时候可能需要将某个实体类以JSON格式传送给前端，但是其中可能有部分内容我们并不想传送，这时候我们选择将这部分内容变成Null，这确实是个解决办法。但是我们如果使用@JsonIgnore，这就可以更优雅的解决这个问题。

2 对比及其使用方法

我们以传送用户实体类User为例，其组成如下。现在，我们想将除密码外的内容返回给前端。

public class User {
    private Integer id;//主键ID
    private String username;//用户名
    private String password;//密码
    private String nickname;//昵称
    private String email;//邮箱
    //其它
}

如果不使用@JsonIgnore，解决方法有很多种。既可以从mapper层入手，不查询出password，也可以在返回前对User进行处理，将password置为空。除此之外，还有很多方法，这里就将User置空，如下：

public class UserController {
    public Result<User> userInfo() {
        User user = userService.findByUserName(username);
        user.setPassword("");
        //其它代码...
    }
    //其它代码...
}

用Postman测试如下：

如果使用 @JsonIgnore，那么只需要在实体类中的password上加上@JsonIgnore即可，如下：

public class User {
    @JsonIgnore//转为JSON格式的数据时忽略密码
    private String password;//密码
    //其它...
}

用Postman测试就会发现，后端在转为JSON格式的数据时忽略密码，如下：

好像都是一行代码，但是各有侧重吧，一个是忽略，一个是置空。不过为了主打优雅和专业，个人推荐使用@JsonIgnore。

3 遇到的相关问题及解决方法

虽然@JsonIgnore只有一行，但是在使用过程中，我也遇到了一些问题，现将其写在这里，希望能提供一些帮助。

 在我使用的时候，用的是第二个(我当时用的时候，它提示在第一个，结果就用了它)，然后就和没用一样。注意：是com.fasterxml.jackson.annotation中的，这样才能产生效果。