การกำหนดค่า ObjectMapper ใน Spring

เป้าหมายของฉันคือการกำหนดค่าobjectMapperในทางที่มัน serialises @JsonPropertyองค์ประกอบซึ่งมีคำอธิบายประกอบกับ

ในการดำเนินการดังกล่าวฉันทำตามคำอธิบายนี้ซึ่งระบุวิธีกำหนดค่า objectmapper

ผมรวม objectmapper ที่กำหนดเองตามที่อธิบายไว้ที่นี่

อย่างไรก็ตามเมื่อคลาสNumbersOfNewEventsถูกทำให้เป็นอนุกรมมันยังคงมีแอตทริบิวต์ทั้งหมดใน json

ใครมีคำใบ้? ขอบคุณล่วงหน้า

แจ็คสัน 1.8.0 สปริง 3.0.5

CustomObjectMapper

public class CompanyObjectMapper extends ObjectMapper {
    public CompanyObjectMapper() {
        super();
        setVisibilityChecker(getSerializationConfig()
                .getDefaultVisibilityChecker()
                .withCreatorVisibility(JsonAutoDetect.Visibility.NONE)
                .withFieldVisibility(JsonAutoDetect.Visibility.NONE)
                .withGetterVisibility(JsonAutoDetect.Visibility.NONE)
                .withIsGetterVisibility(JsonAutoDetect.Visibility.NONE)
                .withSetterVisibility(JsonAutoDetect.Visibility.DEFAULT));
    }
}

servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

    <context:component-scan base-package="de.Company.backend.web" />

    <mvc:annotation-driven />

    <bean
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="messageConverters">
            <list>
                <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                    <property name="objectMapper" ref="jacksonObjectMapper" />
                </bean>
            </list>
        </property>
    </bean>

    <bean id="jacksonObjectMapper" class="de.Company.backend.web.CompanyObjectMapper" />
</beans>

NumbersOfNewEvents

public class NumbersOfNewEvents implements StatusAttribute {

    public Integer newAccepts;
    public Integer openRequests;

    public NumbersOfNewEvents() {
        super();
    }
}

การใช้ Spring Boot (1.2.4) และ Jackson (2.4.6) การกำหนดค่าตามคำอธิบายประกอบต่อไปนี้ใช้ได้ผลสำหรับฉัน

@Configuration
public class JacksonConfiguration {

    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        mapper.configure(MapperFeature.DEFAULT_VIEW_INCLUSION, true);

        return mapper;
    }
}

อาจเป็นเพราะฉันใช้ Spring 3.1 (แทนที่จะเป็น Spring 3.0.5 ตามที่คุณระบุคำถาม) แต่คำตอบของ Steve Eastwood ไม่ได้ผลสำหรับฉัน โซลูชันนี้ใช้ได้กับ Spring 3.1:

ในบริบท xml ฤดูใบไม้ผลิของคุณ:

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
            <property name="objectMapper" ref="jacksonObjectMapper" />
        </bean>        
    </mvc:message-converters>
</mvc:annotation-driven>

<bean id="jacksonObjectMapper" class="de.Company.backend.web.CompanyObjectMapper" />

มีorg.springframework.http.converter.json.Jackson2ObjectMapperFactoryBeanมาช้านาน. Spring Boot ตั้งแต่ 1.2 รีลีสมีorg.springframework.http.converter.json.Jackson2ObjectMapperBuilderสำหรับ Java Config

ในการกำหนดค่า String Boot สามารถทำได้ง่ายๆดังนี้:

spring.jackson.deserialization.<feature_name>=true|false
spring.jackson.generator.<feature_name>=true|false
spring.jackson.mapper.<feature_name>=true|false
spring.jackson.parser.<feature_name>=true|false
spring.jackson.serialization.<feature_name>=true|false
spring.jackson.default-property-inclusion=always|non_null|non_absent|non_default|non_empty

ในclasspath:application.propertiesหรือโค้ด Java ใน@Configurationคลาส:

@Bean
public Jackson2ObjectMapperBuilder jacksonBuilder() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    builder.indentOutput(true).dateFormat(new SimpleDateFormat("yyyy-MM-dd"));
    return builder;
}

ดู:

• เอกสารอย่างเป็นทางการ74.3 ปรับแต่ง Jackson ObjectMapper
• https://dzone.com/articles/latest-jackson-integration
• คุณตั้งค่า Jackson ทั่วโลกให้ละเว้นคุณสมบัติที่ไม่รู้จักภายใน Spring ได้อย่างไร?
• http://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.html

ฉันเคยใช้กับ Jackson 2.xและ Spring 3.1.2+

servlet-context.xml:

โปรดทราบว่าองค์ประกอบรากคือ<beans:beans>ดังนั้นคุณอาจต้องลบbeansและเพิ่มmvcองค์ประกอบเหล่านี้บางส่วนขึ้นอยู่กับการตั้งค่าของคุณ

    <annotation-driven>
        <message-converters>
            <beans:bean
                class="org.springframework.http.converter.StringHttpMessageConverter" />
            <beans:bean
                class="org.springframework.http.converter.ResourceHttpMessageConverter" />
            <beans:bean
                class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <beans:property name="objectMapper" ref="jacksonObjectMapper" />
            </beans:bean>
        </message-converters>
    </annotation-driven>

    <beans:bean id="jacksonObjectMapper"
        class="au.edu.unimelb.atcom.transfer.json.mappers.JSONMapper" />

au.edu.unimelb.atcom.transfer.json.mappers.JSONMapper.java:

public class JSONMapper extends ObjectMapper {

    public JSONMapper() {
        SimpleModule module = new SimpleModule("JSONModule", new Version(2, 0, 0, null, null, null));
        module.addSerializer(Date.class, new DateSerializer());
        module.addDeserializer(Date.class, new DateDeserializer());
        // Add more here ...
        registerModule(module);
    }

}

DateSerializer.java:

public class DateSerializer extends StdSerializer<Date> {

    public DateSerializer() {
        super(Date.class);
    }

    @Override
    public void serialize(Date date, JsonGenerator json,
            SerializerProvider provider) throws IOException,
            JsonGenerationException {
        // The client side will handle presentation, we just want it accurate
        DateFormat df = StdDateFormat.getBlueprintISO8601Format();
        String out = df.format(date);
        json.writeString(out);
    }

}

DateDeserializer.java:

public class DateDeserializer extends StdDeserializer<Date> {

    public DateDeserializer() {
        super(Date.class);
    }

    @Override
    public Date deserialize(JsonParser json, DeserializationContext context)
            throws IOException, JsonProcessingException {
        try {
            DateFormat df = StdDateFormat.getBlueprintISO8601Format();
            return df.parse(json.getText());
        } catch (ParseException e) {
            return null;
        }
    }

}

ฉันพบวิธีแก้ปัญหาแล้วโดยอ้างอิงจากhttps://github.com/FasterXML/jackson-module-hibernate

ฉันขยายตัวทำแผนที่วัตถุและเพิ่มแอตทริบิวต์ในตัวสร้างที่สืบทอดมา

จากนั้นตัวทำแผนที่วัตถุใหม่จะถูกลงทะเบียนเป็นถั่ว

<!-- https://github.com/FasterXML/jackson-module-hibernate -->
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <array>
            <bean id="jsonConverter"
            class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper">
                    <bean class="de.company.backend.spring.PtxObjectMapper"/>
                </property>
            </bean>
        </array>
    </property>
</bean>   

หากคุณต้องการเพิ่ม ObjectMapper ที่กำหนดเองสำหรับการลงทะเบียนซีเรียลไลเซอร์แบบกำหนดเองลองคำตอบของฉัน

ในกรณีของฉัน (Spring 3.2.4 และ Jackson 2.3.1) การกำหนดค่า XML สำหรับ serializer แบบกำหนดเอง:

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="false">
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                    <property name="serializers">
                        <array>
                            <bean class="com.example.business.serializer.json.CustomObjectSerializer"/>
                        </array>
                    </property>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

อยู่ในวิธีที่อธิบายไม่ได้ถูกเขียนทับกลับไปเป็นค่าเริ่มต้นโดยบางสิ่ง

สิ่งนี้ใช้ได้ผลสำหรับฉัน:

CustomObject.java

@JsonSerialize(using = CustomObjectSerializer.class)
public class CustomObject {

    private Long value;

    public Long getValue() {
        return value;
    }

    public void setValue(Long value) {
        this.value = value;
    }
}

CustomObjectSerializer.java

public class CustomObjectSerializer extends JsonSerializer<CustomObject> {

    @Override
    public void serialize(CustomObject value, JsonGenerator jgen,
        SerializerProvider provider) throws IOException,JsonProcessingException {
        jgen.writeStartObject();
        jgen.writeNumberField("y", value.getValue());
        jgen.writeEndObject();
    }

    @Override
    public Class<CustomObject> handledType() {
        return CustomObject.class;
    }
}

ไม่<mvc:message-converters>(...)</mvc:message-converters>จำเป็นต้องมีการกำหนดค่า XML ( ) ในโซลูชันของฉัน

แนวทางแก้ไข 1

โซลูชันการทำงานแรก (ทดสอบแล้ว) มีประโยชน์โดยเฉพาะเมื่อใช้ @EnableWebMvc:

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private ObjectMapper objectMapper;// created elsewhere
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        // this won't add a 2nd MappingJackson2HttpMessageConverter 
        // as the SOLUTION 2 is doing but also might seem complicated
        converters.stream().filter(c -> c instanceof MappingJackson2HttpMessageConverter).forEach(c -> {
            // check default included objectMapper._registeredModuleTypes,
            // e.g. Jdk8Module, JavaTimeModule when creating the ObjectMapper
            // without Jackson2ObjectMapperBuilder
            ((MappingJackson2HttpMessageConverter) c).setObjectMapper(this.objectMapper);
        });
    }

แนวทางแก้ไข 2

