1. Обзор
В этом уроке мы рассмотрим как сериализовать объекты Java в XML-данные с помощью Jackson 2.x и десериализовать их обратно в POJO .
Мы сосредоточимся на базовой операции, которая не требует большой сложности или настройки.
2. Объект Xml-картографа
Xml Mapper – это основной класс из Jackson 2.x, который помогает нам в сериализации, поэтому нам нужно будет создать его экземпляр:
XmlMapper mapper = new XmlMapper();
Этот mapper доступен в jackson-dataformat-xml jar, поэтому мы должны добавить его в качестве зависимости к вашему pom.xml :
com.fasterxml.jackson.dataformat jackson-dataformat-xml 2.11.1
Пожалуйста, проверьте последнюю версию зависимости jackson-dataformat-xml в репозитории Maven.
3. Сериализация Java в XML
Xml Mapper является подклассом ObjectMapper , который используется в сериализации JSON. Тем не менее, он добавляет некоторые специфические настройки XML в родительский класс.
Теперь мы можем посмотреть, как использовать его для фактической сериализации. Давайте сначала создадим класс Java:
class SimpleBean {
private int x = 1;
private int y = 2;
//standard setters and getters
}3.1. Сериализация в строку XML
Мы можем сериализовать наш объект Java в XML String :
@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("1 2 4.2. Десериализация из XML-файла
Аналогично, если у нас есть XML-файл, мы можем преобразовать его обратно в объект Java.
Здесь мы сначала считываем файл во входной поток, а затем преобразуем входной поток в Строку с помощью простого служебного метода.
Остальная часть кода аналогична коду из раздела 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. Десериализация из строки XML
Допустим, у нас есть XML-файл с одним полем с заглавной буквы:
1 2
Чтобы правильно обрабатывать заглавные элементы, нам нужно аннотировать поле “x” аннотацией @JsonProperty :
class SimpleBeanForCapitalizedFields {
@JsonProperty("X")
private int x = 1;
private int y = 2;
// standard getters, setters
}Теперь мы можем правильно десериализовать XML строку обратно в объект Java:
@Test
public void whenJavaGotFromXmlStrWithCapitalElem_thenCorrect() throws IOException {
XmlMapper xmlMapper = new XmlMapper();
SimpleBeanForCapitalizedFields value
= xmlMapper.readValue(
"1 2 5.2. Сериализация в строку XML
Аннотируя обязательные поля с помощью @JsonProperty, мы можем правильно сериализовать объект Java в XML Строку с одним или несколькими заглавными элементами:
@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. Сериализация списка в XML
Xml-картограф способен сериализовать весь компонент Java в документ. Чтобы преобразовать объект Java в XML, мы возьмем простой пример с вложенным объектом и массивами.
Наше намерение состоит в том, чтобы сериализовать объект Person вместе с его составным объектом Address в XML.
Наш окончательный XML будет выглядеть примерно так:
Rohan Daye 9911034731 9911033478 Name1 City1 Name2 City2
Обратите внимание, что наши телефонные номера инкапсулированы в номера телефонов обертки пока нашего адреса нет.
Мы можем выразить этот нюанс с помощью аннотации @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). Или, если мы не хотим обертывать наши элементы, мы можем отключить сопоставление с помощью @JacksonXmlElementWrapper(useWrapping) .
А затем давайте определим наш Адрес тип:
public class Address {
String streetName;
String city;
//standard setters and getters
}Джексон позаботится об остальном за нас. Как и раньше, мы можем просто вызвать 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 в список
Джексон также может читать 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-данных.
Мы также рассмотрели, как сериализовать и десериализовать сложные компоненты, содержащие коллекции.
Исходный код, сопровождающий эту статью, доступен на GitHub .