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中关于泛型、包装类及ArrayList的详细教程,需要的朋友可以参考下2021-12-12
这篇文章主要介绍了Java中的线程中断机制和LockSupport详解,在Java中没有办法立即停止一条线程,然而停止线程却显得尤为重要,如取消一个耗时操作,因此,Java提供了一种用于停止线程的协商机制中断,也即中断标识协商机制,需要的朋友可以参考下2023-09-09
java高并发ScheduledThreadPoolExecutor类深度解析
这篇文章主要为大家介绍了java高并发ScheduledThreadPoolExecutor类源码深度解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-11-11
限流是指在各种应用场景中,通过技术和策略手段对数据流量、请求频率或资源消耗进行有计划的限制,本文为大家整理了常见的限流的实现方式,有需要的可以参考下2024-02-02
这篇文章主要介绍了Maven的安装配置详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-08-08
这篇文章主要介绍了详解基于Spring Data的领域事件发布，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-04-04
这篇文章主要介绍了Spring的事务机制实例代码，分享了相关代码示例，小编觉得还是挺不错的，具有一定借鉴价值，需要的朋友可以参考下2018-02-02
公司一个springboot项目本来是打war包的，突然要改为打jar包，不知所措了，纠结该如何操作呢，折腾半天终于搞定了，下面把解决方案分享给大家，对springboot打jar包方式感兴趣的朋友一起看看吧2021-06-06
Spring Cloud Sleuth是一个在应用中实现日志跟踪的强有力的工具，使用Sleuth库可以应用于计划任务 、多线程服务或复杂的Web请求，尤其是在一个由多个服务组成的系统中，这篇文章主要介绍了springboot sleuth 日志跟踪,需要的朋友可以参考下2023-07-07
这篇文章主要介绍了详解使用spring validation完成数据后端校验，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-03-03
最新评论