SpringBoot: Consume & Produce XML with a Custom Serializer + Deserializer

Question

I have a SpringBoot Service with:

Model

public class Payload {
    private final String id;

    public Payload(String id){
        this.id = id;
            


        

Answer 1

You need to register 2 converters:

1. org.springframework.http.converter.json.MappingJackson2HttpMessageConverter for JSON.
2. org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter for XML.

Because, Payload class fits JSON payload you need to add only JsonCreator and JsonProperty annotations to make it work:

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public class Payload {

    private final String id;

    @JsonCreator
    public Payload(@JsonProperty(value = "id") String id) {
        this.id = id;
    }

    public String getId() {
        return this.id;
    }
}

XML payload does not fit by default, so we need to implement custom serialiser:

import com.example.demo.model.Payload;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator;

import java.io.IOException;

public class PayloadXmlSerializer extends JsonSerializer<Payload> {

    @Override
    public void serialize(Payload value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        ToXmlGenerator toXmlGenerator = (ToXmlGenerator) gen;
        toXmlGenerator.writeStartObject();

        toXmlGenerator.writeObjectFieldStart("id");
        toXmlGenerator.setNextIsAttribute(true);
        toXmlGenerator.writeFieldName("value");
        toXmlGenerator.writeString(value.getId());
        toXmlGenerator.setNextIsAttribute(false);
        toXmlGenerator.writeEndObject();

        toXmlGenerator.writeEndObject();
    }
}

and deserialiser:

import com.example.demo.model.Payload;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonPointer;
import com.fasterxml.jackson.core.TreeNode;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.node.TextNode;

import java.io.IOException;

public class PayloadXmlDeserializer extends JsonDeserializer<Payload> {

    @Override
    public Payload deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        TreeNode root = p.readValueAsTree();
        TreeNode value = root.at(JsonPointer.compile("/id/value"));
        if (value.isMissingNode()) {
            return new Payload(null);
        }
        TextNode textNode = (TextNode)value;
        return new Payload(textNode.textValue());
    }
}

Finally, we need to register above HTTP converters and custom serialiser/deserialiser:

import com.example.demo.model.Payload;
import com.example.jackson.PayloadXmlDeserializer;
import com.example.jackson.PayloadXmlSerializer;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@EnableWebMvc
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        //JSON
        converters.add(new MappingJackson2HttpMessageConverter());

        // XML
        converters.add(new MappingJackson2XmlHttpMessageConverter(Jackson2ObjectMapperBuilder
                .xml()
                .modules(payloadModule())
                .build()));
    }

    public SimpleModule payloadModule() {
        SimpleModule module = new SimpleModule();
        module.addDeserializer(Payload.class, new PayloadXmlDeserializer());
        module.addSerializer(Payload.class, new PayloadXmlSerializer());

        return module;
    }
}

See also:

• Using Jackson to add XML attributes to manually-built node-tree
• 415 Unsupported MediaType for POST request in spring application
• Spring MVC