Spring Boot 2.x系列【17】功能篇之JSON

MapperFeature则是可以控制JsonMapper、0bjectMapper、0bjectReader、objectwriter的映射/绑定行为，可配置项如下：

    // 是否启用使用注解。true:将会使用AnnotationIntrospector去解析注解;false:忽略标注上的注解
    USE_ANNOTATIONS(true),

    // 是否可以通过get到集合/映射的引用来修改属性，而不需要专门提供set方法
    USE_GETTERS_AS_SETTERS(true),

    // 如何处理被transient修饰的关键字。true:会识别它(不再参与序列化反序列化) , false:忽略这个关键字PROPAGATE_瞬变标记(FALSE)：如何处理被瞬态修饰的关键字。真：会识别它(不再参与序列化反序列化)，假：忽略这个关键字
    PROPAGATE_TRANSIENT_MARKER(false),

    // 是否开启自动检测创建方法的特性。true：会找到public的构造方法 or 只有一个参数的valueOf方法；false：必须使用@JsonCreator注解去指定一个方法用于创建（空的构造方法除外，即使该特征关闭且是private都成）
    AUTO_DETECT_CREATORS(true),

    // 是否开启自动检测属性。true：所有的public field成员都会被认为是属性；false：那么只有被标为指定注解的才算（使用@JsonAutoDetect）
    AUTO_DETECT_FIELDS(true),

    // true：那么所有的0个参数且以get开头的方法都会被认为是属性；false：只能靠注解
    AUTO_DETECT_GETTERS(true),

    // 所有的0个参数且以is开头且返回值是boolean类型的会被认为是属性；false：只能依靠注解
    AUTO_DETECT_IS_GETTERS(true),

    // set方法（控制哪些属性可以被set进来）
    AUTO_DETECT_SETTERS(true),

    // 如果这个配置为false时，只有存在对应的构造器、setter或者field时，才调用getter。
    REQUIRE_SETTERS_FOR_GETTERS(false),

    // 标记为final的field是否也可以被get方法匹配
    ALLOW_FINAL_FIELDS_AS_MUTATORS(true),

    // private的field是否也可以被get方法匹配到
    INFER_PROPERTY_MUTATORS(true),

    // 是否支持JavaEE的注解@ConstructorProperties，效果同@JsonCreator
    INFER_CREATOR_FROM_CONSTRUCTOR_PROPERTIES(true),

    // 是否允许调用AccessibleObject#setAccessible来让一切set方法or filed属性可以直接访问（注意：若你关闭此特征，也就是开启了权限检查的话，对性能是有较大损耗的，所以一般请不要这么做）
    CAN_OVERRIDE_ACCESS_MODIFIERS(true),

    //  针对紧邻的上特征的优化。也就是说若你上面特征开启了的话，理论上所有的权限都要去校验。但此处优化为若是public的话也依旧不执行访问检查了，提高public的整体效率
    OVERRIDE_PUBLIC_ACCESS_MODIFIERS(true),

    // 是否使用静态类型。true：使用运行时候的动态类型，false：使用声明时的静态类型
    USE_STATIC_TYPING(false),

    // 2.10新增的特征。是否使用BASE_TYPE当作反序列化时的多态类型的默认类型。true：使用；false：不使用。当然你也是可以手动通过@JsonTypeInfo.defaultImpl注解属性来指定的
    USE_BASE_TYPE_AS_DEFAULT_IMPL(false),

    // 这个特征和@JsonView息息相关。true：即使没有标注有@JsonView注解的属性，会被应用到所有的视图view里面；false：只有标注有@JsonView的属性才会进入到对应视图里
    DEFAULT_VIEW_INCLUSION(true),

    // 是否开启默认的序列化顺序。true：Bean的序列化会按照字母表顺序；false：无序。
    SORT_PROPERTIES_ALPHABETICALLY(false),

    // 首先对创建者属性进行排序
    SORT_CREATOR_PROPERTIES_FIRST(true),

    // 反序列化时是否对大小写敏感。true：不敏感；false：敏感
    ACCEPT_CASE_INSENSITIVE_PROPERTIES(false),

    // 反序列化时是否对大小写敏感。true：不敏感；false：敏感
    ACCEPT_CASE_INSENSITIVE_ENUMS(false),

    // 允许解析某些枚举的基于文本的值类型，但忽略大小写的特性。如对date/time的序列化，忽略上面的大小写
    ACCEPT_CASE_INSENSITIVE_VALUES(false),

    //  使用包装名称作为属性名称
    USE_WRAPPER_NAME_AS_PROPERTY_NAME(false),

    // 是否使用原始输出Bean Name。默认的是false的，是为了保证向下兼容
    USE_STD_BEAN_NAMING(false),

    // 是否允许再修改已经被命名的属性名
    ALLOW_EXPLICIT_PROPERTY_RENAMING(false),

    // 对scalar的一些类型的适配处理，保持默认开启即可
    ALLOW_COERCION_OF_SCALARS(true),

    // 是否开启重复模块的注册
    IGNORE_DUPLICATE_MODULE_REGISTRATIONS(true),

    // 对于不能被合并的属性（什么叫不能被合并的属性？）若你要合并时是否忽略。true：忽略它。false：抛出异常
    IGNORE_MERGE_FOR_UNMERGEABLE(true),

    // 阻止不安全的多态基类型
    BLOCK_UNSAFE_POLYMORPHIC_BASE_TYPES(false),

    // 使用默认值
    APPLY_DEFAULT_VALUES(true);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

2、ObjectMapper

ObjectMapper是Jackson最重要的一个类，是面向用户的高层API，我们需要进行JSON 转换，指定特征时，直接使用这个对象就可以了。

Jackson和Fastjson对比

国内用的比较多的，应该就是Jackson 和Fastjson了，我们应该怎么选呢？

首先简单看下他们的使用方式，比如将Java对象序列化为JSON字符串：

// Fastjson
String jsonString = JSON.toJSONString(user); 
// Jackson
ObjectMapper objectMapper = new ObjectMapper();  
String jsonString = objectMapper.writeValueAsString(user);
1
2
3
4
5

将JSON字符串反序列化为JavaBean：

// Fastjson
Model model = JSON.parseObject(jsonStr, Model.class);
// Jackson
ObjectMapper objectMapper = new ObjectMapper();  
Person person1 = objectMapper.readValue(jsonStr, Person.class);
1
2
3
4
5

Fastjson直接使用JSON类的静态方法进行转换操作，Jackson 需要实例化ObjectMapper 对象。
其他性能、安全方面的测试对比，可以自己在百度搜搜~

综合来说，二者都是非常优秀且成功的框架，性能上来说，Fastjson可能更受一筹，但是从稳定性、安全性、代码规范性、扩展性来说，Jackson 稍占优势。

在网上有很多Jackson 和Fastjson深度对比，到底改怎么选的文章，甚至还有阿里出品必属废品、公司已经禁用fastjson了种种言论。

Fastjson作为一个几乎靠温少一人之力扛起来的国产框架，其优秀和成功程度毋庸置疑，多多支持，国产才会进步。

Spring MVC 中的 JSON

Spring MVC 是一个WEB 框架，现在大多都是前后端分离开发，而前后端很多接口都是通过application/json进行交互，在进行请求和响应处理时，毫无疑问，肯定要进行对象和JSON转换，比如代码中响应结果都是对象，需要转换为JSON传输给前端。

而Spring MVC 中进行对象转换操作的就是HttpMessageConverter消息转换器，而对JSON 进行转换就是基于Jackson 实现的转换器，这也是默认选项，关于这些内容可以参考Spring MVC系列（8）-HttpMessageConverter之使用分析

Spring MVC 除了提供基于Jackson 实现的转换器之外，还提供了获取ObjectMapper实例的两个类，一个是构建器，一个是FactoryBean 。

Spring Boot 中的 JSON

Spring Boot 提供了三个 JSON 库的集成：

• Gson
• Jackson
• JSON-B

Jackson 是默认首选。

可以看到在 spring-boot-starter-json 中，包含了Jackson 相关的依赖。

既然默认携带了Jackson，就没有必要额外再费功夫引入另一种 JSON 库了，用默认的就OK了。

自动配置 Jackson

Spring Boot 对于Jackson 也提供了自动配置功能。

