Jackson java动态去除返回json中的值方式
更新时间：2024年12月17日 08:41:54 作者：爱写BUG的老冉
文章介绍了在Java中使用@JsonInclude注解动态去除返回JSON中的非必需字段（如分页信息）的解决方案,通过在字段上添加@JsonInclude注解并选择合适的策略（如NON_NULL或NON_EMPTY）,可以在非分页情况下取消分页字段,从而提高返回结果的灵活性和效率
【Jackson】java动态去除返回json中的值
1 业务背景
一般来说，我们后端给前端返回结果的时候，会建一个返回结果类。
但这个结果类里的字段并不是所有情况都需要的，例如：分页信息。
因此如何在非分页的情况下取消掉分页字段，就是当前我们需要解决的问题。
2 解决方案
我们采用 @JsonInclude 注解对分页信息进行标记。
2.1 @JsonInclude 的用法
在要动态过滤的字段上面，添加以下注释即可（具体规则，根据实际情况进行选择）
@JsonInclude(JsonInclude.Include.NON_NULL)
| 规则 | 解释 |
|---|---|
| ALWAYS | 默认值，返回全部字段 |
| NON_NULL | 为null的字段不返回 |
| NON_EMPTY | 为空或者为 NULL不返回 |
| NON_DEFAULT | 为默认值不返回 |
2.2 举例
未动态去除分页信息的旧代码
@Data
@Slf4j
public class JsonVo<T>{
@JsonProperty(value = "code")
//"状态码。200表示成功"
private Integer code;
@JsonProperty(value = "data")
//"结果集"
private List<T> datas;
//"分页信息"
@JsonProperty(value = "pageInfo")
private PageInfo pageInfo = new PageInfo ();;
public static <T> JsonVo ok(String msg){
JsonVoresult = new JsonVo();
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = Collections.singletonList(new SuccessMsgVo(msg)) ;
return result;
}
public static <T> JsonVo<T> ok(List<T> datas){
JsonVo<T> result = new JsonVo<>();
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = datas ;
return result;
}
public static <T> JsonVo<T> ok(IPage<T> data){
JsonVo<T> result = new JsonVo<>();
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = data.getRecords() ;
result.pageInfo.pageNum = Math.toIntExact(data.getCurrent());
result.pageInfo.pageSize = Math.toIntExact(data.getSize());
result.pageInfo.total = data.getTotal();
return result;
}
@Data
public static class PageInfo {
//"页码"
@JsonProperty(value = "pageNumber")
private Integer pageNum = 0;
//"每页返回的数据量"
@JsonProperty(value = "pageSize")
private Integer pageSize = 0;
//"总量"
@JsonProperty(value = "totalCount")
private Long total = 0L;
}
}
修改后的新代码
@Data
@Slf4j
public class JsonVo<T>{
@JsonProperty(value = "code")
//"状态码。200表示成功"
private Integer code;
@JsonProperty(value = "data")
//"结果集"
private List<T> datas;
//"分页信息"
@JsonProperty(value = "pageInfo")
@JsonInclude(JsonInclude.Include.NON_NULL )
private PageInfo pageInfo;
public static <T> JsonVo ok(String msg){
JsonVoresult = new JsonVo();
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = Collections.singletonList(new SuccessMsgVo(msg)) ;
return result;
}
public static <T> JsonVo<T> ok(List<T> datas){
JsonVo<T> result = new JsonVo<>();
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = datas ;
return result;
}
public static <T> JsonVo<T> ok(IPage<T> data){
JsonVo<T> result = new JsonVo<>();
if (result.pageInfo == null){
result.pageInfo = new PageInfo();
}
result.code = CommonConstants.SUCCESSED_CODE;
result.datas = data.getRecords() ;
result.pageInfo.pageNum = Math.toIntExact(data.getCurrent());
result.pageInfo.pageSize = Math.toIntExact(data.getSize());
result.pageInfo.total = data.getTotal();
return result;
}
@Data
public static class PageInfo {
//"页码"
@JsonProperty(value = "pageNumber")
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
private Integer pageNum = 0;
//"每页返回的数据量"
@JsonProperty(value = "pageSize")
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
private Integer pageSize = 0;
//"总量"
@JsonProperty(value = "totalCount")
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
private Long total = 0L;
}
}
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
本文通过实例给大家介绍了java格式字符串的使用，代码简单易懂，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧2022-02-02
【Redis缓存机制】详解Java连接Redis_Jedis_事务
这篇文章主要介绍了【Redis缓存机制】详解Java连接Redis_Jedis_事务，详细的介绍了Jedis事务和实例，有兴趣的可以了解一下。2016-12-12
下面小编就为大家带来一篇JVM Tomcat性能实战(推荐)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2016-05-05
这篇文章主要介绍了使用SpringDataJpa创建中间表，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-06-06
这篇文章主要介绍了Groovy的规则脚本引擎实例解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-03-03
这篇文章主要为大家详细介绍了Java编写网络聊天程序实验，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-08-08
这篇文章主要介绍了简单了解SpringMVC全局异常处理常用方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-09-09
这篇文章主要给大家介绍了关于MyBatis分库分表方案的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者使用MyBatis具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-03-03
在实际开发中不仅仅是要展示数据，还要构成数据模型添加数据，这篇文章主要介绍了SpringBoot集成Mybatis操作数据库，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-08-08
在本文里我们给大家分享了关于Spring Boot Security配置的相关步骤以及注意要点，需要的朋友们跟着操作下。2019-05-05
最新评论