Làm cách nào để tùy chỉnh trình ánh xạ Jackson JSON được Spring Boot sử dụng ngầm?

Tôi đang sử dụng Spring Boot (1.2.1), theo cách tương tự như trong hướng dẫn Xây dựng Dịch vụ Web RESTful của họ :

@RestController
public class EventController {

    @RequestMapping("/events/all")
    EventList events() {
        return proxyService.getAllEvents();
    }

}

Vì vậy, ở trên, Spring MVC ngầm sử dụng Jackson để tuần tự EventListđối tượng của tôi thành JSON.

Nhưng tôi muốn thực hiện một số tùy chỉnh đơn giản đối với định dạng JSON, chẳng hạn như:

setSerializationInclusion(JsonInclude.Include.NON_NULL)

Câu hỏi là, cách đơn giản nhất để tùy chỉnh trình ánh xạ JSON ngầm định là gì?

Tôi đã thử cách tiếp cận trong bài đăng blog này , tạo CustomObjectMapper, v.v., nhưng bước 3, "Đăng ký lớp trong bối cảnh Spring", không thành công:

org.springframework.beans.factory.BeanCreationException: 
  Error creating bean with name 'jacksonFix': Injection of autowired dependencies failed; 
  nested exception is org.springframework.beans.factory.BeanCreationException: 
  Could not autowire method: public void com.acme.project.JacksonFix.setAnnotationMethodHandlerAdapter(org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter); 
  nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: 
  No qualifying bean of type [org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter]   
  found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {}

Có vẻ như những hướng dẫn đó dành cho các phiên bản cũ hơn của Spring MVC, trong khi tôi đang tìm một cách đơn giản để làm cho điều này hoạt động với Spring Boot mới nhất.

Nếu bạn đang sử dụng Spring Boot 1.3, bạn có thể định cấu hình bao gồm tuần tự hóa thông qua application.properties:

spring.jackson.serialization-inclusion=non_null

Sau những thay đổi trong Jackson 2.7, Spring Boot 1.4 sử dụng thuộc tính có tên spring.jackson.default-property-inclusionthay thế:

spring.jackson.default-property-inclusion=non_null

Xem phần " Tùy chỉnh Jackson ObjectMapper " trong tài liệu Spring Boot.

Nếu bạn đang sử dụng phiên bản Spring Boot cũ hơn, cách dễ nhất để định cấu hình bao gồm tuần tự hóa trong Spring Boot là khai báo Jackson2ObjectMapperBuilderbean được định cấu hình thích hợp của riêng bạn . Ví dụ:

@Bean
public Jackson2ObjectMapperBuilder objectMapperBuilder() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    builder.serializationInclusion(JsonInclude.Include.NON_NULL);
    return builder;
}

Tôi trả lời hơi muộn cho câu hỏi này, nhưng ai đó, trong tương lai, có thể thấy điều này hữu ích. Cách tiếp cận dưới đây, bên cạnh nhiều cách tiếp cận khác, hoạt động tốt nhất và cá nhân tôi nghĩ sẽ phù hợp hơn với ứng dụng web.

@Configuration
@EnableWebMvc
public class WebConfiguration extends WebMvcConfigurerAdapter {

 ... other configurations

@Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
        builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        builder.propertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);
        builder.serializationInclusion(Include.NON_EMPTY);
        builder.indentOutput(true).dateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        converters.add(new MappingJackson2HttpMessageConverter(builder.build()));
        converters.add(new MappingJackson2XmlHttpMessageConverter(builder.createXmlMapper(true).build()));
    }
}

Rất nhiều thứ có thể được cấu hình trong các tính năng ứng dụng. Rất tiếc, tính năng này chỉ có trong Phiên bản 1.3, nhưng bạn có thể thêm vào Lớp cấu hình

@Autowired(required = true)
public void configureJackson(ObjectMapper jackson2ObjectMapper) {
    jackson2ObjectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
}

[CẬP NHẬT: Bạn phải làm việc trên ObjectMapper vì build()-method được gọi trước khi chạy cấu hình.]

Tài liệu nêu một số cách để thực hiện việc này.

Nếu bạn muốn thay thế ObjectMapperhoàn toàn kiểu mặc định , hãy xác định @Beankiểu đó và đánh dấu là @Primary.

Việc xác định @Beankiểu Jackson2ObjectMapperBuildersẽ cho phép bạn tùy chỉnh cả mặc định ObjectMappervà XmlMapper(được sử dụng trong MappingJackson2HttpMessageConvertervà MappingJackson2XmlHttpMessageConvertertương ứng).

