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

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

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

Дополнительные сведения можно найти в статье Using XMLEncoder в The Swing Connection.