JacksonProperties

首先提供了配置属性类JacksonProperties，方便我们直接在YML 配置文件中指定一些转换策略：

全部属性配置如下：

spring:
  jackson:
    constructor-detector: EXPLICIT_ONLY
    # 设置日志格式化格式，配置为日期格式字符串或完全限定的日期格式类名。例如 yyyy-MM-dd HH:mm:ss
    date-format: yyyy-MM-dd HH:mm:ss
    # 宽松的全局默认设置
    default-leniency: true
    # 控制序列化期间包含的属性。使用 Jackson 的 JsonInclude.Include 枚举中的值之一进行配置。
    default-property-inclusion: always
    # 序列化配置 ，MAP 集合 ， Map
    serialization:
      EAGER_SERIALIZER_FETCH: true
    # 反序列化特征，Map
    deserialization:
      USE_BIG_DECIMAL_FOR_FLOATS: true
    # ObjectMapper/JsonMapper特征,Map
    mapper:
      AUTO_DETECT_GETTERS: true
    # 生成器JsonGenerator.Feature，Map
    generator:
      AUTO_CLOSE_TARGET: true
    # 地区
    locale: zh_CN
    # 解析器 Map
    # parser:
    # 设置属性命名策略,对应jackson下PropertyNamingStrategy中的常量值，SNAKE_CASE-返回的json驼峰式转下划线，json body下划线传到后端自动转驼峰式
    property-naming-strategy: SNAKE_CASE
    # 全局时区
    time-zone: GMT+8
    # 可见性阈值，可用于限制自动检测哪些方法（和字段）。
    visibility:
      GETTER: ANY
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

Jackson2ObjectMapperBuilderCustomizer

Jackson2ObjectMapperBuilderCustomizer从字面上理解时一个构造器的定制器，可以实现该接口，给Jackson2ObjectMapperBuilder添加一些配置。

然后在Spring 容器注册一个该类型的Bean 对象：

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer customizeJackson2ObjectMapper() {
        return builder -> builder
                .indentOutput(true)
                .propertyNamingStrategy(PropertyNamingStrategy.PASCAL_CASE_TO_CAMEL_CASE)
                .simpleDateFormat("yyyyMMdd").build();
    }
1
2
3
4
5
6
7

在实例化Jackson2ObjectMapperBuilder （Spring MVC 提供的ObjectMapper 构建器）对象的时候，会调用容器中所有的定制器，配置构建者，这也就是提供了一个扩展点，可以使用这种方式定制我们的ObjectMapper 。

JacksonAutoConfiguration

JacksonAutoConfiguration为自动配置类，启动声明了一个定制器，将JacksonProperties中配置的特征等传递给构建器。

注册了一个构建器，并调用所有的定制器的定制方法。

        @Bean
        @Scope("prototype")
        @ConditionalOnMissingBean
        Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder(ApplicationContext applicationContext, List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
        	// 创建构建器
            Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
            builder.applicationContext(applicationContext);
            // 调用所有的定制器
            this.customize(builder, customizers);
            return builder;
        }
     private void customize(Jackson2ObjectMapperBuilder builder, List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
            Iterator var3 = customizers.iterator();

            while(var3.hasNext()) {
                Jackson2ObjectMapperBuilderCustomizer customizer = (Jackson2ObjectMapperBuilderCustomizer)var3.next();
                customizer.customize(builder);
            }
        }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

在自动配置类的static 块中，声明了两个默认特征，序列化时时间格式的数据不使用时间戳的方式，而原本的配置是true，

    static {
        Map<Object, Boolean> featureDefaults = new HashMap();
        featureDefaults.put(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        featureDefaults.put(SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS, false);
        FEATURE_DEFAULTS = Collections.unmodifiableMap(featureDefaults);
    }
1
2
3
4
5
6

最重要的是，可以看到Spring Boot 为我们注册了一个单例ObjectMapper 到容器中，是线程安全的，所以在使用Spring Boot 时不要再傻乎乎的去new 了~~~~

        @Bean
        @Primary
        @ConditionalOnMissingBean
        ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
            return builder.createXmlMapper(false).build();
        }
1
2
3
4
5
6