Spring Boot程序中@JsonIgnoreProperties与@JsonIgnore基本使用

怼烎@ 2022-04-16 04:39 205阅读 0赞

**问题由来**：  
springboot项目中定义了很多类，我们在rest返回中直接返回或者在返回对象中使用这些类，spring已经使用jackson自动帮我们完成这些的to json。但是有时候自动转的json内容太多，或者格式不符合我们的期望，因此需要调整类的to json过程，或者说希望自定义类的json过程。

**解决办法**：  
使用@JsonIgnoreProperties、@JsonIgnore、@JsonFormat。

@JsonIgnore注解用来忽略某些字段，可以用在变量或者Getter方法上，用在Setter方法时，和变量效果一样。这个注解一般用在我们要忽略的字段上。

@JsonIgnoreProperties(ignoreUnknown = true)，将这个注解写在类上之后，就会忽略类中不存在的字段。这个注解还可以指定要忽略的字段，例如@JsonIgnoreProperties(\{ “password”, “secretKey” \})

@JsonFormat可以帮我们完成格式转换。例如对于Date类型字段，如果不适用JsonFormat默认在rest返回的是long，如果我们使用@JsonFormat(timezone = “GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)，就返回"2018-11-16 22:58:15"

具体可以参考官方文档  
https://fasterxml.github.io/jackson-annotations/javadoc/2.6/com/fasterxml/jackson/annotation/JsonIgnoreProperties.html

**实际代码**  
完整的程序在[这里][Link 1]，欢迎加星，fork。  
代码简要说明， User类的fullName 和comment字段会被@JsonIgnoreProperties注解忽略。address字段会被@JsonIgnore注解忽略。regDate会按照@JsonFormat(timezone = “GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)进行格式转。

@Data
    @JsonIgnoreProperties(value = { "fullName", "comment"})
    public class User { 
        private String id;
        private String name;
        private String fullName;
        private String comment;
        private String mail;
    
        @JsonIgnore
        private String address;
    
        @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
        private Date regDate;
    
        private Date reg2Date;
    }

我们的controller示例代码

@ApiOperation(value = "按用户id删除", notes="private")
        @ApiImplicitParams({ 
                @ApiImplicitParam(name = "userId", defaultValue = "2", value = "userID", required = true, dataType = "string", paramType = "path"),
        })
        @DeleteMapping(value = "/users/{userId}", produces = "application/json;charset=UTF-8")
        public User delUser(@PathVariable String userId) { 
            User user = (User)userSvc.deleteById(userId);
            log.info("rest del user={} by id={}", user, userId);
            return user;
        }

可以看到返回的对象是User，然后comment、fullName、address属性被忽略了，regDate的格式进行转换。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1c3NsZQ_size_16_color_FFFFFF_t_70]

[Link 1]: https://github.com/yqbjtu/springboot/tree/master/JSONDemo
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1c3NsZQ_size_16_color_FFFFFF_t_70]: /images/20220416/3f59c469140a4db3bfe58a8de32ddda6.png