Просмотр исходного текста страницы Объектная модель XML-парсера

[[Встраиваемые_plugin-модули|Наверх]]

__TOC__

==Объектная модель==

Для удобства работы со строковыми XML параметрами разработчику изначально доступны исходные коды классов для преобразования строки установленного формата в структуру объектов, для которых доступны методы преобразования из строки и приведения к строке. 

Очевидно, что каждый разработчик может самостоятельно осуществить преобразование. Наверняка существуют другие объектные модели для работы и аналогичных преобразований. Использование приведенной не является обязательным, ее исходные коды даются только лишь с целью возможного ускорения времени.


Объектная модель представлена тремя видами объектов-данных (по аналогии с используемым форматом структуры XML) и вспомогательного класса для преобразований.

*Объект класса <span style="color:darkred">CMapperXmlItem</span> представляет собой набор данных, описывающих одно свойство (соответствует элементам XML-структуры <span style="color:green">property_simple</span> или <span style="color:green">property_cdata</span>) и содержит поля <span style="color:green">Key</span>, <span style="color:green">Value</span>, <span style="color:green">Name</span>, которые отражают значения соответствующих атрибутов у элементов с тэгами <span style="color:green"><property_...></span>. Значение поля CDATA элемента <span style="color:green">property_cdata</span> также попадает в поле <span style="color:green">Name</span> объекта. С точки зрения объектной модели при разборе строки XML не делается различий между <span style="color:green">property_simple</span> и <span style="color:green">property_cdata</span>. Однако у объекта есть дополнительное поле <span style="color:green">Type</span>, которое определяет тип преобразования из объектной модели в строку с XML структурой. Тип CDATA рекомендуется к использованию для свойств, имеющих большой или неизвестный заранее объем или формат текстовых данных. При работе с объектами для формирования строки можно самостоятельно устанавливать подходящий для конкретного случая тип свойства. А можно пользоваться уже встроенным статическим методом класса <span style="color:darkred">GetItem</span> для автоматического определения типа по данным. При разборе значений можно пользоваться статическими методами класса <span style="color:darkred">GetValueName</span> (возвращает значение поля Value, а если оно пусто, то Name) и <span style="color:darkred">GetNameValue</span> (наоборот).

*Объект класса <span style="color:darkred">CMapperXmlItemSet</span> представляет собой набор свойств (соответствует элементу <span style="color:green">property_set</span>), перечисленных в порядке следования безразлично к уникальности ключей. Объект класса имеет также поля <span style="color:green">Id</span> и <span style="color:green">IdName</span>, которые соответствуют атрибутам <span style="color:green">id</span> и <span style="color:green">name</span> элемента XML-структуры <span style="color:green">property_set</span>. Дополнительно объект имеет поле <span style="color:green">Subsets</span> - коллекция (объект класса <span style="color:darkred">CMapperXmlItemSetCollection</span>), содержащая набор вложенных объектов <span style="color:darkred">CMapperXmlItemSet</span>.

*Объект класса <span style="color:darkred">CMapperXmlItemSetCollection</span> (соответствует элементу <span style="color:green">property_collection</span>) представляет собой набор объектов <span style="color:darkred">CMapperXmlItemSet</span>, перечисленных в порядке следования безразлично к другим способам идентификации. Объект имеет поле <span style="color:green">IdName</span>, соответствующее атрибуту <span style="color:green">name</span>. Атрибут <span style="color:green">count</span> в соответствующем элементе структуры XML отражает количество вложенных вложенных объектов <span style="color:darkred">CMapperXmlItemSet</span>.

*Класс <span style="color:darkred">СMapperXmlTransformer</span> имеет только статические методы для преобразований из объектов в строку и наоборот.

*При парсинге значений из строки в объектную модель в случае, если какой-либо атрибут в тэге не задан, в соответствующее поле объекта попадает пустое значение <span style="color:blue">null</span>.
 

