ObjectList serialisieren JSON

[Uwe Raabe]

Zitat:

Zitat von lxo (Beitrag 1497360)

Aber da wird ja auch OwnsObjects, Listhelper mit in den JSONString geschrieben. Das möchte ich ja genau verhindern.
Ich möchte eine Instanz exportieren in einem allgemeinen JSONFormat damit auch ein anderer mit z.B. c# auch mit der Datei klar kommt.

Das ist ja auch genau der Hintergrund für die Interceptor-Klassen. Die wandeln nämlich die Listen in JSON-Arrays um und wieder zurück. Im wesentlichen tun TJson.JsonToObject und TJson.ObjectToJsonXXX ja auch nichts anderes als Marshal und CreateObject (Unmarshal gibt es nur in Data.DBXJSONReflect, die beißt sich aber mit REST.JsonReflect) für die jeweils erzeugten Hilfsklassen aufzurufen (halt nur simpler zu benutzen). Kann man ganz gut in deren Implementierung nachschauen.

Zitat:

Zitat von lxo (Beitrag 1497359)

Oder gibt es auch eine Möglichkeit eine Klasse abzuleiten von ObjectList<T> wo der Interceptor dran und von der Klasse dann meine ObjectLists zu abzuleiten, damit die Struktur dann so aussieht:
TFirmaList.TFirma.TPersonList.TPerson

