McJSON
1.0.0
Um construtor Delphi / Lazarus / C ++ simples e pequeno classe para análise rápida do JSON.
Alguns pontos de interesse:
McJSON ), apenas uma classe ( 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 ; Produzirá 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);
} Considere os testes de leitura de leitura na pasta test para obter uma lista completa de casos de uso McJSON .
Basta usar a propriedade 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 ; Se você deseja verificar se uma string json é válida:
Answer := N.Check( ' {"i":[123} ' ); // Answer will be false O método Check não aumentará nenhuma exceção. O exemplo acima captura e ocultará o Error while parsing text: "expected , got }" at pos "10" Exceção. Se você precisar capturar e gerenciar exceções, use CheckException como:
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 permite uma maneira simples de acessar itens através de caminhos. Podemos usar '/', '' ou '.' como separadores de caminho.
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
// access and change second object's value
N.Path( ' o.k2 ' ).AsString := ' value2 ' ;Resultados em:
{
"o" : {
"k1" : " v1 " ,
"k2" : " value2 "
}
} Observe que Path() ainda não aceita índices, assim:
N.AsJSON := ' {"o": [{"k1":"v1"}, {"k2":"v2"}] ' ;
N.Path( ' o[1].k2 ' ).AsString := ' value2 ' ; Desde a versão 1.0.4, McJSON permite usar os afastadores de propriedades como nos objetos de dados JSON de 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 ;Resultados em:
{
"foo" : " bar " ,
"bar" : " foo " ,
"array" :[
10 ,
20 ,
{
"value" : 12.3 ,
"subarray" :[
100 ,
200
]
}
]
}Aqui está como acessar todos os itens (crianças) de um objeto JSON e alterar seu tipo de valor e conteúdo.
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 ; Resultados em:
{
"o" : {
"k1" : 1 ,
"k2" : 2
}
} Podemos usar as propriedades de Items[index] e Values['key'] para acessar itens dentro de objetos e matrizes. Desde a versão 0.9.5 , podemos usar o At(index, 'key') ou At('key', index) como encurtadores.
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 E existem outros usos sem o parâmetro 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 keyUsando o enumerador Delphi, você pode procurar crianças e valores do objeto do item.
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.AsStringAltere todos os valores de um objeto com vários itens. Não é tão comum lá fora.
N.AsJSON := ' {"o": {"k1":"v1", "k2":"v2"}} ' ;
N[ ' o ' ].AsString := ' str ' ;Resultados em:
{
"o" : {
"k1" : " str " ,
"k2" : " str "
}
} E se for necessário alterar o tipo de o :
N[ ' o ' ].ItemType := jitValue;
N[ ' o ' ].AsString := ' str ' ;Resultados em:
{
"o" : " str "
}Converta de Array para Tipo de Objeto e Vice-Versa. Além disso, não é tão comum por aí.
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 Resultados em:
{
"k1" : {
"0" : " 1 " ,
"1" : " 2 "
},
"k2" : [
" a " ,
" b "
]
}Insira alguns itens usando chaves e posição.
P.Insert( ' c ' , 0 ).AsInteger := 3 ;
P.Insert( ' b ' , 0 ).AsInteger := 2 ;
P.Insert( ' a ' , 0 ).AsInteger := 1 ;Resultados em:
{
"a" : 1 ,
"b" : 2 ,
"c" : 3
}Além disso, é possível inserir objetos nas matrizes.
Q.AsJSON := ' {"x":0} ' ;
P.ItemType := jitArray;
P.Insert(Q, 1 );Resultados em:
[
1 ,
{
"x" : 0
},
2 ,
3
] IMPORTANTE : Desde a versão 0.9.3, Add() e Insert() clonarão argumentos do tipo TMcJsonItem . Então, temos que libertar a memória para Q também:
P.Free;
Q.Free; Como a versão 1.0.5 Strings pode ser escapada com a função McJsonEscapeString() Helper:
N.AsJSON := ' {"path": ' + McJsonEscapeString( ' dirsubdir ' ) + ' } ' ; Resultados em:
{
"path" : " \ dir \ subdir "
} Na versão 1.0.6, foi introduzido o enum TJEscapeType usado em McJsonEscapeString() com esses níveis de fuga:
jetNormal : Escapes #8 #9 #10 #12 #13 " .jetStrict : Normal + / .jetUnicode : Strict + uXXXX .jetNone : compatibilidade com versões anteriores. Esses níveis são inspirados na função auxiliar de Lazarus StringToJSONString() da biblioteca fpjson.
Vamos ver como inspecionar toda a estrutura interna de dados, tipos e valores de um objeto 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);
}
// --------------------------------------------------------------------------- E usando um exemplo como 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() com um objeto Json carregado com testInspect.json :
TMcJsonItem* Json = new TMcJsonItem();
if (Json)
{
Json-> LoadFromFile ( " testInspect.json " );
Inspect (Json);
delete (Json);
}Resultados em:
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"\"
Desde a versão 0.9.0 , as teclas vazias serão analisadas e verificadas com erros:
N.AsJSON := ' {"": "value"} ' ; E ToString() produzirá um objeto JSON válido:
{
"" : " value "
}Internamente, ele usará a sequência constante c_empty_key como conteúdo do campo FKEY.
Desde a versão 0.9.2 , as cordas com quebras de linha não escapadas serão analisadas com erros:
N.AsJSON := ' {"key": "value ' + # 13 + ' "} ' ;Aumentará a exceção:
Error while parsing text: "line break" at pos "14"
McJSON pode carregar de arquivos ASCII e UTF-8 (com ou sem BOM). Consulte LoadFromFile Method. O método SaveToFile gravará usando a codificação UTF-8. Nota : Como a Vertion 1.0.4, o código-fonte do projeto de teste em Lazarus foi convertido para o UTF-8, portanto o parâmetro asUTF8 foi definido como false .
O mundo não é perfeito e nem eu. Aqui estão alguns problemas conhecidos:
TMcJsonItem são instanciados na estrutura hierárquica usando as listas fChild , há um problema para criar campos que se propagam automaticamente entre os itens. Uma solução em estudo tenta criar uma nova classe de pais TMcJson que objetos serão como raízes e têm objetos TMcJsonItem como seus filhos. Um teste de desempenho foi realizado com as unidades originais de myJSON , LkJson , JsonTools e uJSON . Aqui está um resumo dos testes.
{... {"keyi":"valuei"}... }E sobre o compilador e a máquina usada:
A tabela seguinte resume os resultados 1 :
| Biblioteca | Gerar | Salvar | Analisar | Carregar | Acesso | Total |
|---|---|---|---|---|---|---|
McJSON 2 | .11 s | .07 s | .12 s | .09 s | .83 s | 1,25 s |
LkJson 2 | .30 s | .11 s | .47 s | .36 s | .01 s | 1,24 s |
JsonTools | 48,00 s | .70 s | 39,00 s | 40.00 s | .48 s | 1,2 min |
myJSON | 50,00 s | .07 s | 5,1 min | 7,7 min | 1.60 s | 13,1 min |
uJSON | 18,6 min | 20,1 min | 17,5 min | 4.31 s | 53.02 s | 57,6 min |
McJSONJson->Add("key")->AsString = "value" .JsonP->AsJSON = Json->AsJSON .LkJsonTlkBalTree .dynamic_cast fazendo o código verbosy.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 , mas a coleta de classes também forçará o elenco com dynamic_cast .uJSON , parece haver um problema de desempenho relacionado ao toString() .Json->put("key", "value") .JsonP = new TJSONObject(Json->toString()) .SaveToFile não existe, por isso usou TStringList->SaveToFile() após preencher Text com Json->toString() . Métrica: Tempo médio em segundos (s) para 5 execuções consecutivas. Total é a média de testes parciais. Alguns resultados convertidos em minutos (min). ↩
Versão 1.0.5. Projeto de teste aprimorado JSON 0.9.0 que será lançado em breve. ↩ ↩ 2
