Streaming JSON/ru: what changed
Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | - | ||
| 1 | + |  **Примечание:** Эта статья является перевод статьи с английского [[Streaming JSON]] от 2014-10-02, которая была переведена с помощью Google Translate с немецкого (оригинал). Понятно, что результат перевода может быть ужасным, вполне может требоваться ручная корректировка. **Убедительная просьба не использовать автоматический перевод без окончательной обработки** | |
| 2 | 2 | ||
| 3 | - | ||
| 3 | + | [[JSON]](JavaScript Object Notation) является текстовым, стандартизированным форматом данных. Как следует из названия, JSON документы являются правильным кодом JavaScript, где они могут быть непосредственно преобразованы в объекты JavaScript. Но сам по себе JSON может быть использован независимо от используемого языка программирования для обмена данными. | |
| 4 | 4 | ||
| 5 | - | ||
| 5 | + | В этом руководстве объясняется, как загрузить данные в формате JSON в программе Free Pascal для обработки. Оно также объясняет, как преобразовать данные FPC в формате JSON (например, чтобы отправить их на веб-сервер). | |
| 6 | 6 | ||
| 7 | 7 | ## Общие положения и условия | |
| 8 | 8 | ||
| 9 | - | ||
| 10 | - | ||
| 11 | - | ||
| 9 | + | Загрузка и хранение (маршалинг) FPC данных объекта осуществляется с помощью юнита "fpjsonrtti". Кроме того, может пригодиться класс Class в этом юните (см ниже). | |
| 12 | 10 | ||
| 13 | - | ||
| 11 | + | В связи с этим раздел USES должен содержать, по крайней мере, эти два юнита: | |
| 12 | + | ``` | |
| 14 | 13 | USES Classes, fpjsonrtti; | |
| 15 | 14 | ``` | |
| 16 | 15 | ||
| 17 | - | ||
| 18 | - | ||
| 19 | - | ||
| 20 | - | ||
| 21 | - | ||
| 16 | + | В настоящее время (май 2014 г.) есть некоторые отличия от потоковой системы Free Pascal с ??_предположительно_ JavaScript ??: | |
| 22 | 17 | ||
| 23 | - | ||
| 18 | + | * Данные в формате JSON чувствительны к регистру. Таким образом, свойства объектов Free Pascal, как свойства JSON должны быть написаны с правильным регистром. | |
| 19 | + | * Нет свойств, которые могут быть определены как DefineProperties. Нельзя сохранить ссылки на методы (обработчики событий).2 | |
| 20 | + | * [[TCollection]] и [[TStrings]] может быть использован в качестве замены массивов. | |
| 24 | 21 | ||
| 25 | - | ||
| 22 | + | Демо-версия программы предоставляется с исходным кодом Free Pascal Compiler (в папке /packages/fcl-json/examples). | |
| 26 | 23 | ||
| 27 | - | ||
| 24 | + | В качестве примера, мы приведём пример со следующими данными JSON: | |
| 25 | + | ``` | |
| 28 | 26 | { | |
| 29 | - | ||
| 30 | - | ||
| 31 | - | ||
| 32 | - | ||
| 33 | - | ||
| 27 | + | "id" : 123, // Integer | |
| 28 | + | "obj" : { "name": "Привет, мир!" }, // Object | |
| 29 | + | "coll" : [ { "name": "Объект 1" }, { "name": "Объект 2" } ], // два объекта TCollection | |
| 30 | + | "strings": [ "привет 1", "привет 2" ] // список строк | |
| 31 | + | } | |
| 34 | 32 | ``` | |
| 35 | 33 | ||
| 36 | - | ||
| 37 | - | ||
| 38 | - | ||
| 34 | + | Это может быть выполнено в Free Pascal с использованием констант следующим образом: | |
| 35 | + | ``` | |
| 39 | 36 | const JSON_TESTDATA = | |
| 40 | - | ||
| 41 | - | ||
| 42 | - | ||
| 43 | - | ||
| 44 | - | ||
| 45 | - | ||
| 37 | + | '{'+LineEnding+ | |
| 38 | + | ' "id": 123,'+LineEnding+ | |
| 39 | + | ' "obj": { "name": "Привет, Мир!" },'+LineEnding+ | |
| 40 | + | ' "coll": [ { "name": "Объект 1" }, { "name": "Объект 2" } ],'+LineEnding+ | |
| 41 | + | ' "strings": [ "привет 1", "привет 2" ]'+LineEnding+ | |
| 42 | + | '}'; | |
| 46 | 43 | ``` | |
| 47 | 44 | ||
| 48 | 45 | ## Структура данных | |
| 49 | 46 | ||
| 50 | - | ||
| 51 | - | ||
| 52 | - | ||
| 47 | + | В качестве базового класса для обслуживания данных существует класс [[TPersistent]] из юнита Classes, так как для них и всех подклассов должен быть создан [[Runtime Type Information \(RTTI\|Laufzeit-Typinformationen]]> "Runtime Type Information \(RTTI\)") (RTTI). Это совершенно необходимо для маршаллинга. Поскольку fpjsonrtti не интегрирован в систему маршаллинга, любого другого класса, должна быть указана опция компилятора **{$M+}** , для использования. | |
| 53 | 48 | ||
| 54 | - | ||
| 49 | + | Все объекты должны быть доступны как [[Property|property]] для чтения в разделе класса [[Published|published]]. В общем случае (переменная) должна быть доступна для чтения и записи непосредственно в поле данных. Если вы хотите, конечно, могут быть использованы методы getter и setter. | |
| 55 | 50 | ||
| 56 | - | ||
| 51 | + | Для структуры JSON результаты определении класса представлены ниже. | |
| 52 | + | ``` | |
| 57 | 53 | TYPE | |
| 58 | - | ||
| 59 | - | ||
| 60 | - | ||
| 61 | - | ||
| 62 | - | ||
| 63 | - | ||
| 64 | - | ||
| 65 | - | ||
| 66 | - | ||
| 67 | - | ||
| 68 | - | ||
| 69 | - | ||
| 70 | - | ||
| 71 | - | ||
| 72 | - | ||
| 73 | - | ||
| 74 | - | ||
| 75 | - | ||
| 76 | - | ||
| 77 | - | ||
| 78 | - | ||
| 79 | - | ||
| 54 | + | TNameObject = CLASS(TCollectionItem) // класс для свойства 'obj' и TCollection | |
| 55 | + | PRIVATE | |
| 56 | + | fName: String; | |
| 57 | + | PUBLISHED | |
| 58 | + | property name: String read fName write fName; | |
| 59 | + | END; | |
| 60 | + | ||
| 61 | + | TBaseObject = CLASS(TPersistent) // класс для структуры JSON | |
| 62 | + | PRIVATE | |
| 63 | + | fid: Integer; | |
| 64 | + | fObj: TNameObject; | |
| 65 | + | fColl: TCollection; | |
| 66 | + | fStrings: TStrings; | |
| 67 | + | PUBLIC | |
| 68 | + | CONSTRUCTOR Create; | |
| 69 | + | DESTRUCTOR Destroy; override; | |
| 70 | + | PUBLISHED// все свойства должны быть published | |
| 71 | + | PROPERTY id: Integer read fid write fid; | |
| 72 | + | PROPERTY obj: TNameObject read fObj write fObj; | |
| 73 | + | PROPERTY coll: TCollection read fColl; | |
| 74 | + | PROPERTY strings: TStrings read fStrings; | |
| 75 | + | END; | |
| 80 | 76 | ``` | |
| 81 | 77 | ||
| 82 | - | ||
| 83 | - | ||
| 84 | - | ||
| 78 | + | Класс `TNameObject` является потомком [[TCollectionItem]]. Таким образом, они могут оба для свойства _obj_ использовать коллекции. Если это не желательно, здесь должны быть определены два различных класса. | |
| 85 | 79 | ||
| 86 | - | ||
| 80 | + | В конструкторе класса TBaseObject класс TCollection и список строк должен быть создан конструктором и уничтожен в деструкторе. | |
| 81 | + | ``` | |
| 87 | 82 | CONSTRUCTOR TBaseObject.Create; | |
| 88 | - | ||
| 89 | - | ||
| 90 | - | ||
| 91 | - | ||
| 92 | - | ||
| 93 | - | ||
| 94 | - | ||
| 95 | - | ||
| 96 | - | ||
| 97 | - | ||
| 98 | - | ||
| 99 | - | ||
| 100 | - | ||
| 101 | - | ||
| 102 | - | ||
| 83 | + | BEGIN | |
| 84 | + | // конструктор коллекции и StringList | |
| 85 | + | fColl := TCollection.Create(TNameObject); | |
| 86 | + | fStrings := TStringList.Create; | |
| 87 | + | fObj := TNameObject.Create(nil); | |
| 88 | + | END; | |
| 89 | + | ||
| 90 | + | DESTRUCTOR TBaseObject.Destroy; | |
| 91 | + | BEGIN | |
| 92 | + | // деструктор коллекции и StringList | |
| 93 | + | fColl.Free; | |
| 94 | + | fStrings.Free; | |
| 95 | + | fObj.Free; | |
| 96 | + | INHERITED Destroy; | |
| 97 | + | END; | |
| 103 | 98 | ``` | |
| 104 | 99 | ||
| 105 | - | ||
| 100 | + | Если вы не хотите больше функций для данных классов, их определение закончено. | |
| 106 | 101 | ||
| 107 | 102 | ## Загрузка JSON | |
| 108 | 103 | ||
| 109 | - | ||
| 110 | - | ||
| 111 | - | ||
| 104 | + | С помощью метода `Procedure JSONToObject(Const JSON : TJSONStringType; AObject : TObject);` в классе [[TJSONDeStreamer]] вы можете присвоить данные в формате JSON непосредственно _существующему_ объекту; перед тем, как вызвать этот метод, вы должны создать TJSONDeStreamer и целевой объект. | |
| 112 | 105 | ||
| 113 | - | ||
| 106 | + | Следующий метод загружает данные из структуры JSON `JSON_TESTDATA` в объект "о" и затем выводит текущие значения свойств в консоли. | |
| 107 | + | ``` | |
| 114 | 108 | PROCEDURE DeStreamTest; | |
| 115 | - | ||
| 116 | - | ||
| 117 | - | ||
| 118 | - | ||
| 119 | - | ||
| 120 | - | ||
| 121 | - | ||
| 122 | - | ||
| 123 | - | ||
| 124 | - | ||
| 125 | - | ||
| 126 | - | ||
| 127 | - | ||
| 128 | - | ||
| 129 | - | ||
| 130 | - | ||
| 131 | - | ||
| 132 | - | ||
| 133 | - | ||
| 134 | - | ||
| 135 | - | ||
| 136 | - | ||
| 137 | - | ||
| 138 | - | ||
| 139 | - | ||
| 140 | - | ||
| 141 | - | ||
| 142 | - | ||
| 143 | - | ||
| 144 | - | ||
| 145 | - | ||
| 146 | - | ||
| 109 | + | VAR | |
| 110 | + | DeStreamer: TJSONDeStreamer; | |
| 111 | + | o: TBaseObject; | |
| 112 | + | no: TNameObject; | |
| 113 | + | s: String; | |
| 114 | + | BEGIN | |
| 115 | + | WriteLn('тест DeStream'); | |
| 116 | + | WriteLn('======================================'); | |
| 117 | + | ||
| 118 | + | // объект DeStreamer и целевой объект | |
| 119 | + | DeStreamer := TJSONDeStreamer.Create(nil); | |
| 120 | + | o := TBaseObject.Create; | |
| 121 | + | TRY | |
| 122 | + | // загрузка данных JSON в объект o | |
| 123 | + | DeStreamer.JSONToObject(JSON_TESTDATA, o); | |
| 124 | + | // ID | |
| 125 | + | WriteLn(o.id); | |
| 126 | + | // имя объекта | |
| 127 | + | WriteLn(o.obj.name); | |
| 128 | + | // напечатать имена всех объектов | |
| 129 | + | for TCollectionItem(no) in o.coll do | |
| 130 | + | Writeln(no.name); | |
| 131 | + | // вывести все строки | |
| 132 | + | for s in o.strings do | |
| 133 | + | WriteLn(s); | |
| 134 | + | ||
| 135 | + | // очистка | |
| 136 | + | FINALLY | |
| 137 | + | o.Destroy; | |
| 138 | + | DeStreamer.Destroy; | |
| 139 | + | END; | |
| 140 | + | END; | |
| 147 | 141 | ``` | |
| 148 | 142 | ||
| 149 | 143 | ## Сохранение JSON | |
| 150 | 144 | ||
| 151 | - | ||
| 152 | - | ||
| 153 | - | ||
| 145 | + | Для преобразования объекта в текст JSON, используется класс [[TJSONStreamer]]. Здесь используется метод `FUNCTION ObjectToJSONString(AObject : TObject) : TJSONStringType;`. | |
| 154 | 146 | ||
| 155 | - | ||
| 147 | + | В следующей процедуре, объект создается, заполняется данными теста, а затем преобразуются в формат JSON. Порядок, в котором сохраняются свойства не могут зависеть от программиста. | |
| 156 | 148 | ||
| 157 | - | ||
| 149 | + | И, наконец, текст JSON выводится на консоль. | |
| 150 | + | ``` | |
| 158 | 151 | PROCEDURE StreamTest; | |
| 159 | - | ||
| 160 | - | ||
| 161 | - | ||
| 162 | - | ||
| 163 | - | ||
| 164 | - | ||
| 165 | - | ||
| 166 | - | ||
| 167 | - | ||
| 168 | - | ||
| 169 | - | ||
| 170 | - | ||
| 171 | - | ||
| 172 | - | ||
| 173 | - | ||
| 174 | - | ||
| 175 | - | ||
| 176 | - | ||
| 177 | - | ||
| 178 | - | ||
| 179 | - | ||
| 180 | - | ||
| 181 | - | ||
| 182 | - | ||
| 183 | - | ||
| 184 | - | ||
| 185 | - | ||
| 186 | - | ||
| 187 | - | ||
| 188 | - | ||
| 152 | + | VAR | |
| 153 | + | Streamer: TJSONStreamer; | |
| 154 | + | o: TBaseObject; | |
| 155 | + | JSONString: String; | |
| 156 | + | BEGIN | |
| 157 | + | WriteLn('Stream test'); | |
| 158 | + | WriteLn('======================================'); | |
| 159 | + | ||
| 160 | + | Streamer := TJSONStreamer.Create(nil); | |
| 161 | + | o := TBaseObject.Create; | |
| 162 | + | TRY | |
| 163 | + | // установка данных | |
| 164 | + | o.id := 123; | |
| 165 | + | o.obj.name := 'Привет, мир!'; | |
| 166 | + | TNameObject(o.coll.Add).name := 'Объект 1'; | |
| 167 | + | TNameObject(o.coll.Add).name := 'Объект 2'; | |
| 168 | + | o.strings.Add('Привет 1'); | |
| 169 | + | o.strings.Add('Привет 2'); | |
| 170 | + | ||
| 171 | + | Streamer.Options := Streamer.Options + [jsoTStringsAsArray]; // сохранение строки в JSON | |
| 172 | + | // конвертация вывод и JSON | |
| 173 | + | JSONString := Streamer.ObjectToJSONString(o); | |
| 174 | + | WriteLn(JSONString); | |
| 175 | + | ||
| 176 | + | // очистка | |
| 177 | + | FINALLY | |
| 178 | + | o.Destroy; | |
| 179 | + | Streamer.Destroy; | |
| 180 | + | END; | |
| 181 | + | END; | |
| 189 | 182 | ``` | |
| 190 | 183 | ||
| 191 | 184 | ## Вывод | |
| 192 | 185 | ||
| 193 | - | ||
| 186 | + | С помощью представленного знания, простые и сложные структуры данных JSON могут быть загружены в ваши программы на Free Pascal. Если необходима какая-либо пред- или постобработка данных JSON, текстовые данные могут быть изначально загружены в структуру данных в формате JSON (классом [[TJSONParser]] из юнита [[jsonparser]]), а затем можно обрабатывать с помощью юнита [[fpJSON]]. | |
| 194 | 187 | ||
| 195 | - | ||
| 188 | + | Опции свойства TJSONStreamer могут быть использованы для управления представлением ваших собственных структур данных в формате JSON. | |
| 196 | 189 | ||
| 197 | 190 | ## Смотрите также | |
| 198 | 191 | ||
| 199 | - | ||
| 200 | - | ||
| 201 | - | ||
| 192 | + | * [[JSON/ru|JSON]] | |
| 193 | + | * [[fcl-json/ru|fcl-json]] | |
| 194 | + | * [[Streaming components]] | |
| 202 | 195 | ||
| 203 | 196 | ## Примечания & Ссылки | |
| 204 | 197 | ||
| 205 | - | ||
| 198 | + | 1. <http://lists.freepascal.org/fpc-pascal/2013-January/036254.html> | |
| 206 | 199 | ||
| 207 | - | ||
| 200 | + | 2. <http://lists.lazarus.freepascal.org/pipermail/lazarus/2011-January/058878.html> | |
| 208 | 201 | ||
| 202 | + | *[RTTI]: Runtime Type Information | |
| 203 | + | ||
| 209 | 204 | --- | |
| 210 | - | ||
| 205 | + | *From the Free Pascal wiki, page "Streaming JSON/ru", as the Internet Archive kept it on 2025-08-27, last changed on 2024-07-27. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |
