JSONField解决序列化与反序列化字段匹配问题
需求:调用第三方数据,数据格式为Json,并提供一个接口将获取的第三方数据给本公司其他部门调用。
处理流程:第三方Json--反序列化实体--保存到本地数据库--查询数据--序列化Json数据供本公司调用。简化为:json--实体--json。
遇到问题:
1,把数据存到本地后,怎么取数据,各层级之间怎么关联?
2,json--实体,反序列化,有的实体中数据为null,未能解析到json数据?
3,实体--json,序列化,有的实体中的字段(比如:解决问题1时,增加的字段id,recordId)不需要序列化Json数据,即不需要展示给用户,如何不序列化?
解决方法:
1,创建表结构时,增加两个字段,id,recordId,id为每一层的主键,recordId为关联字段,用外层的id,对应里层recordId,让每一层建立关联关系,实现查询。
2,原因:Json数据中key与实体中定义字段不匹配。
看一下:json数据中key用下划线分割,而实体中定义变量时,形式为驼峰格式,这时可以正常解析,实体中对应属性有值。
而Json中标红的数据,用点分割(注意实体中不能直接定义用点分割的变量。),无法反序列化到实体。
解决方案一:注解加到变量上,用@JSONField(name = " "),对应json中key。
解决方案二:注解加到方法上,把该注解@JSONField(name = " "),加到set/get方法上,关键是加到set还是get方法上?结论是加到set方法上,可以理解为给实体中变量赋值,name值与json中key对应。
什么情况下:注解加到get方法上,实体序列化时,默认情况下,实体--json,json中key为实体中对应变量。如果想要别人调用接口获取的json,与第三方保持一致,即有下划线,可以通过在get方法上加注解,转化想要的json数据格式。
事例:
实体定义:
public class InputParametersSYS extends BasePojo { private BigDecimal recordId; private String partnerCode; private String idNumber; private String accountName; private String accountMobile; @JSONField(name = "mobile.name.id") private String mobileNameId;
Json数据:
"interfaces": [ { "details": [ { "result": { "result": 0, "success": true, "display": "一致" }, "input_parameters": { "id_number": "370404199006301915", "mobile.name.id": "mobile.name.id", "account_name": "皮晴晴", "account_mobile": "13333333333", "partner_code": "pinganhq" } } ], "type": "手机号三要素核验" },
3,
方案一:在对应的不需要显示的字段上加注解@JSONFiled(serialize = false)
//@JsonIgnore @JSONField(serialize = false) private Integer id;
方案二:加@JsonIgnore注解。不过当id,recordId 定义为int类型时,该注解不起作用。定义为Integet类型时,该注解生效。
1. JSONField 介绍(转载)
package com.alibaba.fastjson.annotation;
public @interface JSONField {
// 配置序列化和反序列化的顺序,1.1.42版本之后才支持
int ordinal() default 0;
// 指定字段的名称
String name() default "";
// 指定字段的格式,对日期格式有用
String format() default "";
// 是否序列化
boolean serialize() default true;
// 是否反序列化
boolean deserialize() default true;
}
2. JSONField配置方式
FieldInfo可以配置在getter/setter方法或者字段上。例如:
2.1 配置在getter/setter上
public class A {
private int id;
@JSONField(name="ID")
public int getId() {return id;}
@JSONField(name="ID")
public void setId(int value) {this.id = id;}
}
2.2 配置在field上
public class A {
@JSONField(name="ID")
private int id;
public int getId() {return id;}
public void setId(int value) {this.id = id;}
}
3. 使用format配置日期格式化
public class A {
// 配置date序列化和反序列使用yyyyMMdd日期格式
@JSONField(format="yyyyMMdd")
public Date date;
}
4. 使用serialize/deserialize指定字段不序列化
public class A {
@JSONField(serialize=false)
public Date date;
}
5. 使用ordinal指定字段的顺序
缺省fastjson序列化一个java bean,是根据fieldName的字母序进行序列化的,你可以通过ordinal指定字段的顺序。这个特性需要1.1.42以上版本。
public static class VO {
@JSONField(ordinal = 3)
private int f0;
@JSONField(ordinal = 2)
private int f1;
@JSONField(ordinal = 1)
private int f2;
}