对象转Json字符串时如何忽略指定属性
作者:pan_joy
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
UPPER_CAMEL_CASE
- 大驼峰 (TestStr)LOWER_CAMEL_CASE
- 小驼峰 (testStr)SNAKE_CASE
- 下划线 (test_str)LOWER_CASE
- 小写 (teststr)KEBAB_CASE
- 减号 (test-str)
针对指定对象,添加注解@JsonNaming(PropertyNamingStrategy.???.class)
@JsonNaming(PropertyNamingStrategy.UpperCamelCaseStrategy.class)
- 大驼峰@JsonNaming(PropertyNamingStrategy.LowerDotCaseStrategy.class)
- .分隔 test.str@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
- 下划线@JsonNaming(PropertyNamingStrategy.LowerCaseStrategy.class)
- 小写@JsonNaming(PropertyNamingStrategy.KebabCaseStrategy.class)
- 减号
其中有一点需要注意,对于从json字符串转换为实体对象时,即使设置了大驼峰等模式,使用对象属性名,也可以解析成功,即TestStr, testStr均可解析成功。
空属性是否序列化
全局配置spring.jackson.default-property-inclusion=non_null
non_null
: null不解析non_empty
: 空字符’'和null均不解析
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。