Исходный код классов приведен в файле Xml.cs демонстрационной plugin-программы. Далее в этом разделе будет разъяснено на примере как производить работу с классами для создания строки с XML-структурой требуемого образца, а также обратной операции разбора параметров XML.


==Формирование XML-строки требуемого образца==

Рассмотрим на примере, как организовать код на C# для работы с объектной моделью. Решается задача формирования XML строки, имеющей следующий вид:

 <?xml version="1.0" encoding="utf-16"?>
 <oktellxmlmapper version="80710">
 <data name="input" count="2">
   <property_set>
     <property_simple key="paramkey" value="arbitraryarg" />
     <property_simple key="paramtype" value="4" name="argument" />
     <property_cdata key="paramname"><![CDATA[Имя оператора]]></property_cdata>
     <property_cdata key="paramdescription"><![CDATA[Подставляется в зачитываемый текст]]></property_cdata>
   </property_set>
   <property_set>
     <property_simple key="paramkey" value="categories" />
     <property_simple key="paramtype" value="7" name="fixedlist" />
     <property_cdata key="paramname"><![CDATA[Категории]]></property_cdata>
     <property_cdata key="paramdescription"><![CDATA[Выбор рабочего пространства]]></property_cdata>
     <property_collection name="categories" count="2">
       <property_set name="category" id="0">
         <property_simple key="id" value="0" />
         <property_cdata key="name"><![CDATA[Товары]]></property_cdata>
       </property_set>
       <property_set name="category" id="1">
         <property_simple key="id" value="1" />
         <property_cdata key="name"><![CDATA[Услуги]]></property_cdata>
       </property_set>
     </property_collection>
   </property_set>
 </data>
 </oktellxmlmapper> 

В XML структуре на первом уровне находятся 2 элемента <span style="color:green">property_set</span>, не имеющие атрибутов, а имеющие только свойства (<span style="color:green">property_simple</span> и <span style="color:green">property_cdata</span>), второй элемент содержит коллекцию из двух субэлементов. У этих субэлементов присутствуют атрибуты имени и идентификатора.


<u>Организация кода с использованием описанной объектной модели производится следующим образом:</u> 

 <span style="color:green">//Создание главной коллекции, преобразование которой в XML будет производиться</span>
 CMapperXmlItemSetCollection coll = new CMapperXmlItemSetCollection ();
 
 <span style="color:green">//Объявление переменных</span>
 CMapperXmlItemSet iset = null;
 CMapperXmlItemSet isubset = null;
  
 <span style="color:green">//Первый элемент коллекции (набор)</span>
 <span style="color:green">//  Подробный комментарий</span>
  
 <span style="color:green">//Создание объекта</span>
 iset = new CMapperXmlItemSet ( );
 <span style="color:green">//Добавление в необходимую коллекцию (в данном случае в основную)</span>
 coll.Add ( iset );
  
 <span style="color:green">//Формирование свойств элемента-набора</span>
 <span style="color:green">//  Происходит с помощью автоматического определения типа (simple/cdata)</span>
  
 <span style="color:green">//<property_simple key="paramkey" value="arbitraryarg"/></span>
 iset.Add ( CMapperXmlItem.GetItem ( "paramkey", "arbitraryarg" ) );
 <span style="color:green">//<property_simple key="paramtype" value="4" name="argument"/></span>
 iset.Add ( CMapperXmlItem.GetItem ( "paramtype", 4, "argument" ) );
 <span style="color:green">//<property_simple key="paramname"><![CDATA[Имя оператора]]></property_cdata></span>
 iset.Add ( CMapperXmlItem.GetItem ( "paramname", "Имя оператора" ) );
 <span style="color:green">//<property_simple key="paramdescription"><![CDATA[Подставляется в зачитываемый текст]]></property_cdata></span>
 iset.Add ( CMapperXmlItem.GetItem ( "paramdescription", "Подставляется в зачитываемый текст" ) );
  
 <span style="color:green">//Второй элемент коллекции (набор)</span>
 iset = new CMapperXmlItemSet ( );
 coll.Add ( iset );
 iset.Add ( CMapperXmlItem.GetItem ( "paramkey", "categories" ) );
 iset.Add ( CMapperXmlItem.GetItem ( "paramtype", 7, "fixedlist" ) );
 iset.Add ( CMapperXmlItem.GetItem ( "paramname", "Категории" ) );
 iset.Add ( CMapperXmlItem.GetItem ( "paramdescription", "Выбор рабочего пространства" ) );
 
 <span style="color:green">//У второго элемента есть вложенные</span>
 <span style="color:green">//  Происходит формирование коллекции вложенных элементов</span>
 
 <span style="color:green">//Задание свойства name вложенной коллекции</span>
 iset.SubSets.Name = "categories";
 
 <span style="color:green">//Первый подэлемент</span>
 isubset = new CMapperXmlItemSet ( );
 iset.SubSets.Add ( isubset );
 isubset.Name = "category";
 isubset.IdName = "0";                        
 isubset.Add ( CMapperXmlItem.GetItem ( "id", "0" ) );
 isubset.Add ( CMapperXmlItem.GetItem ( "name", "Товары" ) );  
 
 <span style="color:green">//Второй подэлемент</span>
 isubset = new CMapperXmlItemSet ( );
 iset.SubSets.Add ( isubset );
 isubset.Name = "category";
 isubset.IdName = "1";                        
 isubset.Add ( CMapperXmlItem.GetItem ( "id", "1" ) );
 isubset.Add ( CMapperXmlItem.GetItem ( "name", "Услуги" ) );
 
 <span style="color:green">//Преобразование коллекции (объекта) к XML-строке</span>
 return coll.WriteToXml ( "input" );


