Работа с форматами XML и JSON в FastScript

В настоящее время форматы XML и JSON стали основными стандартами для хранения данных и обмена информацией между компьютерными системами. По просьбам пользователей в FastScript добавлены классы для работы с XML и JSON. В этой статье мы подробнее рассмотрим, как работать с этими классами, какие в них есть свойства и методы, а также построим отчеты из кода со скриптами.

Формат XML

Для работы с XML в скриптах применяются 2 класса. Данные классы ориентированы на максимальное быстродействие и малое потребление памяти.

TfrXMLDocument – класс, инкапсулирующий функциональность документа XML. В нём доступны следующие свойства и методы.

TfrXMLNode – класс, который инкапсулирует в себе свойства узла XML документа.

Создать объект данного типа напрямую нельзя. Он создается путем вызова метода Add() у элемента, к которому необходимо добавить дочерний элемент. Рассмотрим подробнее свойства и методы класса TfrXMLNode.

Давайте попробуем построить отчет с использованием классов для работы с XML. Для примера отобразим в отчете данные из файла «country.xml», но при этом не будем пользоваться TClientDataSet, а воспользуемся прямым доступом к файлу XML. Создаём новый отчет, переходим в режим редактирования, кладём на отчет MasterData. А сверху добавляем несколько Memo для отображения данных. Также создадим событие OnBeforePrint у объекта MasterData.

Итоговый код скрипта отчета будет выглядеть так:

var doc: TfrXMLDocument;
 item: TfrXMLItem;
 IIndex: Integer;
 
procedure MasterData1OnBeforePrint(Sender: TfrxComponent);
var cur: TfrXMLItem;
 S: string;
begin
 cur := item[IIndex];
 mmNum.Text := cur.Prop['Code'];
 mmName.Text := cur.Prop['Name'];
 mmCapital.Text := cur.Prop['Capital'];
 mmArea.Text := cur.Prop['Area'];
 mmPopulation.Text := cur.Prop['Population'];
 mmContinent.Text := cur.Prop['Continent'];
 Inc(IIndex);
end;
 
begin
 Doc := TfrXMLDocument.Create;
 Doc.LoadFromFile('..\..\Data\country.xml');
 item := Doc.Root[1];
 IIndex := 0;
 MasterData1.RowCount := item.count;
end.

Запустим отчет на выполнение. Для удобства восприятия мы также добавили заголовки столбцов.

Формат JSON

Из формата XML плавно перейдём в JSON. Для работы с ним в FastReport также применяются 2 класса – это TfrJSON и TfrJSONArray. В данном случае эти классы просто обертка вокруг классов из System.JSON в Delphi платформе или аналогичных классов в Lazarus.

TfrJSONObject – класс, который инкапсулирует в себе функции для работы с объектами JSON. 

Свойства ниже позволяют получить в том или ином виде значения объекта JSON. Во всех этих свойствах индексирование осуществляется либо по номеру свойства в списке свойств, либо по его имени. Отметим, что AsString[‘1’] <> AsString[1]. Также, если значение свойства попробовать получить неподходящим методом, то могут возникать ошибки и возвращаться неверные значения свойств. Например, если свойство имеет тип «Объект» или «Массив», то при попытке получить его значение при помощи свойства AsString - вам вернется пустая строка. В остальных случаях AsString вернет строковое представление значения свойства.

Чтобы вернуть поле типа null вам придётся немного постараться. Вообще такого метода нет. Однако можно воспользоваться свойством ValueType, которое для поля типа null вернет jsNull, либо воспользоваться свойством AsString, которое вернет строку ‘null’.

Рассмотрим подробнее методы для манипуляций со свойствами объекта.

Методы возвращают целое число, которое является индексом добавленного элемента в списке всех полей.

Все методы, добавляющие поля в объект, не контролируют наличие существующих полей с такими же именами. Данная процедура возложена на программиста, использующего данный класс. Такой контроль необходим, чтобы в выходном JSON не появлялись несколько полей с одинаковыми именами. Поведение системы в таком случае не определено – это зависит от парсера, который далее будет разбирать полученный JSON. Это значит, что в работе может оказаться любое из значений с одинаковыми именами! 