Man könnte einen Interceptor schreiben, der TJson.ObjectToJsonString dazu bringt, aus einer TObjectList<T> ein Json-Array (fängt mit [ anstatt { an) zu machen. Die Rückwandlung des Json, was ja dann ein Json-Array ist, funktioniert aber nicht mit TJson.JsonToObject, da das explizit ein TJsonObject erwartet und kein TJsonArray. Auch Data.DBXJSONReflect ist da ähnlich restriktiv.

Das wäre dann vielleicht mal was für eine Erweiterung der REST.Json.Helpers Unit. :)

[DeddyH]

Ich habe das für mich jetzt so gelöst, dass ich mir eine Basisklasse TJSONSerializable erstellt habe. Diese geht per RTTI ihre eigenen Properties durch und schaut, ob diese ein Attribut JSONFieldName aufweisen, in welchem der Keyname des JSON-Pairs angegeben ist. Zum Serialisieren wird ein TJSONObject erzeugt und die erwähnten JSON-Pairs gemäß der Readable-Properties hinzugefügt. Zum Deserialisieren geht das Ganze dann für die Writable-Properties andersherum. Eine spezialisierte generische TObjectList gibt es auch, die erstellt dann ein JSONArray mit Elementen der serialisierten TJSONSerializable-Instanzen. Leider habe ich diese Klasse für die Firma geschrieben und darf sie daher nicht einfach veröffentlichen, aber in dem Zusammenhang gibt es hier einen Thread von mir: https://www.delphipraxis.net/209157-...-erkennen.html

Da das IMHO unkritisch ist, kann ich aber zumindest Ausschnitte des Interface-Abschnitts zeigen:

Delphi-Quellcode:

uses System.SysUtils, System.JSON, System.Generics.Collections, System.Rtti;

type
  (* Attribut, mit dem gesteuert wird, wie das Feld im JSON-Objekt
    heißt/heißen soll *)
  JSONFieldNameAttribute = class(TCustomAttribute)
  private
    FFieldname: string;
  public
    constructor Create(const AFieldName: string);
    property Fieldname: string read FFieldname;
  end;

  (* Attribut, mit dem angegeben wird, dass der Standardwert des entsprechenden
    Property-Datentyps als NULL ausgegeben werden soll. Betrifft nur die
    Wandlung in JSON, andersherum nicht, da Delphi keine echten Nullables
    kennt. *)
  JSONNullIfDefaultAttribute = class(TCustomAttribute);

  // Forward-Deklarationen für die Klassenfunktion FromJSON
  TJSONSerializable = class;
  TJSONSerializableClass = class of TJSONSerializable;

  (* Die Parent-Klasse für JSON-Serialisierung. Betrachtet werden alle
    Properties, die das JSONFieldName-Attribut (s.o.) haben. Geparst werden
    einfache Datentypen, Arrays, Objekte (falls von TJSONSerializable
    abgeleitet) und Listen, sofern diese generisch sind.
    Heißt: TList<string> wird abgearbeitet, TStringList hingegen nicht.
    Wir leiten von TInterfacedObject ab, damit wir in Ableitungen ggf. noch
    Interfaces anflanschen können und damit automatische Referenzzählung
    haben. *)
  TJSONSerializable = class(TInterfacedObject)
  public
    constructor Create; virtual;
    function ToJSON: TJSONObject; virtual;
    // Parameter:
    // Obj = das zu parsende JSON-Objekt
    // AClass = die zu erzeugende konkrete Klasse (Ableitung von TJSONSerializable)
    // Um das erzeugte Objekt dann auch vollständig nutzen zu können, muss
    // es noch in den konkreten Typ gecastet werden:
    // MyObj := TMyObj.FromJSON(JsonObjekt, TMyObj) as TMyObj;
    class function FromJSON(const Obj: TJSONObject;
      const AClass: TJSONSerializableClass): TJSONSerializable; static;
  end;

  TJSONSerializableObjectList<T: TJSONSerializable> = class(TObjectList<T>)
  public
    function ToJSON: TJSONArray; virtual;
    class function FromJSON(const Obj: TJSONArray): TJSONSerializableObjectList<T>; static;
  end;

Benutzen lässt sich dann beispielsweise so:

Delphi-Quellcode:

type
  TUserDB = class(TJSONSerializable)
  private
    FName: String;
    FWinAuth: Boolean;
    FIsMySQL: Boolean;
    FPort: Word;
    FDatabase: String;
    FPassword: String;
    FUser: String;
    FServer: String;
  public
    [JSONFieldName('Name')]
    property Name: String read FName write FName;
    [JSONFieldName('Server')]
    property Server: String read FServer write FServer;
    [JSONFieldName('IsMySql')]
    property IsMySql: Boolean read FIsMySQL write FIsMySQL;
    [JSONFieldName('User')]
    property User: String read FUser write FUser;
    [JSONFieldName('Database')]
    property Database: String read FDatabase write FDatabase;
    [JSONFieldName('Password')]
    property Password: String read FPassword write FPassword;
    [JSONFieldName('Port')]    
    [JSONNullIfDefault]
    property Port: Word read FPort write FPort;
    [JSONFieldName('WinAuth')]
    property WinAuth: Boolean read FWinAuth write FWinAuth;
  end;

...

UserDB := TUserDB.Create;
...
{TJSONObject}lObj := UserDB.ToJSON;

[Uwe Raabe]

Zitat:

Zitat von lxo (Beitrag 1497359)

Oder gibt es auch eine Möglichkeit eine Klasse abzuleiten von ObjectList<T> wo der Interceptor dran und von der Klasse dann meine ObjectLists zu abzuleiten

Nein, das geht nicht. Man kann an eine (generische) Klasse kein generisches Attribut anhängen.

Zitat:

Zitat von Uwe Raabe (Beitrag 1497363)

Das wäre dann vielleicht mal was für eine Erweiterung der REST.Json.Helpers Unit. :)

Ich habe das mal entsprechend erweitert und vereinfacht. Die neue Version findet man bei GitHub: https://github.com/UweRaabe/REST-JSon-Helpers

Bezogen auf dein Code-Beispiel und erweitert um die direkten Verarbeitung der Listen könnte das nun so aussehen:

Delphi-Quellcode:

type
  TPerson = class
  private
    FName: String;
  public
    property Name: String read FName write FName;
  end;

  JsonObjectListPersonAttribute = class(JsonObjectListAttribute<TPerson>);

type
  [JsonObjectListPerson]
  TPersonListe = class(TObjectList<TPerson>);

type
  { Wrapper }
  TPersonJSON = class
  private
    [JSONOwned(False)]
    FPersonListe: TPersonListe;
  public
    constructor Create;
    destructor Destroy; override;
    property PersonListe: TPersonListe read FPersonListe write FPersonListe;
  end;

...

const
  cNamen: TArray<String> = ['Name1', 'Name2', 'Name3'];
  cPersonListe = '[{"name":"Name1"},{"name":"Name2"},{"name":"Name3"}]';
  cPersonJSON = '{"personListe":[{"name":"Name1"},{"name":"Name2"},{"name":"Name3"}]}';

  function CheckListe(AListe: TPersonListe): Boolean;
  var
    I: Integer;
  begin
    Result := (AListe.Count = Length(cNamen));
    if Result then begin
      for I := 0 to AListe.Count - 1 do
        if AListe[I].Name <> cNamen[I] then
          Exit(False);
    end;
  end;