==Парсинг XML-строки==

Рассмотрим на примере, как организовать код на C# для работы с объектной моделью. Решается задача выделения нужных параметров из простейшей XML-строки установленного образца, имеющей следующий вид:

 <?xml version="1.0" encoding="utf-16"?>
 <oktellxmlmapper version="80710">
 <data name="action" count="1">
   <property_set id="20101" name="tabchange">
     <property_simple key="idplugin" value="12341234-abcd-abcd-abcd-abcdabcdabcd" />
     <property_simple key="idform" value="f031ea44-7299-a173-4b1b-238fe1200c3" />
     <property_simple key="idshow" value="2e2d8ff0-de47-415f-ab68-9bddcd09952b" />
     <property_simple key="actiontype" value="20101" name="TabChange" />
     <property_simple key="activeindex" value="6" />
   </property_set>
 </data>
 </oktellxmlmapper>


Это строковый параметр, передаваемый в метод <span style="color:darkred">DoQuery</span> для обработки события клиентского приложения о факте смены вкладки в заголовке модуля. Метод <span style="color:darkred">DoQuery</span> принадлежит управляющему объекту, поэтому он должен выделить параметры: Код формы и экземпляра (для того чтобы перенаправить команду в нужном направлении, так как открытых форм может быть много), а также тип события и его параметр (в данном случае тип - смена вкладки, а параметр - код вкладки).


Очевидно, что приведенный пример - частный случай и не может в чистом виде быть использован. Необходима полная обработка возможных вариантов (конкретнее можно посмотреть в демонстрационно примере plugin-программы).

