Jackson的相关知识

it2025-08-06  4

一、json与实体互转 1:json文件中的相关字段无需映射到bean中 json 转实体 实体中字段少于json字符串中的字段 com.fasterxml.jackson.annotation.JsonIgnoreProperties @JsonIgnoreProperties(ignoreUnknown = true) 加在类上,这样就可以忽略你的bean中没有的属性。 实体中的字段多余json字符串中的字段 // jackson 1.9 and before

objectMapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);

// or jackson 2.0

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

实体转json 部分属性无需添加 @ JsonInclude (JsonInclude. Include. NON EMPTY)

二、页面输出格式常用注解----@JsonIgnore,@JsonFormat,@JsonFormat 1.注解名称:@JsonIgnore 作用:在实体类向前台返回数据时用来忽略不想传递给前台的属性或接口。 Eg:User实体中会有字段password字段,

当返回用户信息给前台的时候,当然是不希望将password值也一并返回。所以,这个时候可以在password属性上加上注解JsonIgnore或者,

可以在User类上加上注解@JsonIgnoreProperties(value = “{password}”)

2.注解名称:@JsonFormat

前台使用固定时间格式时可以在属性名上添加@JsonFormat注解()

不返回null字段数据

3.注解名称:@JsonFormat

在相关对象的类上添加 @JsonInclude 注解,设定值为 NON_NULL

三、springboot之jackson的两种配置方式 pringboot 针对jackson是自动化配置的,如果需要修改,有两种方式:

方式一:通过application.yml

配置属性说明:## spring.jackson.date-format指定日期格式,比如yyyy-MM-dd HH:mm:ss,或者具体的格式化类的全限定名

spring.jackson.deserialization是否开启Jackson的反序列化

spring.jackson.generator是否开启json的generators.

spring.jackson.joda-date-time-format指定Joda date/time的格式,比如yyyy-MM-ddHH:mm:ss). 如果没有配置的话,dateformat会作为backup

spring.jackson.locale指定json使用的Locale.

spring.jackson.mapper是否开启Jackson通用的特性.

spring.jackson.parser是否开启jackson的parser特性.

spring.jackson.property-naming-strategy指定PropertyNamingStrategy(CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES)或者指定PropertyNamingStrategy子类的全限定类名.

spring.jackson.serialization是否开启jackson的序列化.

spring.jackson.serialization-inclusion指定序列化时属性的inclusion方式,具体查看JsonInclude.Include枚举.

spring.jackson.time-zone指定日期格式化时区,比如America/Los_Angeles或者GMT+10.

spring: jackson: #日期格式化 date-format: yyyy-MM-dd HH:mm:ss serialization: #格式化输出 indent_output: true #忽略无法转换的对象 fail_on_empty_beans: false #设置空如何序列化 defaultPropertyInclusion: NON_EMPTY deserialization: #允许对象忽略json中不存在的属性 fail_on_unknown_properties: false parser: #允许出现特殊字符和转义符 allow_unquoted_control_chars: true #允许出现单引号 allow_single_quotes: true 方式二:使用重新注入ObjectMapper @Bean @Primary @ConditionalOnMissingBean(ObjectMapper.class) public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) { ObjectMapper objectMapper = builder.createXmlMapper(false).build();

// 通过该方法对mapper对象进行设置,所有序列化的对象都将按改规则进行系列化 // Include.Include.ALWAYS 默认 // Include.NON_DEFAULT 属性为默认值不序列化 // Include.NON_EMPTY 属性为 空("") 或者为 NULL 都不序列化,则返回的json是没有这个字段的。这样对移动端会更省流量 // Include.NON_NULL 属性为NULL 不序列化 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY); objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); // 允许出现特殊字符和转义符 objectMapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS, true); // 允许出现单引号 objectMapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true); // 字段保留,将null值转为"" objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() { @Override public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException { jsonGenerator.writeString(""); } }); return objectMapper; }

json相关注解和序列化与反序列化

使用jackson进行序列化时,往往会遇到后台某个实体对象的属性为null,当序列化成json时对应的属性也为null,可以用以下的注解方式完成当属性为null时不参与序列化:

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) @JsonIgnoreProperties

类注解,作用是json序列化时将bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JsonIgnore

作用于属性或字段上,当生成json时忽略有该annotation的方法或字段。

@JsonProperty(“rename”)

作用于属性或字段上,对其重命名。

@JsonFormat

作用于属性或字段上,方便把Date类型直接转化为我们想要的模式,如@JsonFormat(pattern=“yyyy-MM-dd HH-mm-ss”)

@JsonSerialize

作用于属性或字段上,指定序列化方式。

例如:@JsonSerialize(as=BasicType.class)将类型序列化成指定类型;@JsonSerialize(using=CustomDoubleSerialize.class)用于在序列化时嵌入我们自定义的代码,比如序列化一个double时在其后限制两位小数。

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) //保证序列化json的时候,如果是null的对象,key也会消失 //比如在创建失败的时候,只需要将status和msg显示出来,但是如果不加上面的注解会将data也显示出来,其值会显示null @JsonDeserialize

作用于属性或字段上,指定反序列化方式。

例如:@JsonDeserialize(as=ValueImpl.class)将类型反序列化成指定类型;@JsonDeserialize(using=CustomDateDeserialize.class)用于在反序列化时嵌入我们自定义的代码。

序列化与反序列化

例子:

public class ServerResponse implements Serializable{ Serializable是一个标识接口,它没有定义任何方法,实现了这个接口,就代表这个类可以进行串行化了。

串行化也叫序列化,就是将实例的状态转化成文本(或二进制)的形式,以便永久保存(所以也叫持久化)或在网间传递。

什么时候实现java.io.Serializable接口?

如果一个类的实例需要持久化或者需要在网间传递的时候,就用到串行化。

例如:action,dao层的一些个类一般不需要串行化,而bean层的一些个类一般需要串行化。因为客户端用到action,dao层的时候都是import过来,然后自己进行实例化的,或者直接调用容器中的实例;而bean不一样,客户端不可以new一个出来给自己,客户端需要从服务器端接收一个bean,读取bean中的信息状态,然后做出一系列反应,而这个传输过程就用到了串行化。

为什么要实现序列化?

序列化实体对象是为了方便网络传输。因为网络传输数据只能是二进制流,序列化能将实体转化为二进制流传输,同时还可通过反序列化重新将二进制流还原成实体对象。

序列化在网络协议中的应用:

OSI七层协议模型中表现层的主要功能是把应用层的对象转换成一段连续的二进制串,或者反过来,把二进制串转换成应用层的对象。这两个功能就是序列化和反序列化。而TCP/IP协议的应用层对应OSI七层模型的应用层、表示层和会话层,所以序列化协议属于TCP/IP协议应用层的一部分。

序列化:将数据结构或对象转换成二进制串的过程。

反序列化:将在序列化过程中所生成的二进制串转换成数据结构或对象的过程。

序列化的作用:

1)把对象的字节序列持久化永久地保存到硬盘上。

例如:web服务器中的session对象,当有10万用户并发访问,就有可能出现10万个session对象,内存可能不够用,于是web容器就会把一些session先序列化到硬盘中,等要用的时候,再把保存在硬盘中的对象还原到内存中。

2)在网络上传送对象的字节序列。

例如:当两个进程在进行远程通信时,彼此可以发送各种类型的数据,无论是何种类型的数据,都会以二进制序列的形式在网络上传送,发送方需要把这个java对象转换为字节序列,才能在网络上传送,接收方则需要把字节序列再恢复为java对象。

JDK类库中的序列化API例子可以详见http://blog.csdn.net/abc6368765/article/details/51365838

serialVersionUID:序列化的版本号,凡是实现Serializable接口的类都有一个表示序列化版本标识符的静态变量,即private static final long serialVersionUID。

如何序列化生成serialVersionUID以及是否加这个UID导致的区别和为什么,详见http://blog.csdn.net/abc6368765/article/details/51365838

最好显示指定serialVersionUID,为什么?

因为原则上序列化后的数据中的serialVersionUID只有和当前类的serialVersionUID相同时才能被正常的反序列化。如果不显示指定,在一次执行序列化后,如果增加或者删除了某些成员变量,再次执行序列化,系统就会重新生成hash值然后赋给UID,导致反序列化的时候报error。

注意:

1.如果一个类想被序列化,需要实现Serializable接口。否则将抛出NotSerializableException异常,这是因为,在序列化操作过程中会对类型进行检查,要求被序列化的类必须属于Enum、Array和Serializable类型其中的任何一种,这也是为什么Serializable虽然是一个空接口,但是只要实现了该接口就能序列化和反序列化。

2.在类中增加writeObject 和 readObject 方法可以实现自定义序列化策略,虽然这俩方法不是被显示调用,但是因为在使用ObjectOutputStream的writeObject方法和ObjectInputStream的readObject方法时,会通过反射的方式调用到它们。

ArrayList源码中有关序列化的使用http://www.hollischuang.com/archives/1140#What%20Serializable%20Did

最新回复(0)