TOC

Сериализация и десериализация XML с Джексоном

Сериализация XML и десериализация с Джексоном

1. обзор

В этом руководстве мы рассмотримhow to serialize Java objects to XML data using Jackson 2.x and deserialize it back to a POJO.

Мы сосредоточимся на базовой операции, которая не требует особой сложности или настройки.

2. XmlMapper Объект

XmlMapper - это основной класс из Jackson 2.x, который помогает нам в сериализации, поэтому нам нужно создать его экземпляр: 

XmlMapper mapper = new XmlMapper();

Этотmapper  доступен в банкеjackson-dataformat-xml, поэтому мы должны добавить его как зависимость к нашемуpom.xml: 


    com.fasterxml.jackson.dataformat
    jackson-dataformat-xml
    2.9.8

Пожалуйста, проверьтеthe latest version of Jackson dependency здесь.

3. Сериализовать Java в XML

XmlMapper - это подклассObjectMapper, который используется в сериализации JSON. Тем не менее, он добавляет некоторые специфичные для XML настройки в родительский класс.

Теперь мы можем посмотреть, как использовать его для фактической сериализации. Давайте сначала создадим класс Java: 

class SimpleBean {
    private int x = 1;
    private int y = 2;

    //standard setters and getters
}

3.1. Сериализовать в XMLString

Мы можем сериализовать наш объект Java в XMLString: 

@Test
public void whenJavaSerializedToXmlStr_thenCorrect() throws JsonProcessingException {
    XmlMapper xmlMapper = new XmlMapper();
    String xml = xmlMapper.writeValueAsString(new SimpleBean());
    assertNotNull(xml);
}

В результате мы получим: 


    1
    2

3.2. Сериализовать в файл XML

Мы также можем сериализовать наш объект Java в файл XML: 

@Test
public void whenJavaSerializedToXmlFile_thenCorrect() throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    xmlMapper.writeValue(new File("simple_bean.xml"), new SimpleBean());
    File file = new File("simple_bean.xml");
    assertNotNull(file);
}

А ниже мы видим содержимое получившегося файла с именемsimple_bean.xml: 


    1
    2

4. Десериализовать XML в Java

В этом разделе мы рассмотрим, как получить объекты Java из XML.

4.1. Десериализация из XML-строки

Как и в случае с сериализацией, мы также можем десериализовать строку XML обратно в объект Java: 

@Test
public void whenJavaGotFromXmlStr_thenCorrect() throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    SimpleBean value
      = xmlMapper.readValue("12", SimpleBean.class);
    assertTrue(value.getX() == 1 && value.getY() == 2);
}

4.2. Десериализовать из файла XML

Аналогично, если у нас есть файл XML, мы можем преобразовать его обратно в объект Java.

Здесь мы сначала считываем файл во входной поток, а затем преобразуем входной поток вString с помощью простого служебного метода.

Остальная часть кода похожа на ту из раздела 4.1: 

@Test
public void whenJavaGotFromXmlFile_thenCorrect() throws IOException {
    File file = new File("simple_bean.xml");
    XmlMapper xmlMapper = new XmlMapper();
    String xml = inputStreamToString(new FileInputStream(file));
    SimpleBean value = xmlMapper.readValue(xml, SimpleBean.class);
    assertTrue(value.getX() == 1 && value.getY() == 2);
}

Утилита метод: 

public String inputStreamToString(InputStream is) throws IOException {
    StringBuilder sb = new StringBuilder();
    String line;
    BufferedReader br = new BufferedReader(new InputStreamReader(is));
    while ((line = br.readLine()) != null) {
        sb.append(line);
    }
    br.close();
    return sb.toString();
}

5. Обработка элементов с заглавной буквы

В этом разделе мы рассмотрим, как обрабатывать сценарии, в которых либо у нас есть XML с элементами с заглавной буквы для десериализации, либо нам нужно сериализовать объекты Java в XML с одним или несколькими элементами с заглавной буквы.

