Jackson 2.x 系列【25】Spring Boot 集成之起步依赖、自动配置

我会带着你远行 2024-04-23 12:53 0阅读 0赞

> **有道无术，术尚可求，有术无道，止于术。**
> 
> **本系列Jackson 版本 2.17.0** 
> 
> **本系列Spring Boot 版本 3.2.4** 
> 
> **源码地址：https://gitee.com/pearl-organization/study-jaskson-demo**

#### 文章目录 ####

*   *  1. 前言
     *  2. 起步依赖
     *  3. 自动配置
     *   *  3.1 JacksonProperties
         *  3.2 JacksonAutoConfiguration
         *   *  3.2.1 JacksonMixinConfiguration
             *  3.2.2 JacksonObjectMapperBuilderConfiguration
             *  3.2.3 JacksonObjectMapperConfiguration
             *  3.2.4 ParameterNamesModuleConfiguration
             *  3.2.5 Jackson2ObjectMapperBuilderCustomizerConfiguration
         *  3.3 Jackson2ObjectMapperBuilderCustomizer

### 1. 前言 ###

`Spring Boot`是当前最流行的`Java`应用开发框架，简化开发的同时也导致了很多开发人员只会写业务代码，并不太清楚内部组件和配置细节，一旦出问题或者需要性能优化时，就会显得无从下手。

所以推荐大家要多学习一下基础的应用框架，了解它们的详细用法和核心原理，不要太依赖于`Spring Boot`的自动化。

接下来我们学习`Spring Boot`是如何集成的`Jackson`，并针对开发中常见的问题进行实战演示。

### 2. 起步依赖 ###

`Spring Boot`起步依赖（`Starter Dependency`）机制，针对常见场景需要的依赖进行了统一打包处理，使用时只需要引入`Starter`包即可。

例如针对`JSON`应用场景，在`Spring Boot`中提供了`spring-boot-starter-json`启动器，默认引入的`JSON`库是`Jackson`：

dependencies {
        
    	api(project(":spring-boot-project:spring-boot-starters:spring-boot-starter"))
    	api("org.springframework:spring-web")
    	api("com.fasterxml.jackson.core:jackson-databind")
    	api("com.fasterxml.jackson.datatype:jackson-datatype-jdk8")
    	api("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
    	api("com.fasterxml.jackson.module:jackson-module-parameter-names")
    }

除了`jackson-databind`，还引入非核心模块`jackson-datatype-jdk8`、`jackson-datatype-jsr310`、`jackson-module-parameter-names`，所以在`Spring Boot`环境中，可以直接处理`LocalDateTime`。

### 3. 自动配置 ###

`Spring Boot`基于约定大于配置思想，引入了`Starter`包后，启动时扫描自动配置类，并自动装配声明的`Bean`组件，开发者无需手动进行繁琐的配置，从而提高了开发效率，降低了维护成本。

`spring-boot-autoconfigure`模块中包含了对`Jackson`的自动配置：

![在这里插入图片描述][7fcb27e0de6343dab161c1b5351a4a43.png]

#### 3.1 JacksonProperties ####

`Spring Boot`提供了配置属性类`JacksonProperties`，方便我们直接在`application.yml`配置文件中指定一些转换策略：  
![在这里插入图片描述][f76b4eaa8a4d49849e197f545b8b258a.png]

**全部属性配置如下：**

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<SerializationFeature, Boolean>
        serialization:
          EAGER_SERIALIZER_FETCH: true
        # 反序列化特征，Map<DeserializationFeature, Boolean>
        deserialization:
          USE_BIG_DECIMAL_FOR_FLOATS: true
        # ObjectMapper/JsonMapper特征,Map<MapperFeature, Boolean>
        mapper:
          AUTO_DETECT_GETTERS: true
        # 生成器JsonGenerator.Feature，Map<com.fasterxml.jackson.core.JsonGenerator.Feature, Boolean>
        generator:
          AUTO_CLOSE_TARGET: true
        # 地区
        locale: zh_CN
        # 解析器 Map<Feature, Boolean>
        # parser:
        # 设置属性命名策略,对应jackson下PropertyNamingStrategy中的常量值，SNAKE_CASE-返回的json驼峰式转下划线，json body下划线传到后端自动转驼峰式
        property-naming-strategy: SNAKE_CASE
        # 全局时区
        time-zone: GMT+8
        # 可见性阈值，可用于限制自动检测哪些方法（和字段）。
        visibility:
          GETTER: ANY

#### 3.2 JacksonAutoConfiguration ####

`Spring Boot`提供了自动配置类`JacksonAutoConfiguration`，包含了多个内部配置类：

![在这里插入图片描述][660be94514494deba95fa4c50f7566d7.png]  
在自动配置类的`static`块中，配置了两个默认特征，设置序列化日志时间不使用**时间戳**，并注册`JsonComponentModule Bean` 对象，用于注册所有`@JsonComponent`标识的`Bean`：

@AutoConfiguration
    @ConditionalOnClass({
        ObjectMapper.class})
    public class JacksonAutoConfiguration {
        
    
        @Bean
        public JsonComponentModule jsonComponentModule() {
        
            return new JsonComponentModule();
        }
        
        private static final Map<?, Boolean> FEATURE_DEFAULTS;
        
        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);
        }
        // 省略内部配置类

##### 3.2.1 JacksonMixinConfiguration #####

内部自动配置类`JacksonMixinConfiguration`用于扫描`@JsonMixin`标识的类并注册，以支持混合注解：

