物件轉Json字串時如何忽略指定屬性

2022-08-30 14:03:26

FastJson轉Json字串時,忽略指定屬性

使用註解@JSONField

以下Bean

package com.gomefinance.esign;
import com.alibaba.fastjson.annotation.JSONField;
import lombok.Getter;
import lombok.Setter;
import java.io.Serializable;
 
/**
 * 本地簽署資訊
 * Created by JHAO on 2017/5/31.
 */
@Setter
@Getter
public class FastJsonInputBean implements Serializable {
 
    // 合同模板ID
 
    private String contractTemplateId;
    // 合同號
    private String contractId;
    // Base64編碼的合同
    @JSONField(serialize = false)
    private String contractImage;
    private String contractVersion;
 
}

 FastJsonInputBean inputBean = new FastJsonInputBean();
 inputBean.setContractImage("contractImage");
 inputBean.setContractTemplateId("templateId");
 inputBean.setContractId("comtractId");
 inputBean.setContractVersion("contractVersion");
 
 System.out.println("JSONField(serialize = false)忽略contractImage屬性:"+JSON.toJSONString(inputBean));

列印結果：

{"contractId":"comtractId","contractTemplateId":"templateId","contractVersion":"contractVersion"}

Filter指定序列化的欄位

SimplePropertyPreFilter filter = new SimplePropertyPreFilter(FastJsonInputBean.class, "contractTemplateId");
System.out.println("filter忽略contractTemplateId屬性:"+JSONObject.toJSONString(inputBean, filter));

列印結果：

{"contractTemplateId":"templateId"}

JackSon忽略欄位

@JsonIgnoreProperties主鍵或者在欄位上使用@JsonIgnore

package com.gomefinance.esign;
import com.alibaba.fastjson.annotation.JSONField;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Getter;
import lombok.Setter;
import java.io.Serializable;
 
/**
 * 本地簽署資訊
 * Created by JHAO on 2017/5/31.
 */
@Setter
@Getter
@JsonIgnoreProperties({"contractTemplateId", "contractImage"})
public class JackSonInputBean implements Serializable {
 
    // 合同模板ID
 
    private String contractTemplateId;
    // 合同號
    @JsonIgnore
    private String contractId;
    // Base64編碼的合同
    private String contractImage;
    private String contractVersion;
 
}

 JackSonInputBean jackSonInputBean = new JackSonInputBean();
 jackSonInputBean.setContractImage("contractImage");
 jackSonInputBean.setContractTemplateId("templateId");
 jackSonInputBean.setContractId("comtractId");
 jackSonInputBean.setContractVersion("contractVersion");
 
 ObjectMapper objectMapper = new ObjectMapper();
 System.out.println("JackSon JsonIgnore忽略contractId屬性:"+objectMapper.writeValueAsString(jackSonInputBean));

列印結果：

{"contractVersion":"contractVersion"}

Jackson Json與物件轉換的幾個設定筆記

最近因為專案需要，對Jackson的使用進行了深入的學習，總結了幾條使用心得，在此記錄一下：

在做Json字串轉換為物件時，有時會出現物件中存在某屬性，而json字串沒有此屬性，預設情況下會丟擲異常。

可通過以下兩種方式設定不丟擲異常：

application.properties中進行全域性設定：spring.jackson.deserialization.fail_on_unknown_properties=false
針對需要設定物件類，新增註解： @JsonIgnoreProperties(ignoreUnknown = true)

java類的屬性，一般是小駝峰模式，如testStr。在轉換為Json字串時，可以控制json中屬性的命名方式，如大駝峰，小駝峰，蛇形（下劃線），不變等。

全域性設定屬性spring.jackson.property-naming-strategy