var
  lPersonJSON: TPersonJSON;
  lPerson: TPerson;
  lJSONString: String;
  lPersonListe: TPersonListe;
begin
  { mit Wrapper }
  lPersonJSON := TPersonJSON.Create;
  try
    for var lName in cNamen do
    begin
      lPerson := TPerson.Create;
      lPerson.Name := lName;
      lPersonJSON.PersonListe.Add(lPerson);
    end;

    lJSONString := TConvert.ToJSONString(lPersonJSON);
    Assert(lJSONString = cPersonJSON);
  finally
    lPersonJSON.Free;
  end;

  lPersonJSON := TConvert.FromJSON<TPersonJSON>(cPersonJSON);
  try
    Assert(CheckListe(lPersonJSON.PersonListe));
  finally
    lPersonJSON.Free;
  end;

  { Liste direkt }
  lPersonListe := TPersonListe.Create;
  try
    for var lName in cNamen do
    begin
      lPerson := TPerson.Create;
      lPerson.Name := lName;
      lPersonListe.Add(lPerson);
    end;

    lJSONString := TConvert.ToJSONString(lPersonListe);
    Assert(lJSONString = cPersonListe);
  finally
    lPersonListe.Free;
  end;

  lPersonListe := TPersonListe.Create;
  try
    lPersonListe.AddRange(TConvert.FromJSONArray<TPerson>(cPersonListe));
    Assert(CheckListe(lPersonListe));
  finally
    lPersonListe.Free;
  end;

end;

[lowmax_5]

Bei

Code:

lJSONString := TConvert.ToJSONString(lPersonJSON);

bekomme ich einen Fehler mit der Meldung 'Assertion fehlgeschlagen....' (Delphi 11)

[Uwe Raabe]

Zitat:

Zitat von lowmax_5 (Beitrag 1497433)

Bei

Code:

lJSONString := TConvert.ToJSONString(lPersonJSON);

bekomme ich einen Fehler mit der Meldung 'Assertion fehlgeschlagen....' (Delphi 11)

Hmm, kommt hier nicht - auch Delphi 11. Kannst du das komplette Projekt posten?

[lowmax_5]

Klar!

[Uwe Raabe]

Zwischen der Deklaration von JsonObjectListPersonAttribute und dessen Verwendung muss mindestens ein type stehen.

Steht auch so in der Readme:

Zitat:

Also there must be at least one type keyword between the declaration and the use of the attribute.

[lowmax_5]

Vielen Dank! Das hatte ich überlesen und habe wieder was dazu gelernt. Das das zweite Type notwendig ist hätte ich auch nicht erwartet.

[mytbo]

Darf es auch etwas anderes sein? Ich bringe mal das Open Source Framework mORMot ins Spiel. mORMot ist von D7 bis Delphi 11 Alexandria verfügbar. Eine ausführliche Hilfe findest du hier: Hilfe. Weitere Informationen findest du hier: Download, Forum. mORMot musst du nicht installierten. Es reicht aus, die entsprechenden Bibliothekspfade einzufügen.

Mit mORMot kannst du die Published Eigenschaften eines Objekts/Objektliste ohne einen eigenen JSON Serializer schreiben und lesen. Das geht auch bei verschachtelten Objekt-Strukturen. Mit ObjArrayToJson() wird z.B. ein Array of TPerson gespeichert. mORMot verarbeitet fast alles.

Delphi-Quellcode:

type
  TPerson = class(TObject)
  private
    FName: String;
  published
    property Name: String
      read FName write FName;
  end;

FPersonListe: TObjectList;

// In eine Datei speichern
ObjectToJsonFile(FPersonListe, 'test.json', [woObjectListWontStoreClassName]);

// Aus einer Datei laden
JsonFileToObject('test.json', FPersonListe, TPerson);

initialization
  Rtti.RegisterClasses([TPerson]);

Bis bald...
Thomas

[venice2]

@mytbo mORMot ist Top habe deine Hilfe diesbezüglich auch nicht vergessen. :thumb: