Optionally ignore some fields

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

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;
	}
}

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

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

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

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

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

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

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

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

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

---