71.3 自定義Jackson ObjectMapper · Spring Boot參考指南

### 71.3 自定義Jackson ObjectMapper 在一個HTTP交互中，Spring MVC（客戶端和服務端）使用`HttpMessageConverters`協商內容轉換。如果classpath下存在Jackson，你就獲取到`Jackson2ObjectMapperBuilder`提供的默認轉換器，這是Spring Boot為你自動配置的實例。創建的`ObjectMapper`（或用于Jackson XML轉換的`XmlMapper`）實例默認有以下自定義屬性： - `MapperFeature.DEFAULT_VIEW_INCLUSION`，默認是禁用的 - `DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES`，默認是禁用的 Spring Boot也有一些用于簡化自定義該行為的特性。你可以使用當前的environment配置`ObjectMapper`和`XmlMapper`實例。Jackson提供一個擴展套件，可以用來關閉或開啟一些特性，你可以用它們配置Jackson以處理不同方面。這些特性在Jackson中是使用6個枚舉進行描述的，并被映射到environment的屬性上： |Jackson枚舉|Environment屬性| |------|:-------| |`com.fasterxml.jackson.databind.DeserializationFeature`|`spring.jackson.deserialization.<feature_name>=true|false`| |`com.fasterxml.jackson.core.JsonGenerator.Feature`|`spring.jackson.generator.<feature_name>=true|false`| |`com.fasterxml.jackson.databind.MapperFeature`|`spring.jackson.mapper.<feature_name>=true|false`| |`com.fasterxml.jackson.core.JsonParser.Feature`|`spring.jackson.parser.<feature_name>=true|false`| |`com.fasterxml.jackson.databind.SerializationFeature`|`spring.jackson.serialization.<feature_name>=true|false`| |`com.fasterxml.jackson.annotation.JsonInclude.Include`|`spring.jackson.serialization-inclusion=always|non_null|non_absent|non_default|non_empty`| 例如，設置`spring.jackson.serialization.indent_output=true`可以美化打印輸出（pretty print）。注意，由于[松散綁定](333033)的使用，`indent_output`不必匹配對應的枚舉常量`INDENT_OUTPUT`。基于environment的配置會應用到自動配置的`Jackson2ObjectMapperBuilder` bean，然后應用到通過該builder創建的mappers，包括自動配置的`ObjectMapper` bean。 `ApplicationContext`中的`Jackson2ObjectMapperBuilder`可以通過`Jackson2ObjectMapperBuilderCustomizer` bean自定義。這些customizer beans可以排序，Spring Boot自己的customizer序號為0，其他自定義可以應用到Spring Boot自定義之前或之后。所有類型為`com.fasterxml.jackson.databind.Module`的beans都會自動注冊到自動配置的`Jackson2ObjectMapperBuilder`，并應用到它創建的任何`ObjectMapper`實例。這提供了一種全局機制，用于在為應用添加新特性時貢獻自定義模塊。如果想完全替換默認的`ObjectMapper`，你既可以定義該類型的`@Bean`并注解`@Primary`，也可以定義`Jackson2ObjectMapperBuilder` `@Bean`，通過builder構建。注意不管哪種方式都會禁用所有的自動配置`ObjectMapper`。如果你提供`MappingJackson2HttpMessageConverter`類型的`@Bean`，它們將替換MVC配置中的默認值。Spring Boot也提供了一個`HttpMessageConverters`類型的便利bean（如果你使用MVC默認配置，那它就總是可用的），它提供了一些有用的方法來獲取默認和用戶增強的消息轉換器（message converters）。具體詳情可參考[Section 71.4, “Customize the @ResponseBody rendering”](333371)及[WebMvcAutoConfiguration](https://github.com/spring-projects/spring-boot/tree/v1.4.1.RELEASE/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java)源碼。