แน่นอนว่าแนวทางทั่วไปด้านล่างก็ใช้ได้เช่นกัน (ทำงานร่วมกับ @EnableWebMvc):

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private ObjectMapper objectMapper;// created elsewhere
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        // this will add a 2nd MappingJackson2HttpMessageConverter 
        // (additional to the default one) but will work and you 
        // won't lose the default converters as you'll do when overwriting
        // configureMessageConverters(List<HttpMessageConverter<?>> converters)
        // 
        // you still have to check default included
        // objectMapper._registeredModuleTypes, e.g.
        // Jdk8Module, JavaTimeModule when creating the ObjectMapper
        // without Jackson2ObjectMapperBuilder
        converters.add(new MappingJackson2HttpMessageConverter(this.objectMapper));
    }

ทำไมการใช้งาน @EnableWebMvc จึงมีปัญหา

@EnableWebMvc กำลังใช้DelegatingWebMvcConfigurationซึ่งขยายWebMvcConfigurationSupportซึ่งทำสิ่งนี้:

if (jackson2Present) {
    Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.json();
    if (this.applicationContext != null) {
        builder.applicationContext(this.applicationContext);
    }
    messageConverters.add(new MappingJackson2HttpMessageConverter(builder.build()));
}

ซึ่งหมายความว่าไม่มีวิธีการฉีดของคุณเองObjectMapperโดยมีจุดประสงค์เพื่อเตรียมใช้สำหรับสร้างค่าเริ่มต้นMappingJackson2HttpMessageConverterเมื่อใช้ @EnableWebMvc

ฉันใช้ Spring 4.1.6 และ Jackson FasterXML 2.1.4

    <mvc:annotation-driven>
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="objectMapper">
                    <bean class="com.fasterxml.jackson.databind.ObjectMapper">
                        <!-- 设置不输出null字段-->
                        <property name="serializationInclusion" value="NON_NULL"/>
                    </bean>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

ใช้งานได้ที่การกำหนดค่า applicationContext.xml ของฉัน

ในการกำหนดค่าตัวแปลงข้อความในสปริงเว็บธรรมดาในกรณีนี้เพื่อเปิดใช้งาน Java 8 JSR-310 JavaTimeModule ก่อนอื่นคุณต้องนำไปใช้WebMvcConfigurerใน@Configurationคลาสของคุณจากนั้นจึงแทนที่configureMessageConvertersเมธอด:

@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().modules(new JavaTimeModule(), new Jdk8Module()).build()
            .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
    converters.add(new MappingJackson2HttpMessageConverter(objectMapper));
}

ด้วยวิธีนี้คุณสามารถลงทะเบียนที่กำหนดเองใด ๆ ที่กำหนดไว้ObjectMapperในการกำหนดค่า Spring ที่ใช้ Java

ใน Spring Boot 2.2.xคุณต้องกำหนดค่าดังนี้:

@Bean
public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
    return builder.build()
}

Kotlin:

@Bean
fun objectMapper(builder: Jackson2ObjectMapperBuilder) = builder.build()

เหนือ Spring 4 ไม่จำเป็นต้องกำหนดค่าMappingJacksonHttpMessageConverterหากคุณตั้งใจจะกำหนดค่าเท่านั้นObjectMapperเท่านั้น

(กำหนดค่า MappingJacksonHttpMessageConverterจะทำให้คุณสูญเสีย MessageConverter อื่น ๆ )

คุณต้องทำ:

public class MyObjectMapper extends ObjectMapper {

    private static final long serialVersionUID = 4219938065516862637L;

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

และในการกำหนดค่า Spring ของคุณให้สร้าง bean นี้:

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

ฉันใช้ Spring 3.2.4 และ Jackson FasterXML 2.1.1

ฉันได้สร้างJacksonObjectMapper แบบกำหนดเองที่ทำงานร่วมกับคำอธิบายประกอบที่ชัดเจนสำหรับแต่ละแอตทริบิวต์ของ Objects ที่แมป:

package com.test;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

public class MyJaxbJacksonObjectMapper extends ObjectMapper {

public MyJaxbJacksonObjectMapper() {

    this.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
            .setVisibility(PropertyAccessor.CREATOR, JsonAutoDetect.Visibility.ANY)
            .setVisibility(PropertyAccessor.SETTER, JsonAutoDetect.Visibility.NONE)
            .setVisibility(PropertyAccessor.GETTER, JsonAutoDetect.Visibility.NONE)
            .setVisibility(PropertyAccessor.IS_GETTER, JsonAutoDetect.Visibility.NONE);

    this.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
    }
}

จากนั้นจะสร้างอินสแตนซ์ในคอนฟิกูเรชันบริบท ( servlet-context.xml ):

<mvc:annotation-driven>
    <mvc:message-converters>

        <beans:bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <beans:property name="objectMapper">
                <beans:bean class="com.test.MyJaxbJacksonObjectMapper" />
            </beans:property>
        </beans:bean>

    </mvc:message-converters>
</mvc:annotation-driven>

ใช้งานได้ดี!