Java介面返回json如何忽略特定屬性

2022-09-26 14:06:03

經常遇到的問題

在實際得開發過程中，我們經常會遇到以下場景，我們後端請求某個介面後獲取到得資料，不希望將所有欄位都返回給前端，那麼我們需要封裝，或者過濾一些不必要得欄位後返回給前端。

不完美的解決方案

使用 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內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Java介面返回json如何忽略特定屬性

目錄

經常遇到的問題

不完美的解決方案

通過SimplePropertyPreFilter方式(Json返回)

場景一：只保留name和sex欄位

場景二：過濾掉email和phone欄位

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

通過反射Map解決

不同介面引數使用相同物件展示不同引數

熱門文章

Java介面返回json如何忽略特定屬性

目錄

經常遇到的問題

不完美的解決方案

通過SimplePropertyPreFilter方式(Json返回)

場景一： 只保留name和sex欄位

場景二： 過濾掉email和phone欄位

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

通過反射Map解決

不同介面引數使用相同物件展示不同引數

熱門文章

場景一：只保留name和sex欄位

場景二：過濾掉email和phone欄位