Java接口返回json如何忽略特定属性

 更新时间:2022年09月23日 16:07:15   作者:CNBLOG  
这篇文章主要介绍了Java接口返回json如何忽略特定属性,通过SimplePropertyPreFilter方式(Json返回),这种写法,接口返回类型就要求是Json字符串类型,本文通过场景实例代码相结合给大家介绍的非常详细,需要的朋友可以参考下

经常遇到的问题

在实际得开发过程中,我们经常会遇到以下场景,我们后端请求某个接口后获取到得数据,不希望将所有字段都返回给前端,那么我们需要封装,或者过滤一些不必要得字段后返回给前端。

不完美的解决方案

使用 Jackson 字段动态过滤

  • @JsonIgnore用于忽略序列化和反序列化中使用的逻辑属性。@JsonIgnore 可用于 setter、getter 或字段。

  • @JsonIgnoreProperties忽略 JSON 序列化和反序列化中的指定逻辑属性。它在类级别进行了注释。

  • @JsonIgnoreType在类级别进行了注释,它忽略了整个类。

  • @JsonInclude(JsonInclude.Include.NON_NULL) 属性为NULL不序列化,即不返回给前端

以上方式都不满足实际要求,需要序列化的Property,并非固定的。这次我要id,name,下次我可能要name,score。

通过SimplePropertyPreFilter方式(Json返回)

这种写法,接口返回类型就要求是Json字符串类型。无法满足Spring注解@ResponseBody。

场景一: 只保留name和sex字段

public static void main(String[] args) {
    JSONObject jsonObject = new JSONObject();
    jsonObject.put("name", "jhon");
    jsonObject.put("age", 18);
    jsonObject.put("sex", "男");
    jsonObject.put("phone", "1111111");
    jsonObject.put("email","142qq.com");
    System.out.println(jsonObject);
    // SimplePropertyPreFilter filter = new SimplePropertyPreFilter("name","sex");
    SimplePropertyPreFilter filter = new SimplePropertyPreFilter();
    filter.getIncludes().add("name");
    filter.getIncludes().add("sex");
    System.out.println(JSONObject.toJSONString(jsonObject, filter));
}
// 或者调用以下方式
public static String object2Json(Object object, String... keys) {
    SimplePropertyPreFilter filter = new SimplePropertyPreFilter(object.getClass(),keys);
    return JSONObject.toJSONString(object,filter, SerializerFeature.WriteMapNullValue);
}

场景二: 过滤掉email和phone字段

public static void main(String[] args) {
    JSONObject jsonObject = new JSONObject();
    jsonObject.put("name", "jhon");
    jsonObject.put("age", 18);
    jsonObject.put("sex", "男");
    jsonObject.put("phone", "1111111");
    jsonObject.put("email","142qq.com");
    System.out.println(jsonObject);
    SimplePropertyPreFilter filter = new SimplePropertyPreFilter();
    filter.getExcludes().add("email");
    filter.getExcludes().add("phone");
    System.out.println(JSONObject.toJSONString(jsonObject, filter));
}

@ResponseBody返回json如何忽略特定属性

@RequestBody注解标记接收前端传递给后端的json数据,然后转成对象。

@ResponseBody注解标记是把后端返回的对象转换成json数据,然后传递给前端。

我们想要的效果是将查询得到的 List<对象> 动态过滤指定的字段
但实际上我们得到的对象还会再封装一层:return new IResult(list);

使用AOP,通过自定义注解的方式来控制动态过滤指定字段。(实现太麻烦放弃了)

通过反射Map解决

通过反射获取到该类和所要获取的字段get方法,保存在一个map中。但当数据量大的情况再把对象转换一次map,就会影响接口性能了。(此方式不可取)

最终解决办法:定义查询列表数据的接口,用Map来承载,而不是bean。

public List<Map<String,Object>> list(Entity entity);

不同接口参数使用相同对象展示不同参数

当我们在写接口的时候,一个实体类对象会被多个接口使用,但每个接口要求的参数可能都不一样。为了接口参数规范,于是我们就重写了多个实体类,对应不同的接口。(相信很多人目前是偷懒每套业务都只用了一个实体类对象吧,前端自己挑选所需要的字段)

但是提供给第三方的接口,参数和结果字段必须都要求规范起来,否则等着被喷了。

Swagger2实现参数使用相同对象展示不同参数,可以用分组方式实现,但用起来也比较麻烦。

还会遇到每个接口需要做字段校验@Valid,又是麻烦的一批。

最终发现还是多写几个实体类更快更规范此,且针对不同接口的参数也更便于管理。

到此这篇关于Java接口返回json如何忽略特定属性的文章就介绍到这了,更多相关Java接口返回json内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java主线程捕获子线程异常的实现

    Java主线程捕获子线程异常的实现

    本文主要介绍了Java主线程捕获子线程异常的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-04-04
  • java获取时间的方法总结

    java获取时间的方法总结

    以下是对java中获取时间的几种方法进行了详细的分析介绍,需要的朋友可以参考下
    2013-07-07
  • 如何基于ThreadPoolExecutor创建线程池并操作

    如何基于ThreadPoolExecutor创建线程池并操作

    这篇文章主要介绍了如何基于ThreadPoolExecutor创建线程池并操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-11-11
  • 详解kafka中的消息分区分配算法

    详解kafka中的消息分区分配算法

    kafka有分区机制,一个主题topic在创建的时候,会设置分区。如果只有一个分区,那所有的消费者都订阅的是这一个分区消息;如果有多个分区的话,那消费者之间又是如何分配的呢?本文就来为大家详细讲解一下
    2022-04-04
  • SpringBoot集成Mybatis实现对多数据源访问原理

    SpringBoot集成Mybatis实现对多数据源访问原理

    本文主要分析讨论在SpringBoot应用中我们该如何配置SqlSessionFactoryBean对象,进而实现对多个不同的数据源的操纵,文章通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • Java使用多线程批次查询大量数据(Callable返回数据)方式

    Java使用多线程批次查询大量数据(Callable返回数据)方式

    今天给大家分享Java使用多线程批次查询大量数据(Callable返回数据)方式,多线程有好几种方式,今天说的方式比较好,实现Callable<> 这种方式能返回查询的数据,加上Future异步获取方式,查询效率大大加快,感兴趣的朋友一起看看吧
    2023-11-11
  • SpringCloud中的Ribbon负载均衡器详细解析

    SpringCloud中的Ribbon负载均衡器详细解析

    这篇文章主要介绍了SpringCloud中的Ribbon负载均衡器详细解析,Ribbon 是一个基于 HTTP 和 TCP 的客户端负载均衡工具,它基于 Netflix Ribbon 实现,通过封装可以让我们轻松地将面向服务的 REST 模版请求自动转换成客户端负载均衡的服务调用,需要的朋友可以参考下
    2024-01-01
  • 深入理解Java 对象和类

    深入理解Java 对象和类

    下面小编就为大家带来一篇深入理解Java 对象和类。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • IDEA搭建SpringBoot离线工程的方法

    IDEA搭建SpringBoot离线工程的方法

    这篇文章主要介绍了IDEA搭建SpringBoot离线工程的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • Java后端学习精华之TCP通信传输协议详解

    Java后端学习精华之TCP通信传输协议详解

    TCP/IP是一种面向连接的、可靠的、基于字节流的传输层通信协议,它会保证数据不丢包、不乱序。TCP全名是Transmission Control Protocol,它是位于网络OSI模型中的第四层
    2021-09-09

最新评论