[JAVA] Désérialiser XML dans une collection avec spring-boot

Aperçu

Recevez du XML dans une requête HTTP avec spring-boot et désérialisez-le en objet Java.

Code source

pom.xml

pom.xml


    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
        </dependency>

Désérialiser

Les détails seront décrits plus loin, mais la manière d'écrire des annotations change selon que la partie correspondant à la collection Java en XML est directement sous la racine de XML.

Sinon directement sous la racine

Supposons que le XML suivant est envoyé. Il y a un élément répétitif sous list </ code>.

<sampleRoot>
	<list>
		<sampleElement>
			<id>1</id>
			<value>v1</value>
		</sampleElement>
		<sampleElement>
			<id>2</id>
			<value>v2</value>
		</sampleElement>
	</list>	
</sampleRoot>

Dans ce cas, préparez le cours suivant. Aucune annotation spéciale n'est requise.

@Data
public class SampleRoot1 {
  List<SampleElement> list;
}
@Data
public class SampleElement {
  String id;
  String value;
}
@RestController
public class SampleController {
  @PostMapping(value = "/hoge1")
  @RequestMapping(consumes = MediaType.TEXT_XML_VALUE)
  public String hoge1(@RequestBody SampleRoot1 s) {
    System.out.println("xml body " + s);
    return "ok";
  }

Le résultat de l'exécution ressemble à ce qui suit.

xml body SampleRoot1(list=[SampleElement(id=1, value=v1), SampleElement(id=2, value=v2)])

Directement sous la racine

Supposons que le XML suivant est envoyé. Il y a un élément répétitif directement sous la racine.

<sampleRoot>
	<sampleElement>
		<id>1</id>
		<value>v1</value>
	</sampleElement>
	<sampleElement>
		<id>2</id>
		<value>v2</value>
	</sampleElement>
</sampleRoot>

Dans ce cas, ajoutez `` @ JacksonXmlElementWrapper (useWrapping = false) '' à la collection comme indiqué ci-dessous.

package jp.co.rakuten.rmsapi.order.notice.reciever.controller;

import java.util.List;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;

import lombok.Data;

@Data
public class SampleRoot2 {
  @JacksonXmlElementWrapper(useWrapping = false)
  List<SampleElement> sampleElement;
}

Je ne pense pas que ce soit une explication précise car je n'ai pas lu correctement la documentation, mais il semble que useWrapping = false spécifie que cette propriété n'est entourée d'aucun élément.

Résultat de l'exécution.

xml body SampleRoot2(sampleElement=[SampleElement(id=1, value=v1), SampleElement(id=2, value=v2)])

S'il n'y a pas d'annotation, l'erreur suivante se produit. Sentir qu'essayer de mapper une instance de SampleElement </ code> à `` List '' lui-même a échoué.

Failed to resolve argument 0 of type 'jp.co.rakuten.rmsapi.order.notice.reciever.controller.SampleRoot2' 
org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Cannot construct instance of `jp.co.rakuten.rmsapi.order.notice.reciever.controller.SampleElement` (although at least one Creator exists): no String-argument constructor/factory method to deserialize from String value ('1'); nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot construct instance of `jp.co.rakuten.rmsapi.order.notice.reciever.controller.SampleElement` (although at least one Creator exists): no String-argument constructor/factory method to deserialize from String value ('1')
 at [Source: (PushbackInputStream); line: 3, column: 8](through reference chain: jp.co.rakuten.rmsapi.order.notice.reciever.controller.SampleRoot2["sampleElement"]->java.util.ArrayList[0])
	at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.readJavaType(AbstractJackson2HttpMessageConverter.java:241)
	at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.read(AbstractJackson2HttpMessageConverter.java:223)

En fonction de la structure de XML, il peut être nécessaire de spécifier @ JacksonXmlRootElement ou `` @ JacksonXmlProperty comme indiqué ci-dessous. De plus, il semble que cela dépende de la version de jackson, il semble donc que vous deviez le vérifier à chaque fois.

import java.util.List;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

import lombok.Data;

@Data
@JacksonXmlRootElement(localName = "SampleRoot")
public class SampleRoot2 {
  @JacksonXmlElementWrapper(useWrapping = false)
  @JacksonXmlProperty
  List<SampleElement> sampleElement;
}

Recommended Posts