經(jīng)常遇到的問題

在實(shí)際得開發(fā)過程中，我們經(jīng)常會遇到以下場景，我們后端請求某個(gè)接口后獲取到得數(shù)據(jù)，不希望將所有字段都返回給前端，那么我們需要封裝，或者過濾一些不必要得字段后返回給前端。

不完美的解決方案

使用 Jackson 字段動態(tài)過濾

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

• @JsonIgnoreProperties忽略 JSON 序列化和反序列化中的指定邏輯屬性。它在類級別進(jìn)行了注釋。

• @JsonIgnoreType在類級別進(jìn)行了注釋，它忽略了整個(gè)類。

• @JsonInclude(JsonInclude.Include.NON_NULL) 屬性為NULL不序列化，即不返回給前端

以上方式都不滿足實(shí)際要求，需要序列化的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));
}
// 或者調(diào)用以下方式
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注解標(biāo)記接收前端傳遞給后端的json數(shù)據(jù)，然后轉(zhuǎn)成對象。

@ResponseBody注解標(biāo)記是把后端返回的對象轉(zhuǎn)換成json數(shù)據(jù)，然后傳遞給前端。

我們想要的效果是將查詢得到的 List<對象> 動態(tài)過濾指定的字段
但實(shí)際上我們得到的對象還會再封裝一層：return new IResult(list);

使用AOP，通過自定義注解的方式來控制動態(tài)過濾指定字段。（實(shí)現(xiàn)太麻煩放棄了）

通過反射Map解決

通過反射獲取到該類和所要獲取的字段get方法，保存在一個(gè)map中。但當(dāng)數(shù)據(jù)量大的情況再把對象轉(zhuǎn)換一次map，就會影響接口性能了。（此方式不可?。?/p>

最終解決辦法：定義查詢列表數(shù)據(jù)的接口，用Map來承載，而不是bean。

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

不同接口參數(shù)使用相同對象展示不同參數(shù)

當(dāng)我們在寫接口的時(shí)候，一個(gè)實(shí)體類對象會被多個(gè)接口使用，但每個(gè)接口要求的參數(shù)可能都不一樣。為了接口參數(shù)規(guī)范，于是我們就重寫了多個(gè)實(shí)體類，對應(yīng)不同的接口。（相信很多人目前是偷懶每套業(yè)務(wù)都只用了一個(gè)實(shí)體類對象吧，前端自己挑選所需要的字段）

但是提供給第三方的接口，參數(shù)和結(jié)果字段必須都要求規(guī)范起來，否則等著被噴了。

Swagger2實(shí)現(xiàn)參數(shù)使用相同對象展示不同參數(shù)，可以用分組方式實(shí)現(xiàn)，但用起來也比較麻煩。

還會遇到每個(gè)接口需要做字段校驗(yàn)@Valid，又是麻煩的一批。

最終發(fā)現(xiàn)還是多寫幾個(gè)實(shí)體類更快更規(guī)范此，且針對不同接口的參數(shù)也更便于管理。

到此這篇關(guān)于Java接口返回json如何忽略特定屬性的文章就介紹到這了,更多相關(guān)Java接口返回json內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論