5.1. Десериализация из XMLString

Допустим, у нас есть XML с одним полем с заглавной буквы: 


    1
    2

Чтобы правильно обрабатывать элементы с заглавной буквы, нам нужно аннотировать поле «x» аннотацией@JsonProperty: 

class SimpleBeanForCapitalizedFields {
    @JsonProperty("X")
    private int x = 1;
    private int y = 2;

    // standard getters, setters
}

Теперь мы можем правильно десериализовать XMLString обратно в объект Java: 

@Test
public void whenJavaGotFromXmlStrWithCapitalElem_thenCorrect() throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    SimpleBeanForCapitalizedFields value
      = xmlMapper.readValue(
      "12",
      SimpleBeanForCapitalizedFields.class);
    assertTrue(value.getX() == 1 && value.getY() == 2);
}

5.2. Сериализовать в строку XML

Аннотируя обязательные поля с помощью@JsonProperty,, мы можем правильно сериализовать объект Java в XMLString с одним или несколькими элементами с заглавной буквы: 

@Test
public void whenJavaSerializedToXmlFileWithCapitalizedField_thenCorrect()
  throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    xmlMapper.writeValue(new File("target/simple_bean_capitalized.xml"),
      new SimpleBeanForCapitalizedFields());
    File file = new File("target/simple_bean_capitalized.xml");
    assertNotNull(file);
}

6. Serialize List to XMLс

XmlMapper может сериализовать весь Java bean-компонент в документ. Чтобы преобразовать объект Java в XML, мы рассмотрим простой пример с вложенным объектом и массивами.

Наша цель - сериализовать объектPerson вместе с его составным объектомAddress в XML.

Наш окончательный XML будет выглядеть примерно так: 


    Rohan
    Daye
    
        9911034731
        9911033478
    
    

        Name1
        City1
    

    

        Name2
        City2

Обратите внимание, что наши телефонные номера заключены в оболочкуphoneNumbers, а наш адрес - нет.

Мы можем выразить этот нюанс с помощью аннотации@JacksonXMLElementWrapper в нашем классеPerson: 

public final class Person {
    private String firstName;
    private String lastName;
    private List phoneNumbers = new ArrayList<>();
    @JacksonXmlElementWrapper(useWrapping = false)
    private List
 address = new ArrayList<>();

    //standard setters and getters
}

Фактически, мы можем изменить имя элемента оболочки с помощью@JacksonXmlElementWrapper(localName = ‘phoneNumbers').. Или, если мы не хотим обертывать наши элементы, мы можем отключить отображение с помощью@JacksonXmlElementWrapper(useWrapping = false).

А затем давайте определим наш стильAddress : 

public class Address {
    String streetName;
    String city;
    //standard setters and getters
}

Jackson takes care of the rest for us. Как и раньше, мы можем просто снова вызватьwriteValue: 

private static final String XML = "...";

@Test
public void whenJavaSerializedToXmlFile_thenSuccess() throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    Person person = testPerson(); // test data
    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
    xmlMapper.writeValue(byteArrayOutputStream, person);
    assertEquals(XML, byteArrayOutputStream.toString());
}

7. Десериализовать XML вList

Джексон может читать XML, который также содержит списки объектов.

Если мы возьмем тот же XML, что и раньше, методreadValue будет работать нормально: 

@Test
public void whenJavaDeserializedFromXmlFile_thenCorrect() throws IOException {
    XmlMapper xmlMapper = new XmlMapper();
    Person value = xmlMapper.readValue(XML, Person.class);
    assertEquals("City1", value.getAddress().get(0).getCity());
    assertEquals("City2", value.getAddress().get(1).getCity());
}

8. Заключение

В этой простой статье показано, как сериализовать простой POJO в XML и получить POJO из базовых данных XML.

Мы также рассмотрели, как сериализовать и десериализовать сложные bean-компоненты, содержащие коллекции.

Исходный код, прилагаемый к этой статье, доступен наGitHub.

Related