Класс 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" не задаёт цель.
• Класс String в Java обрабатывается особым образом и записывается как <string>Hello, world</string>, где символы строки преобразуются в байты с использованием кодировки UTF-8.

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

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

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