@Configuration(proxyBeanMethods = false)
    	static class JacksonMixinConfiguration {
        
    		@Bean
    		static JsonMixinModuleEntries jsonMixinModuleEntries(ApplicationContext context) {
        
    			List<String> packages = AutoConfigurationPackages.has(context) ? AutoConfigurationPackages.get(context)
    					: Collections.emptyList();
    			return JsonMixinModuleEntries.scan(context, packages);
    		}
    		@Bean
    		JsonMixinModule jsonMixinModule(ApplicationContext context, JsonMixinModuleEntries entries) {
        
    			JsonMixinModule jsonMixinModule = new JsonMixinModule();
    			jsonMixinModule.registerEntries(entries, context.getClassLoader());
    			return jsonMixinModule;
    		}
    	}

##### 3.2.2 JacksonObjectMapperBuilderConfiguration #####

内部自动配置类`JacksonObjectMapperBuilderConfiguration`注册了一个多例的`Jackson2ObjectMapperBuilder`（用于构建`ObjectMapper`对象），并调用所有的定制器`Jackson2ObjectMapperBuilderCustomizer`进行定制化处理：

@Configuration(proxyBeanMethods = false)
    	@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
    	static class JacksonObjectMapperBuilderConfiguration {
        
    
    		@Bean
    		@Scope("prototype")
    		@ConditionalOnMissingBean
    		Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder(ApplicationContext applicationContext,
    				List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
        
    			Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    			builder.applicationContext(applicationContext);
    			customize(builder, customizers);
    			return builder;
    		}
    
    		private void customize(Jackson2ObjectMapperBuilder builder,
    				List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
        
    			for (Jackson2ObjectMapperBuilderCustomizer customizer : customizers) {
        
    				customizer.customize(builder);
    			}
    		}
    
    	}

##### 3.2.3 JacksonObjectMapperConfiguration #####

内部自动配置类`JacksonObjectMapperConfiguration`注册了一个单例的`ObjectMapper Bean` 对象到容器中，是使用容器中的`Jackson2ObjectMapperBuilder`构建的，并且是线程安全的，所以在使用时直接使用`@Autowired`注入该实例即可。

@Configuration(proxyBeanMethods = false)
    	@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
    	static class JacksonObjectMapperConfiguration {
        
    		@Bean
    		@Primary // 主要的
    		@ConditionalOnMissingBean // 在应用程序没有注册ObjectMapper时生效
    		ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        
    			return builder.createXmlMapper(false).build();
    		}
    	}

##### 3.2.4 ParameterNamesModuleConfiguration #####

内部自动配置类`ParameterNamesModuleConfiguration`用于注册了`ParameterNamesModule`：

@Configuration(proxyBeanMethods = false)
    	@ConditionalOnClass(ParameterNamesModule.class)
    	static class ParameterNamesModuleConfiguration {
        
    
    		@Bean
    		@ConditionalOnMissingBean
    		ParameterNamesModule parameterNamesModule() {
        
    			return new ParameterNamesModule(JsonCreator.Mode.DEFAULT);
    		}
    
    	}

##### 3.2.5 Jackson2ObjectMapperBuilderCustomizerConfiguration #####

内部自动配置类`Jackson2ObjectMapperBuilderCustomizerConfiguration`的主要作用是将`JacksonProperties`、`Module`中的配置，集成到应用环境中。

注册了一个`StandardJackson2ObjectMapperBuilderCustomizer`：

![在这里插入图片描述][c884a0124b0446439e0fcee9119c49f6.png]

`StandardJackson2ObjectMapperBuilderCustomizer`实现了`Jackson2ObjectMapperBuilderCustomizer`，所以在自动注册`Jackson2ObjectMapperBuilder`时，会调用`customize`方法，将`JacksonProperties`的配置项都集成到`Jackson2ObjectMapperBuilder`中：

![在这里插入图片描述][82a9eaac0ccb46969dd90837fde8c7d7.png]

#### 3.3 Jackson2ObjectMapperBuilderCustomizer ####

`Jackson2ObjectMapperBuilderCustomizer`定制器接口，用于对`Jackson2ObjectMapperBuilder`的构建行为进行定制：

@FunctionalInterface
    public interface Jackson2ObjectMapperBuilderCustomizer {
        
    
    	void customize(Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder);
    
    }

他们之间的关系如下所示：  
![在这里插入图片描述][001ba8d45fd04a1583c7c014c63324b0.png]

在实际开发中，可以注册`Jackson2ObjectMapperBuilderCustomizer`来配置`ObjectMapper`：

@Bean
        public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        
            return builder -> {
        
                builder.serializerByType(Long.class, com.fasterxml.jackson.databind.ser.std.ToStringSerializer.instance);
                builder.deserializerByType(Long.class,com.fasterxml.jackson.databind.ser.std.ToStringSerializer.instance);
            };
        }

[7fcb27e0de6343dab161c1b5351a4a43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/589162686da34759bec4426785b7f19f.png
[f76b4eaa8a4d49849e197f545b8b258a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/33f02ca12c3a4af69d3e782be5c248ad.png
[660be94514494deba95fa4c50f7566d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/e542f00d171843afbc91644a10608015.png
[c884a0124b0446439e0fcee9119c49f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/253ce232373a44d9a8cba057cd3c2994.png
[82a9eaac0ccb46969dd90837fde8c7d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/ec5a1b389b4047bdbb3106a557af933b.png
[001ba8d45fd04a1583c7c014c63324b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/d1a4c4efdbed421c8fd14d436b1af298.png