Bạn có thể thêm một phương thức sau vào bên trong lớp bootstrap của mình được chú thích bằng @SpringBootApplication

    @Bean
    @Primary
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
    ObjectMapper objectMapper = builder.createXmlMapper(false).build();
    objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
    objectMapper.configure(SerializationFeature.WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS, false);

    objectMapper.registerModule(new JodaModule());

    return objectMapper;
}

spring.jackson.serialization-inclusion=non_null từng làm việc cho chúng tôi

Nhưng khi chúng tôi nâng cấp phiên bản khởi động mùa xuân lên 1.4.2.RELEASE hoặc cao hơn, nó ngừng hoạt động.

Bây giờ, một tài sản khác spring.jackson.default-property-inclusion=non_nullđang làm điều kỳ diệu.

trên thực tế, serialization-inclusionkhông được dùng nữa. Đây là những gì intellij của tôi ném vào tôi.

Không được chấp nhận: ObjectMapper.setSerializationInclusion không được chấp nhận trong Jackson 2.7

Vì vậy, hãy bắt đầu sử dụng spring.jackson.default-property-inclusion=non_nullthay thế

Tôi tình cờ tìm ra một giải pháp khác, khá hay.

Về cơ bản, chỉ thực hiện bước 2 từ blog đã đăng được đề cập và xác định một ObjectMapper tùy chỉnh làm Spring @Component. (Mọi thứ bắt đầu hoạt động khi tôi vừa xóa tất cả nội dung AnnotationMethodHandlerAdapter từ bước 3)

@Component
@Primary
public class CustomObjectMapper extends ObjectMapper {
    public CustomObjectMapper() {
        setSerializationInclusion(JsonInclude.Include.NON_NULL); 
        configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); 
    }
}

Hoạt động miễn là thành phần nằm trong một gói được quét bởi Spring. ( @PrimaryTrong trường hợp của tôi, việc sử dụng là không bắt buộc, nhưng tại sao không làm cho mọi thứ rõ ràng.)

Đối với tôi, có hai lợi ích so với cách tiếp cận khác:

• Điều này đơn giản hơn; Tôi chỉ có thể mở rộng một lớp học từ Jackson và không cần biết về những thứ quá cụ thể về mùa xuân như Jackson2ObjectMapperBuilder.
• Tôi muốn sử dụng cùng một cấu hình Jackson để deserialising JSON trong một phần khác của ứng dụng của tôi và theo cách này, nó rất đơn giản: new CustomObjectMapper()thay vì new ObjectMapper().

Khi tôi cố gắng đặt ObjectMapper chính trong khởi động mùa xuân 2.0.6, tôi gặp lỗi Vì vậy, tôi đã sửa đổi một chương trình khởi động mùa xuân đã tạo cho tôi

Cũng xem https://stackoverflow.com/a/48519868/255139

@Lazy
@Autowired
ObjectMapper mapper;

@PostConstruct
public ObjectMapper configureMapper() {
    mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    mapper.enable(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT);

    mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    mapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);

    mapper.configure(MapperFeature.ALLOW_COERCION_OF_SCALARS, true);
    mapper.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true);

    SimpleModule module = new SimpleModule();
    module.addDeserializer(LocalDate.class, new LocalDateDeserializer());
    module.addSerializer(LocalDate.class, new LocalDateSerializer());
    mapper.registerModule(module);

    return mapper;
}

Tôi đã tìm thấy giải pháp được mô tả ở trên với:

spring.jackson.serialization-inclusive = non_null

Để chỉ hoạt động bắt đầu từ phiên bản 1.4.0.RELEASE của khởi động mùa xuân. Trong tất cả các trường hợp khác, cấu hình bị bỏ qua.

Tôi đã xác minh điều này bằng cách thử nghiệm với một sửa đổi của mẫu khởi động mùa xuân "spring-boot-sample-jersey"

Tôi biết câu hỏi yêu cầu khởi động Spring, nhưng tôi tin rằng rất nhiều người đang tìm cách thực hiện điều này trong khởi động không phải Spring, giống như tôi đã tìm kiếm gần như cả ngày.

Trên Spring 4, không cần cấu hình MappingJacksonHttpMessageConverternếu bạn chỉ định cấu hình ObjectMapper.

Bạn chỉ cần làm:

public class MyObjectMapper extends ObjectMapper {

    private static final long serialVersionUID = 4219938065516862637L;

    public MyObjectMapper() {
        super();
        enable(SerializationFeature.INDENT_OUTPUT);
    }       
}

Và trong cấu hình Spring của bạn, hãy tạo bean này:

@Bean 
public MyObjectMapper myObjectMapper() {        
    return new MyObjectMapper();
}