Java接口返回json

时间:2022-09-29 CNBLOG 人气:0

经常遇到的问题

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

不完美的解决方案

使用 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，又是麻烦的一批。

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

加载全部内容