Для простоты и конкретики здесь приведен отрезок кода, решающий исключительно задачу выделения нужных параметров в соответствующие переменные. Упростим демонстрационный код дополнительно тем, что исключим необходимый в методе <span style="color:darkred">DoQuery</span> полный анализ возможных команд приложения, а ограничимся только обработкой команды (события) о смене вкладки. 

 <span style="color:green">//Коллекция с запросом на основе XML-строки</span>
 CMapperXmlItemSetCollection coll = CMapperXmlItemSetCollection.FromXml ( xml );
 if ( coll == null )
 {
 <span style="color:green">//Если что-то не корректно - соответствующая обработка</span>
 }
 else
 {
 <span style="color:green">//Коллекция без ошибок была преобразована к объектной модели</span>
  
 <span style="color:green">//Цикл по всем наборам основной коллекции.</span>
 <span style="color:green">//  В зависимости от поставленной задачи: </span>
 <span style="color:green">//  - либо ищем необходимый блок </span>
 <span style="color:green">//       (тогда пропускаем все другие)</span>
 <span style="color:green">//  - либо обрабатывается/преобразуется вся структура </span>
 <span style="color:green">//       (тогда в теле цикла по мере разбора производим обработку)</span>
 <span style="color:green">//  В некоторых случаях необходимо готовить ответ на запрос. </span>
 <span style="color:green">//   Тогда объединяется процедура разбора и создания ответа (зависимо в едином теле цикла)</span>
 for ( int i1 = 0; i1 < coll.Count; i1++ )
 {
    CMapperXmlItemSet iset = coll [ i1 ];
  
    <span style="color:green">//Необходимо обеспечить стабильность кода проверками корректности при преобразованиях,</span>
    <span style="color:green">//  либо включить код в блок обработки исключений try..catch</span>
    <span style="color:green">//  Например, если в поле, где заявлен для указания GUID, содержится некорректная строка</span>
    try
    {
      <span style="color:green">//По имени набора определяется запрошенное действие</span>
      <span style="color:green">//  (атрибут name тега property_set)</span>
      switch ( iset.Name.ToLower() )
      {
        case "tabchange": <span style="color:green">//команда смены вкладки</span>
  
          <span style="color:green">//Объявляем переменные, которые необходимы для обработки события</span>
          Guid idplugin = Guid.Empty;
          Guid idform = Guid.Empty;
          Guid idshow = Guid.Empty;
          int index = -1;
  
          <span style="color:green">//Сначала в цикле обрабатываются все свойства поочередно</span>
          <span style="color:green">//  безотносительно типа (property_simple/property_cdata)</span>
          <span style="color:green">//  И только потом производится передача управления в метод обработки команды</span>
          for ( int i2 = 0; i2 < iset.Count; i2++ )
          {
            <span style="color:green">//Объект - свойство</span>
            CMapperXmlItem item = iset [ i2 ];
  
            <span style="color:green">//По значению атрибута key определяется что именно представляет из себя свойство</span>
            <span style="color:green">//  В теле блока switch идет разбор только известных команд. Остальные пропускаются.</span>
            switch ( item.Key.ToLower() )
            {
              case "idplugin": <span style="color:green">//свойство идентификатора plugin-программы</span>
                idplugin = new Guid ( CMapperXmlItem.GetValueName ( item ) );
              break;
  
              case "idform": <span style="color:green">//свойство идентификатора plugin-формы</span>
                idform = new Guid ( CMapperXmlItem.GetValueName ( item ) );
              break;
  
              case "idshow": <span style="color:green">//свойство идентификатора экземпляра plugin-формы</span>
                idshow = new Guid ( CMapperXmlItem.GetValueName ( item ) );
              break;
  
              case "activeindex": <span style="color:green">//идентификатор выбранной вкладки</span>
                index = int.Parse ( CMapperXmlItem.GetValueName ( item ) );
              break;
            }
          }
  
          <span style="color:green">//Проверка корректности задания параметров</span>
  
          <span style="color:green">//Элементарная проверка задания всех необходимых свойств</span>
          if (( index < 0 ) || ( idform == Guid.Empty ) || ( idshow == Guid.Empty ))
          {
             <span style="color:green">//Обработка ошибки и выход</span>
            break;
          }
  
          <span style="color:green">//При необходимости проверка корректности задания свойств </span>
          <span style="color:green">//  (наличие формы среди открытых, наличие указанной вкладки)</span>
  
          <span style="color:green">//Обработка команды смены вкладки.</span>
          <span style="color:green">//  Это внутренний вызов, может быть реализован любым способом.</span>
          ActionChangeTab ( idform, idshow, index );
  
        break;
      }
    }
    catch ( Exception ex )
    {
      <span style="color:green">//Исключение при обработке.</span>
    }
 }
 }