跳到主要內容

Jackson - Optionally ignore some fields

Introduction

我們要轉換為json的物件,有些成員變數並非是最後要呈現的。此時我們可以製作針對顯示的物件,僅宣告要顯示的欄位為成員變數,也可以透過@JsonIgnore或@JsonIgnoreProperties來達到預期結果。

How to?

Source Object

public class Student {
	@JsonProperty(value="id")
	private String mID;
 
	@JsonProperty(value="passwd")
	private String mPasswd;
 
	@JsonProperty(value="email")
	private String mEmail;
 
	public Student() {
 
	}
 
	public String getEmail() {
		return mEmail;
	}
 
	public void setEmail(String aEmail) {
		this.mEmail = aEmail;
	}
 
	public String getID() {
		return mID;
	}
 
	public void setID(String aID) {
		this.mID = aID;
	}
 
	public String getPasswd() {
		return mPasswd;
	}
 
	public void setPasswd(String aPasswd) {
		this.mPasswd = aPasswd;
	}
}

@JsonIgnore

假如我們要Ignore的變數為mEmail,可以在get函式與變數宣告上使用@JsonIgnore:

	@JsonProperty(value="email")
	@JsonIgnore
	private String mEmail;
 
	@JsonIgnore
	public String getEmail() {
		return mEmail;
	}

假如你沒使用@JsonProperty,可以在get函式宣告即可:(Jackson會把get method與使用@JsonProperty當成兩個個體)

	private String mEmail;
 
	@JsonIgnore
	public String getEmail() {
		return mEmail;
	}

簡單起見,建議還是兩邊都宣告為佳。

@JsonIgnoreProperties

如果使用@JsonIgnoreProperties去忽略範例中的mEmail,只要在類別宣告上指定email欄位即可:

@JsonIgnoreProperties({"email"})
public class Student {
	// ...
}

但如果@JsonProperty所宣告的名稱與get函式不同,@JsonIgnoreProperties必須包含兩者:

@JsonIgnoreProperties({"email","mail"})
public class Student {
	@JsonProperty(value="mail")
	private String mEmail;
 
	public String getEmail() {
		return mEmail;
	}
}

假如你要針對類別中某個成員內的欄位做忽略,以Map為例:

	@JsonProperty(value="metadata")
	@JsonIgnoreProperties({"test1","test2"})
	private Map<String, Object> mMetadata;
 
	public Student() {
		mMetadata = new HashMap<String, Object>();
 
		Map<String, Object> tmp = new HashMap<String, Object>();
		tmp.put("test1", "789");
		tmp.put("test2", "111");
		tmp.put("test3", "222");
 
		mMetadata.put("test1", "123");
		mMetadata.put("test2", "456");
		mMetadata.put("test3", tmp);
	}

所宣告的物件,也會忽略包含value中的欄位:

{"passwd":"123456","id":"user","metadata":{"test3":{"test3":"222"}}}

Summary

本篇介紹的@JsonIgnore與@JsonIgnoreProperties,可以讓產生的內容不包含你所宣告的欄位。總結以上:

  1. @JsonIgnore宣告於要Ignore的欄位上。
  2. @JsonIgnoreProperties宣告於類別上,指定要Ignore之項目;如果宣告於成員或get函式,則是針對內容類別的欄位做忽略。
  3. 兩者在Serialize時,就會被忽略。如果想要選擇性的顯示,必須透過Filter的方式。

Reference

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php