McJSON
1.0.0
Простой и маленький класс Delphi / Lazarus / C ++ простой и маленький класс для быстрого анализа JSON.
Некоторые интересные моменты:
McJSON ), только один класс ( TMcJsonItem ). uses
McJSON;
...
function Test99 (out Msg: string): Boolean;
var
Json: TMcJsonItem;
i: Integer;
begin
Msg := ' Test: Github readme.md content ' ;
Json := TMcJsonItem.Create();
try
try
// add some pairs.
Json.Add( ' key1 ' ).AsInteger := 1 ;
Json.Add( ' key2 ' ).AsBoolean := True;
Json.Add( ' key3 ' ).AsNumber := 1.234 ;
Json.Add( ' key4 ' ).AsString := ' value 1 ' ;
// add an array
Json.Add( ' array ' , jitArray);
for i := 1 to 3 do
Json[ ' array ' ].Add.AsInteger := i;
// save a backup to file
if (Json[ ' array ' ].Count = 3 ) then
Json.SaveToFile( ' test99.json ' );
// remove an item
Json.Delete( ' array ' );
// oops, load the backup
if (Json.Count = 4 ) then
Json.LoadFromFile( ' test99.json ' );
// test final result
Result := (Json.AsJSON = ' {"key1":1,"key2":true,"key3":1.234,"key4":"value 1","array":[1,2,3]} ' );
except
Result := False;
end ;
finally
Json.Free;
end ;
end ; Будет производить testtest99.json :
{
"key1" : 1 ,
"key2" : true ,
"key3" : 1.234 ,
"key4" : " value 1 " ,
"array" : [
1 ,
2 ,
3
]
}# include " McJson.hpp "
...
bool Test99 (AnsiString& Msg)
{
bool Result;
TMcJsonItem* Json = NULL ;
Msg = " Test: Github readme.md content " ;
Json = new TMcJsonItem ();
try
{
try
{ // add some pairs.
Json-> Add ( " key1 " )-> AsInteger = 1 ;
Json-> Add ( " key2 " )-> AsBoolean = true ;
Json-> Add ( " key3 " )-> AsNumber = 1.234 ;
Json-> Add ( " key4 " )-> AsString = " value 1 " ;
// add an array
Json-> Add ( " array " , jitArray);
for ( int i = 1 ; i <= 3 ; i++)
Json-> Values [ " array " ]-> Add ()-> AsInteger = i;
// save a backup to file
if (Json-> Values [ " array " ]-> Count == 3 )
Json-> SaveToFile ( " test99.json " );
// remove an item
Json-> Delete ( " array " );
// oops, load the backup
if (Json-> Count == 4 )
Json-> LoadFromFile ( " test99.json " );
// test final result
Result = (Json-> AsJSON ==
" { " key1 " :1, " key2 " :true, " key3 " :1.234, " key4 " : " value 1 " , " array " :[1,2,3]} " );
}
catch (...)
{
Result = false ;
}
}
__finally
{
if (Json) delete (Json);
}
return (Result);
} Пожалуйста, подумайте о прочтении модульных тестов в test папке для полного списка вариантов использования McJSON .
Просто используйте свойство AsJSON
var
N: TMcJsonItem;
begin
N := TMcJsonItem.Create;
N.AsJSON := ' {"i": 123, "f": 123.456, "s": "abc", "b": true, "n": null} ' ;
// use N here
N.Free;
end ; Если вы хотите проверить, действительна ли строка JSON:
Answer := N.Check( ' {"i":[123} ' ); // Answer will be false Метод Check не поднимет никакого исключения. Приведенный выше пример поймает и скрывает Error while parsing text: "expected , got }" at pos "10" Если вам нужно поймать и управлять исключениями, используйте CheckException like:
try
Answer := N.CheckException( ' {"k":1, "k":2} ' ); // Answer will be false
except
on E: Exception do
begin
// Error while parsing text: "duplicated key k" at pos "11"
end ;
end ; McJSON позволяет простой способ получить доступ к предметам через пути. Мы можем использовать '/', '' или '.' как сепараторы пути.
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
// access and change second object's value
N.Path( ' o.k2 ' ).AsString := ' value2 ' ;Результаты:
{
"o" : {
"k1" : " v1 " ,
"k2" : " value2 "
}
} Обратите внимание, что Path() еще не принимает индексы, например, это:
N.AsJSON := ' {"o": [{"k1":"v1"}, {"k2":"v2"}] ' ;
N.Path( ' o[1].k2 ' ).AsString := ' value2 ' ; Поскольку версия 1.0.4 McJSON позволяет использовать укорочники свойств, как в объектах данных JSON Andreas Hausladen.
// access (automatic creation as in JDO)
Obj.S[ ' foo ' ] := ' bar ' ;
Obj.S[ ' bar ' ] := ' foo ' ;
// array creation, Obj is the owner of 'array'
Obj.A[ ' array ' ].Add.AsInteger := 10 ;
Obj.A[ ' array ' ].Add.AsInteger := 20 ;
// object creation, 'array' is the owner of ChildObj
ChildObj := Obj[ ' array ' ].Add(jitObject);
ChildObj.D[ ' value ' ] := 12.3 ;
// array creation, ChildObj is the owner of 'subarray'
ChildObj.A[ ' subarray ' ].Add.AsInteger := 100 ;
ChildObj.A[ ' subarray ' ].Add.AsInteger := 200 ;Результаты:
{
"foo" : " bar " ,
"bar" : " foo " ,
"array" :[
10 ,
20 ,
{
"value" : 12.3 ,
"subarray" :[
100 ,
200
]
}
]
}Вот как получить доступ ко всем элементам (детям) объекта JSON и изменить их тип значения и контент.
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
// type and value: from string to integer
for i := 0 to N[ ' o ' ].Count- 1 do
N[ ' o ' ].Items[i].AsInteger := i+ 1 ; Результаты:
{
"o" : {
"k1" : 1 ,
"k2" : 2
}
} Мы можем использовать Items[index] и Values['key'] для доступа к элементам внутри объектов и массивов. Со времени версии 0.9.5 мы можем использовать At(index, 'key') или At('key', index) в качестве урегулирования.
N.AsJSON := ' {"a": [{"k1":1,"k2":2},{"k1":10,"k2":20}]} ' ;
// how to access k2 of second object.
i := N[ ' a ' ].Items[ 1 ].Values[ ' k2 ' ].AsInteger; // i will be equal to 20
i := N[ ' a ' ].Items[ 1 ][ ' k2 ' ].AsInteger; // uses the Values[] as default property
i := N[ ' a ' ].At( 1 , ' k2 ' ).AsInteger; // shortener: index, key
i := N.At( ' a ' , 1 )[ ' k2 ' ].AsInteger; // shortener: key, index И есть и другие использования без параметра key :
N.AsJSON := ' {"k1":1,"k2":2,"k3":3,"k4":4} ' ;
i := N.Items[ 2 ].AsInteger; // i will be equal to 3
i := N.At( 2 ).AsInteger; // shortener: just index
i := N.At( ' k3 ' ).AsInteger; // shortener: just keyИспользуя Delphi Enumerator, вы можете просматривать объект Item's Deals and Tagen.
var
N, item: TMcJsonItem;
begin
N := TMcJsonItem.Create;
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
for item in N[ ' o ' ] do
// use item here, e.g. item.Key, item.Value, item.AsStringИзмените все значения объекта с несколькими элементами. Не так распространено там.
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
N[ ' o ' ].AsString := ' str ' ;Результаты:
{
"o" : {
"k1" : " str " ,
"k2" : " str "
}
} И если необходимо изменить тип o :
N[ ' o ' ].ItemType := jitValue;
N[ ' o ' ].AsString := ' str ' ;Результаты:
{
"o" : " str "
}Преобразовать из массива в тип объекта и наоборот. Кроме того, не так распространено там.
N.AsJSON := ' { "k1": ["1", "2"], "k2": {"1": "a", "2": "b"} } ' ;
N[ ' k1 ' ].ItemType := jitObject; // convert array to object with items
N[ ' k2 ' ].ItemType := jitArray ; // convert object with items to array Результаты:
{
"k1" : {
"0" : " 1 " ,
"1" : " 2 "
},
"k2" : [
" a " ,
" b "
]
}Вставьте некоторые элементы, используя ключи и позицию.
P.Insert( ' c ' , 0 ).AsInteger := 3 ;
P.Insert( ' b ' , 0 ).AsInteger := 2 ;
P.Insert( ' a ' , 0 ).AsInteger := 1 ;Результаты:
{
"a" : 1 ,
"b" : 2 ,
"c" : 3
}Кроме того, можно вставить объекты в массивы.
Q.AsJSON := ' {"x":0} ' ;
P.ItemType := jitArray;
P.Insert(Q, 1 );Результаты:
[
1 ,
{
"x" : 0
},
2 ,
3
] Важно : так как версия 0.9.3, Add() и Insert() будет клонировать аргументы типа TMcJsonItem . Итак, мы должны освободить память для Q тоже:
P.Free;
Q.Free; Поскольку строки версии 1.0.5 можно избежать с помощью вспомогательной функции McJsonEscapeString() :
N.AsJSON := ' {"path": ' + McJsonEscapeString( ' dirsubdir ' ) + ' } ' ; Результаты:
{
"path" : " \ dir \ subdir "
} В версии 1.0.6 был представлен TJEscapeType enum, используемый в McJsonEscapeString() с этими уровнями выхода:
jetNormal : Escape #8 #9 #10 #12 #13 " .jetStrict : нормальный + / .jetUnicode : strict + uXXXX .jetNone : обратная совместимость. Эти уровни вдохновлены вспомогательной функцией Lazarus StringToJSONString() из библиотеки FPJSON.
Давайте посмотрим, как осмотреть всю внутреннюю структуру данных, типы и значения объекта TMcJsonItem .
// ---------------------------------------------------------------------------
void
TFormMain::Inspect (TMcJsonItem* AMcJItem, AnsiString Ident)
{
if (!AMcJItem) return ;
// log current
MyLog ( Ident + ItemToStr (AMcJItem) );
// log child
if ( AMcJItem-> HasChild )
{
Ident = " " + Ident;
for ( int i= 0 ; i < AMcJItem-> Count ; i++)
{ // use Value not Child because are note using Key[].
Inspect ( AMcJItem-> Items [i], Ident );
}
}
}
// ---------------------------------------------------------------------------
String
TFormMain::ItemToStr (TMcJsonItem* AMcJItem) const
{
String Ans = " " ;
if (AMcJItem)
Ans = AMcJItem-> GetTypeStr () +
" ; " + AMcJItem-> GetValueStr () +
" ; Key= " + AMcJItem-> Key +
" ; Value= " + AMcJItem-> Value +
" ; JSON= " + AMcJItem-> AsJSON ;
return (Ans);
}
// --------------------------------------------------------------------------- И используя пример, как testInspect.json :
{
"foo" : " bar " ,
"array" : [
100 ,
20
],
"arrayObj" : [
{
"key1" : 1.0
},
{
"key2" : 2.0
}
],
"Msg" : [
" #1 UTF8 example: motivação " ,
" #2 Scapes: btnfr\ uFFFF "\ "
]
} Calling Inspect() с объектом Json , загруженным с помощью testInspect.json :
TMcJsonItem* Json = new TMcJsonItem();
if (Json)
{
Json-> LoadFromFile ( " testInspect.json " );
Inspect (Json);
delete (Json);
}Результаты:
object; string; Key=; Value=; JSON={"foo":"bar","array":[100,20],"arrayObj":[{"key1":1.0},{"key2":2.0}],"Msg":["#1 UTF8 example: motivação","#2 Scapes: btnfru"\"]}
value; string; Key=foo; Value=bar; JSON="foo":"bar"
array; string; Key=array; Value=; JSON="array":[100,20]
value; number; Key=; Value=100; JSON=100
value; number; Key=; Value=20; JSON=20
array; string; Key=arrayObj; Value=; JSON="arrayObj":[{"key1":1.0},{"key2":2.0}]
object; string; Key=; Value=; JSON={"key1":1.0}
value; number; Key=key1; Value=1.0; JSON="key1":1.0
object; string; Key=; Value=; JSON={"key2":2.0}
value; number; Key=key2; Value=2.0; JSON="key2":2.0
array; string; Key=Msg; Value=; JSON="Msg":["#1 UTF8 example: motivação","#2 Scapes: btnfruFFFF"\"]
value; string; Key=; Value=#1 UTF8 example: motivação; JSON="#1 UTF8 example: motivação"
value; string; Key=; Value=#2 Scapes: btnfruFFFF"\; JSON="#2 Scapes: btnfruFFFF"\"
Со времени версии 0.9.0 , пустые ключи будут проанализированы и проверены с ошибками:
N.AsJSON := ' {"": "value"} ' ; И ToString() будет создавать действительный объект JSON:
{
"" : " value "
}Внутренне он будет использовать постоянную строку C_EMPTY_KEY в качестве содержания поля FKEY.
С момента версии 0.9.2 , строки с не сбежавшимися разрывами линии будут проанализированы с ошибками:
N.AsJSON := ' {"key": "value ' + # 13 + ' "} ' ;Поднимет исключение:
Error while parsing text: "line break" at pos "14"
McJSON может загружать из файлов ASCII и UTF-8 (с или без него). См. Метод LoadFromFile . Метод SaveToFile будет писать с использованием кодирования UTF-8. ПРИМЕЧАНИЕ . С момента версии 1.0.4 исходный код тестового проекта в Лазаре был преобразован в UTF-8, поэтому параметр asUTF8 был установлен на false .
Мир не идеален, и ни один я. Вот некоторые известные проблемы:
TMcJsonItem создаются в иерархической структуре с использованием списков fChild , существует проблема для создания полей, которые автоматически распространяются между элементами. Исследовательское решение пытается создать новый родительский класс TMcJson , который объекты будут похожи на корни и будут иметь объекты TMcJsonItem в качестве детей. Был проведен тест на производительность с оригинальными подразделениями myJSON , LkJson , JsonTools и uJSON . Вот краткое изложение тестов.
{... {"keyi":"valuei"}... }И о используемом компиляторе и машине:
Следующая таблица суммирует результаты 1 :
| Библиотека | Генерировать | Сохранять | Разбор | Нагрузка | Доступ | Общий |
|---|---|---|---|---|---|---|
McJSON 2 | .11 с | .07 с | .12 с | .09 с | .83 с | 1,25 с |
LkJson 2 | .30 с | .11 с | .47 с | .36 с | .01 с | 1,24 с |
JsonTools | 48,00 с | 0,70 с | 39,00 с | 40,00 с | .48 с | 1,2 мин |
myJSON | 50,00 с | .07 с | 5,1 мин | 7,7 мин | 1,60 с | 13,1 мин |
uJSON | 18,6 мин | 20,1 мин | 17,5 мин | 4,31 с | 53,02 с | 57,6 мин |
McJSONJson->Add("key")->AsString = "value" .JsonP->AsJSON = Json->AsJSON .LkJsonTlkBalTree дерева поиска».dynamic_cast , создающего код вербозии.Json->Add("key", "value") .JsonP = dynamic_cast<TlkJSONObject*>(TlkJSON::ParseText(NULL, TlkJSON::GenerateText(NULL, Json))) .JsonToolsJson->Add("key", "value") .JsonP->Value = Json->AsJson .myJSONJson->Item["key"]->setStr("value") .JsonP->Code = Json->getJSON() .uJSONLkJson , но селекция классов также заставит кастинг с dynamic_cast .uJSON , кажется, существует проблема с производительностью, связанная с toString() .Json->put("key", "value") .JsonP = new TJSONObject(Json->toString()) .SaveToFile не существует, поэтому он использовал TStringList->SaveToFile() после заполнения Text Json->toString() . Метрика: среднее время в секундах (ы) для 5 последовательных казней. Всего - среднее из частичных испытаний. Некоторые результаты преобразованы в минуты (мин). ↩
Версия 1.0.5. Улучшенный тест JSON 0.9.0 Project, который будет выпущен в ближайшее время. ↩ ↩ 2
