一、关于Jackson
spring MVC 默认采用的Jackson 来处理Json 数据，所以不用额外去配置
二、项目演示
demo 使用spring-boot项目
三、情景介绍
- 在前后台分离的项目中，后端纯写Http接口，返回和接收的数据均为json
2.如果返回的Java对象属性为 null ，Jackson 在做数据转化时也会转为null，
此时转化后的数据可能为如下这样，属性 array,name 对应的值为 null
{"array":null,"name":null}
3.前端接收这个数据时可能就会有点不太方便。对于数组类型来说，如果数组中的元素个数为0，那么转化后的json 应该为 []，而字符为null 时则应该变为成 ""
{"array":[],"name":""}
4.对于对象为null 的属性，我们也可以过滤掉，也是不参与序列化成json ，返回的对象类上加@JsonInclude(JsonInclude.Include.NON_NULL) 注解。
四、代码展示
1.创建自定义的jsonSerializer
这个两个serializer 都是当属性为Null 时才会使用
public class MyNullArrayJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
if (value == null) {
jgen.writeStartArray();
jgen.writeEndArray();
} else {
jgen.writeObject(value);
}
}}
public class MyNullObjectJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
if (value == null) {
jgen.writeString("");
} else {
jgen.writeObject(value);
}
}
}
date -> string 转化，用于统一格式化时间
public class DateJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
if (value == null) {
jgen.writeString("");
} else {
try {
Date date = (Date) value;
SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd");
String format = sf.format(date);
jgen.writeString(format);
} catch (Exception e) {
e.printStackTrace();
jgen.writeString("");
}
}
}
}
2.新建 MyBeanSerializerModifier.java 类 ，我们可以在 changeProperties() 方法中判断要转换的属性类型，然后再分配一个 JsonSerializer 对象给BeanPropertyWriter 对象。
writer.assignNullSerializer(this._nullArrayJsonSerializer); 指定一个serializer ，当属性是Null 的时候，Jackson 会调用这个serializer 会序列化这个属性
writer.assignSerializer(this.dateJsonSerializer); 这个方法，直接指定一个serializer 无论属性是否为空，都使用这对象转化去转化 json 数据。
public class MyBeanSerializerModifier extends BeanSerializerModifier {
private JsonSerializer<Object> _nullArrayJsonSerializer = new MyNullArrayJsonSerializer();
private JsonSerializer<Object> _nullObjectJsonSerializer = new MyNullObjectJsonSerializer();
private JsonSerializer<Object> dateJsonSerializer = new DateJsonSerializer();
@Override
public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties) {
// 循环所有的beanPropertyWriter
for (int i = 0; i < beanProperties.size(); i++) {
BeanPropertyWriter writer = beanProperties.get(i);
// 判断字段的类型，如果是array，list，set则注册nullSerializer
if (isArrayType(writer)) {
//给writer注册一个自己的nullSerializer
writer.assignNullSerializer(this._nullArrayJsonSerializer);
}else if(isStringType(writer)){
writer.assignNullSerializer(this._nullObjectJsonSerializer);
}else if(isDateType(writer)){
writer.assignSerializer(this.dateJsonSerializer);
}
}
return beanProperties;
}
private boolean isDateType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getPropertyType();
return clazz.equals(Date.class);
}
private boolean isStringType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getPropertyType();
return clazz.equals(CharSequence.class) || clazz.equals(String.class);
}
private boolean isArrayType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getPropertyType();
return clazz.isArray() || clazz.equals(List.class) || clazz.equals(Set.class);
}
}
3.把下列bean 对象注册到spring中，对于Jackson 的自定义配置就完成了
对于date 类型做了批量的格式化，全部会被 转化为yyyy-MM-dd 格式。
对于数组 为Null 时对应的json值会是 []。
对于字符为Null 对应的json 值为字符串空 ""。
@Bean
public MappingJackson2HttpMessageConverter mappingJacksonHttpMessageConverter() {
final MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
ObjectMapper mapper = converter.getObjectMapper();
mapper.setSerializerFactory(mapper.getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
converter.setSupportedMediaTypes(ImmutableList.of(MediaType.TEXT_HTML, MediaType.APPLICATION_JSON));
return converter;
}
4.测试使用@RestController 类中方法返回一个对象简单测试
网友评论