Класс XMLEncoder

public class XMLEncoder extends Encoder implements AutoCloseable

Класс XMLEncoder — это дополнительный альтернативный способ по отношению к ObjectOutputStream, который может использоваться для генерации текстового представления JavaBean так же, как ObjectOutputStream может использоваться для создания двоичного представления объектов Serializable. Например, следующий фрагмент может использоваться для создания текстового представления предоставленного JavaBean и всех его свойств:

       XMLEncoder e = new XMLEncoder(
                          new BufferedOutputStream(
                              new FileOutputStream("Test.xml")));
       e.writeObject(new JButton("Hello, world"));
       e.close();
 

Несмотря на сходство их API, класс XMLEncoder предназначен исключительно для архивирования графов JavaBean в виде текстовых представлений их публичных свойств. Как и файлы исходного кода Java, документы, написанные таким образом, обладают естественной устойчивостью к изменениям в реализациях вовлеченных классов. Класс ObjectOutputStream по-прежнему рекомендуется для межпроцессного взаимодействия и сериализации общего назначения.

Класс XMLEncoder предоставляет стандартное представление JavaBean, в котором они представлены как XML-документы, соответствующие версии 1.0 спецификации XML и кодировке UTF-8 набора символов Unicode/ISO 10646. XML-документы, созданные классом XMLEncoder, обладают следующими характеристиками:

• Переносимость и устойчивость к версиям: они не зависят от приватной реализации какого-либо класса и, таким образом, как и файлы исходного кода Java, могут обмениваться между средами, которые могут иметь различные версии некоторых классов, и между виртуальными машинами различных поставщиков.
• Структурная компактность: класс XMLEncoder использует алгоритм исключения избыточности, поэтому значения по умолчанию свойств Bean не записываются в поток.
• Устойчивость к ошибкам: неструктурные ошибки в файле, вызванные либо повреждением файла, либо изменениями API классов в архиве, остаются локализованными, так что читатель может сообщить об ошибке и продолжить загрузку тех частей документа, которые не были затронуты ошибкой.

Ниже приведен пример XML-архива, содержащего некоторые компоненты пользовательского интерфейса из набора инструментов swing:

 <?xml version="1.0" encoding="UTF-8"?>
 <java version="1.0" class="java.beans.XMLDecoder">
 <object class="javax.swing.JFrame">
   <void property="name">
     <string>frame1</string>
   </void>
   <void property="bounds">
     <object class="java.awt.Rectangle">
       <int>0</int>
       <int>0</int>
       <int>200</int>
       <int>200</int>
     </object>
   </void>
   <void property="contentPane">
     <void method="add">
       <object class="javax.swing.JButton">
         <void property="label">
           <string>Hello</string>
         </void>
       </object>
     </void>
   </void>
   <void property="visible">
     <boolean>true</boolean>
   </void>
 </object>
 </java>
 

Синтаксис XML использует следующие соглашения:

• Каждый элемент представляет собой вызов метода.
• Тег "object" обозначает выражение, значение которого используется в качестве аргумента для вложенного элемента.
• Тег "void" обозначает оператор, который будет выполнен, но результат которого не будет использован в качестве аргумента для вложенного метода.
• Элементы, содержащие элементы, используют эти элементы в качестве аргументов, если только у них нет тега "void".
• Имя метода обозначается атрибутом "method".
• Стандартные атрибуты XML "id" и "idref" используются для ссылки на предыдущие выражения — для обработки цикличности в графе объектов.
• Атрибут "class" используется для явного указания целевого объекта статического метода или конструктора; его значение — полностью квалифицированное имя класса.
• Элементы с тегом "void" выполняются с использованием внешнего контекста в качестве целевого объекта, если целевой объект не определен с помощью атрибута "class".
• Класс Java String обрабатывается специально и записывается как <string>Hello, world</string>, где символы строки преобразуются в байты с использованием кодировки UTF-8.

Хотя все графы объектов могут быть записаны с использованием только этих трёх тегов, следующие определения включены для более компактного выражения общих структур данных:

• Имя метода по умолчанию — "new".
• Ссылка на класс Java записывается в форме <class>javax.swing.JButton</class>.
• Экземпляры обертывающих классов для примитивных типов Java записываются с использованием имени примитивного типа в качестве тега. Например, экземпляр класса Integer может быть записан как <int>123</int>. Обратите внимание, что класс XMLEncoder использует пакет Java reflection, в котором преобразование между примитивными типами Java и их соответствующими "обертывающими классами" выполняется внутри. API самого класса XMLEncoder работает только с Object.
• В элементе, представляющем нуль-арный метод, имя которого начинается с "get", атрибут "method" заменяется атрибутом "property", значение которого получено путём удаления префикса "get" и приведения результата к нижнему регистру.
• В элементе, представляющем монадический метод, имя которого начинается с "set", атрибут "method" заменяется атрибутом "property", значение которого получено путём удаления префикса "set" и приведения результата к нижнему регистру.
• В элементе, представляющем метод с именем "get", принимающий один целочисленный аргумент, атрибут "method" заменяется атрибутом "index", значение которого равно значению первого аргумента.
• В элементе, представляющем метод с именем "set", принимающий два аргумента, первый из которых — целое число, атрибут "method" заменяется атрибутом "index", значение которого равно значению первого аргумента.
• Ссылка на массив записывается с помощью тега "array". Атрибуты "class" и "length" соответственно указывают подтип массива и его длину.

Дополнительную информацию можно найти на странице Использование XMLEncoder в статье The Swing Connection.