Класс TJSONArray инкапсулирует в себе методы и свойства для работы с массивами JSON. В принципе, основные свойства те же, однако обращаться к ним можно только лишь по индексу. Поддерживаются только операции доступа к любому элементу, получение его значения, удаление любого элемента. Перемещать элементы по массиву, изменить их тип нельзя. Рассмотрим свойства и методы для получения значений элементов в этом классе.

Как и в объекте надо внимательно подходить к извлечению значений элементов массива. В зависимости от типа значения следует использовать соответствующий метод для его получения.

Ниже описаны методы для манипуляции элементами JSON массива.

Все эти методы возвращают позицию элемента, добавленного в массив. В середину массива вставить элемент нельзя – это ограничение базовых классов в System.JSON.

Особенности использования классов для доступа JSON

При использовании объектов следует учесть, что после использования объектов-оберток все их необходимо удалять из кода. 

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

Также следует учесть, что имена свойств объектов чувствительны к регистру, т.е. «Item1» и «item1» — это разные имена!

Можно задавать значения элементам объектов, только если тип этих значений соответствует типу, который задан у элемента. Если вам надо переопределить тип элемента, то удалите его и добавьте новый с таким же именем и нужным вам типом. Ввод новых значений у элементов массивов невозможно. Необходимо удалить массив JSON и потом создать его заново с нужными вам значениями.

Давайте воспользуемся классами из описания выше, и напишем скрипт, который извлекает данные (без информации о типах) из XML файла и помещает их в объект JSON.

procedure XMLToJSON;
var XML: TfrXMLDocument;
 xi, xi1: TfrXMLItem;
 I, J: Integer;
 JO: TfrJSONObject;
 JA, JA1: TfrJSONArray;
 SL: TStringList;
begin
 XML:=TfrXMLDocument.Create;
 XML.LoadFromFile('.\..\..\data\country.xml'); 
 JO:=TfrJSONObject.Create('{}');
 JO.AddArray('data');
 JA:=JO.AsArray['data'];
 xi:=X.Root[1];
 xi1:=xi.Items[0];
 SL:=TStringList.Create;
 xi1.GetParamNames(SL);
 for I:=0 to xi.Count - 1 do begin
 xi1:=xi.Items[I];
 JA1:=JA.AsArray[JA.AddArray];
 for J:=0 to SL.Count-1 do 
 JA1.AddString(xi1.Prop[SL[J]]);
 JA1.Free;
 end;
 JA.Free;
 JO.SaveToFile('.\..\..\data\country.json');
 JO.Free;
 SL.Free; 
end; 

И попробуем на основании полученных данных построить отчет (предварительно положите на страницу отчета соответствующие компоненты MasterData и Memo):

var J:TfrJSONObject;
 A:TfrJSONArray;
 curr:Integer;
 
procedure MasterData1OnBeforePrint(Sender: TfrxComponent);
var A1:TfrJSONArray;
begin
 A1:=A.AsArray(curr);
 Memo1.Memo.Text:=A1.AsString[0];
 Memo2.Memo.Text:=A1.AsString[1];
 Memo3.Memo.Text:=A1.AsString[2];
 Memo4.Memo.Text:=A1.AsString[3];
 Memo5.Memo.Text:=A1.AsString[4];
 Memo6.Memo.Text:=A1.AsString[5];
 A1.Free;
 curr := curr + 1;
end;
 
begin
 J:=TfrJSONObject.Create('');
 J.LoadFromFile('.\..\..\data\country.json');
 A:=J.AsArray[0];
 MasterData1.RowCount:=A.Count;
 curr:=0;
end.

Вы также можете использовать эти объекты и в коде Delphi – достаточно подключить модули frXML и frJSON в операторе uses. 

Заключение

В данной статье мы изучили применение классов для работы с JSON и XML в FastReport. Если вы занимаетесь разработкой, и не только отчетов, и в Delphi, и в Lazarus, то применение этих классов позволит уменьшить проблемы при переходе от одной среды к другой – в обоих IDE поведение будет одно и тоже. 

Для вашего удобства мы приложили к статье два примера, иллюстрирующие построение отчетов на основе XML и JSON. Их можно открыть запускать сразу в FastReportDemo, входящем в состав поставки FastReport. Возможно, перед запуском отчеты придется настроить – указать правильный путь к файлу данных «country.xml» - он находится как в составе DemoCenter, так и в папке с примерами. 

Скачать примеры