SpringBoot: использование и создание XML с помощью специального сериализатора + десериализатор - PullRequest
Новая
       69

SpringBoot: использование и создание XML с помощью специального сериализатора + десериализатор

1 голос
/ 01 октября 2019

У меня есть служба SpringBoot с:

Модель 

public class Payload {
    private final String id;

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

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

Контроллер 

@RestController
@RequestMapping("/payload")
public class PayloadController {

    @RequestMapping(method = RequestMethod.POST)
    public Payload post(@RequestBody final Payload payload) {
        return payload;
    }
}

Мне нужен этот контроллер, чтобы иметь возможность обрабатывать запросы JSON и XML иответить в том же формате. Это работает нормально, если я установил заголовки Content-Type и Accept на правильный тип носителя.

Однако мои полезные нагрузки XML должны быть слегка отличны от структуры моего JSON:

XML: 

<Payload>
    <id value="some-value"/>
</Payload>

JSON: 

{
    id: "some-value"
}

Как мне убедиться, что мой id обернут в узел xml и имеет "значение" в качестве атрибута?

Я пытался использовать аннотации @JsonSerialize и @JsonDeserialize на моем Payload класс, но как только я это делаю, я получаю следующую ошибку, когда POST ing XML 

{
    "timestamp": "2019-10-01T12:06:35.593+0000",
    "status": 415,
    "error": "Unsupported Media Type",
    "message": "Content type 'application/xml;charset=UTF-8' not supported",
    "path": "/payload"
}

1 Ответ

1 голос
/ 02 октября 2019

Вам необходимо зарегистрировать 2 конвертера:

  1. org.springframework.http.converter.json.MappingJackson2HttpMessageConverter для JSON.
  2. org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter для XML.

Поскольку класс Payload подходит для полезной нагрузки JSON, вам нужно добавить только аннотации JsonCreator и JsonProperty, чтобы она работала: 

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 полезная нагрузка не подходит по умолчанию, поэтому мынеобходимо реализовать пользовательский сериализатор: 

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();
    }
}

и десериализатор: 

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());
    }
}

Наконец, нам необходимо зарегистрировать HTTP преобразователей и пользовательский сериализатор / десериализатор: 

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;
    }
}

См. Также:

...