Problem bei JSON-Abfrage

**Maekkelrajter**

Kannst du mal als Beispiel das JSON für eine funktionierende Antwort hier posten? Das müsste noch wesentlich eleganter gehen.

Auch deine aktuelle Lösung für die Authentifizierung würde ich gerne mal sehen (natürlich ohne echte Daten). Da ist oft auch noch Raum für Vereinfachungen.

Ich war ja froh, als ich das Ding endlich am laufen hatte. Ich zweifele auch nicht im geringsten daran dass der Code noch verbesserungsfähig ist. Hier also die Authentifizierungs Routinen, die ich übrigens zum Teil aus dem Beispiel-Programm abgekupfert habe:

zusammenfalten · markieren

Delphi-Quellcode:

			
{

type

    TSpManager = class(TForm)

    [...]

    IdHTTPServer1: TIdHTTPServer;

    OAuth2Authenticator1: TOAuth2Authenticator;

    RESTClient1: TRESTClient;

    RESTRequest1: TRESTRequest;

    RESTResponse1: TRESTResponse;

    procedure IdHTTPServer1CommandGet(AContext: TIdContext;

      ARequestInfo: TIdHTTPRequestInfo; AResponseInfo: TIdHTTPResponseInfo);

    [...]

 }

Procedure TSpManager.SendData(s:string);

 var

    CDStruct: TCopyDataStruct;

    copytext: ansistring;

begin

  copytext:= s;

  begin

    CDStruct.dwData:= 0;

    CDStruct.cbData:= length(Copytext) + 1;

    CDStruct.lpData:= @CopyText[1];

    SendMessage(MainHandle, WM_COPYDATA,1,integer(@CDStruct));

  end;

end;

Procedure TSpManager.AuthorizeSpotifyAccess;

begin

  IdHTTPServer1.Active := True;

  OAuth2Authenticator1.ResetToDefaults;

  OAuth2Authenticator1.ClientID := Stcf.AccessData.clientID;                      // Bei der Registrierung von Spotify zugeteilt (lokal gespeichert)

  OAuth2Authenticator1.ClientSecret := Stcf.AccessData.ClientSecret;              // Bei der Registrierung von Spotify zugeteilt (lokal gespeichert)

  OAuth2Authenticator1.AuthorizationEndpoint := 'https://accounts.spotify.com/authorize';

  // Bereiche, auf die Benutzerzugriff erlaubt sein soll

  OAuth2Authenticator1.Scope := 'playlist-read-private user-read-private user-library-read';

  // Weiterleitungsseite mit dem aktuellen AUTORISIERUNGSCODE

  OAuth2Authenticator1.RedirectionEndpoint := 'http://localhost:9090';

  // Die Definition des URI zum Generieren des AUTORISIERUNGSCODES

  ShellExecute(0, 'OPEN', PChar(Self.OAuth2Authenticator1.AuthorizationRequestURI), '', '', SW_SHOWNORMAL);

end;

procedure TSpManager.IdHTTPServer1CommandGet(AContext: TIdContext;

  ARequestInfo: TIdHTTPRequestInfo; AResponseInfo: TIdHTTPResponseInfo);

  var s:string;

begin

  // Abfrage-String validiert

  if (ARequestInfo.Params.IndexOfName('code') = -1) then Exit;

  // Definition des ACCESS CODE, den wir von der Weiterleitungsseite abrufen

  OAuth2Authenticator1.AuthCode := ARequestInfo.Params.Values['code'];

  // End-point für die Generierung des ACCESS TOKEN

  OAuth2Authenticator1.AccessTokenEndpoint := 'https://accounts.spotify.com/api/token';

  // Definieren des ACCESS TOKEN aus dem AUTORISIERUNGSCODE

  OAuth2Authenticator1.ChangeAuthCodeToAccesToken;

  // Antwort an den Browser

  AResponseInfo.ContentText := '<html><body><script language=javascript>window.close();</script>Vielen Dank, dass Sie den Zugriff erlaubt haben!</body></html>';

  // Operation erfolgreich!

  s:= OAuth2Authenticator1.AccessToken;

  SendData(s);                                            // Schickt die Daten nur zur Information an das Hauptfenster;

  FAuthorized:= s <> '';                                  // Boolean als Flag

end;

Im Anhang ein JSON mit Playlist-Daten, das Spotify nach einem Request mit dem accesspoint '/v1/playlists/{playlist_id}' liefert. Für meine Zwecke werden nur wenige Daten ausgelesen und in Zieldateien geschrieben (wenn vorhanden)
Für Anregungen und Verbesserungsvorschläge bin ich ausgesprochen dankbar!

Gruß LP

**Uwe Raabe**

Ich baue mir da immer anhand der API passende Objektstrukturen zusammen. Dann wird der Abruf nicht nur wesentlich simpler, man bekommt auch gleich die Typsicherheit dazu. Ich habe hier nur einen Teil der Felder deklariert. Alle übrigen werden ignoriert. Das lässt sich relativ leicht erweitern.

zusammenfalten · markieren

Delphi-Quellcode:

			uses

  System.JSON, REST.Json;

type

  TArtist = class

  private

    FName: string;

  public

    property Name: string read FName;

  end;

  TAlbum = class

  private

    FArtists: TArray<TArtist>;

    FName: string;

  public

    property Artists: TArray<TArtist> read FArtists;

    property Name: string read FName;

  end;

  TTrack = class

  private

    FAlbum: TAlbum;

    FArtists: TArray<TArtist>;

    FId: string;

    FName: string;

  public

    property Album: TAlbum read FAlbum;

    property Artists: TArray<TArtist> read FArtists;

    property Id: string read FId;

    property Name: string read FName;

  end;

  TUser = class

  private

    FDisplay_name: string;

  public

    property Display_name: string read FDisplay_name;

  end;

  TPlaylistTrack = class

  private

    FAdded_at: TDateTime;

    FAdded_by: TUser;

    FIs_local: Boolean;

    FTrack: TTrack;

  public

    property Added_at: TDateTime read FAdded_at;

    property Added_by: TUser read FAdded_by;

    property Is_local: Boolean read FIs_local;

    property Track: TTrack read FTrack;

  end;

  TPaging<T: class> = class

  private

    FHref: string;

    FItems: TArray<T>;

    FLimit: Integer;

    FNext: string;

    FOffset: Integer;

    FPrevious: string;

    FTotal: Integer;

  public

    property Href: string read FHref;

    property Items: TArray<T> read FItems;

    property Limit: Integer read FLimit;

    property Next: string read FNext;

    property Offset: Integer read FOffset;

    property Previous: string read FPrevious;

    property Total: Integer read FTotal;

  end;

  TPlayList = class

  private

    FName: string;

    FTracks: TPaging<TPlaylistTrack>;

  public

    property Name: string read FName;

    property Tracks: TPaging<TPlaylistTrack> read FTracks;

  end;

Der eigentliche Abrufcode beschränkt auf die im Eingangspost gezeigten Daten sieht dann so aus:

zusammenfalten · markieren

Delphi-Quellcode:

			function TSpManager.GetPlaylistTracks(PlaylistID: string; List: TStrings): string; // Liste der Track-IDs aus Playlist holen

var

  playlist: TPlaylist;

  track: TPlaylistTrack;

begin

  result := '';

  RESTRequest1.Resource := 'v1/playlists/{PlaylistID}'; // Accesspoint der Spotify Web-API

  RESTRequest1.AddParameter('PlaylistID', PlaylistID);

  RESTRequest1.Execute;

  if RestResponse1.JSONValue is TJSONObject then begin

    playlist := TJson.JsonToObject<TPlaylist>(TJSONObject(RESTResponse1.JSONValue));

    if playlist <> nil then begin

      Result := playlist.Name;

      if playlist.Tracks <> nil then begin

        for track in playlist.Tracks.Items do begin

          if track.Track <> nil then begin

            List.Add(track.Track.Id);

          end;

        end;

      end;

    end;

  end;

end;

**Maekkelrajter**

Zitat von Uwe Raabe:

Ich baue mir da immer anhand der API passende Objektstrukturen zusammen. Dann wird der Abruf nicht nur wesentlich simpler, man bekommt auch gleich die Typsicherheit dazu. Ich habe hier nur einen Teil der Felder deklariert. Alle übrigen werden ignoriert. Das lässt sich relativ leicht erweitern.

zusammenfalten · markieren

Delphi-Quellcode:

			uses

  System.JSON, REST.Json;

type

  TArtist = class

  private

    FName: string;

  public

    property Name: string read FName;

  end;

  ...

Vielen Dank für den ausführlichen Vorschlag. Auf eine solche wirklich elegante Lösung wäre ich als bekennender OOP-Muffel natürlich nie gekommen. Außerdem mache ich mir selten die Mühe, ein solch universelles und wiederverwendbares Konzept zu erstellen. Bei mir steht am Anfang der Wunsch nach einem bestimmten Feature, und das soll dann schnell und mit möglichst geringem (Lern-) Aufwand realisiert werden. Wenn erst mal alles läuft, gehe ich daran, den Code und das Handling zu 'optimieren', immer mit der 'Rohversion' als Rückfalloption. Wie ich schon früher schrieb, betreibe ich das Programmieren als Hobby und fast ausschließlich für den Eigenbedarf, auch gewissermaßen als 'Brain-Jogging' anstelle von Kreuzworträtseln, was in meinem Alter (73) vielleicht 'normal' wäre. Da ist der Workflow wohl etwas anders als bei einem professionellen Entwickler. Aber dennoch habe ich den Ehrgeiz, allzugroße Stümperei zu vermeiden und möglichst kompakte und strukturierte Lösungen zu finden. Da wird mich dieser Code-Happen (von einem 'Schnipsel' kann man ja wohl hier nicht sprechen) mit Sicherheit ein enormes Stück weiter bringen!

Gruß LP

**Uwe Raabe**

Es sollte nicht unerwähnt bleiben, dass der Code alles andere als vollständig ist. So werden die erzeugten Objekt-Instanzen unter non-ARC Plattformen nicht wieder freigegeben. Das müsste man noch im Destructor ergänzen.

**DeddyH**

Ich mache das übrigens ähnlich, nur dass das bei mir normalerweise keine Klassen, sondern Records sind. Diese verfügen über eine Klassenfunktion FromJSON, welche ein TJSONObject übernimmt und einen befüllten Record zurückgibt.

**Maekkelrajter**

Seit ein paar Tagen versuche ich, eine Abfrage nach Uwe Raabes Vorschlag zu realisieren. Bei der Ausführung der ' GetPlaylistTracks' - Funktion allerdings flogen mir die AccessViolations nur so um die Ohren

Den 'Unfallort' konnte ich in der Procedure TJSONUnMarshal.PopulateFields in der Unit REST.JsonReflect ausmachen:

zusammenfalten · markieren

Delphi-Quellcode:

			procedure TJSONUnMarshal.PopulateFields(JsonFields: TJSONObject; Data: TObject;

  JsonCustomizer: TJSONPopulationCustomizer);

[...]

        else if jsonFieldVal is TJSONArray then

        begin

          rField := GetFieldType(Data, FieldName);

          // Unmarshal TList<T>.FListHelper as dynamic array using 10.2 layout

          if (rField.FieldType.Handle = TypeInfo(System.Generics.Collections.TListHelper)) and  // Hier kracht's, wenn rField = NIL

             (I < JsonFields.Count - 1) and

             (string.CompareText('listHelper', FieldName) = 0) and

             (string.CompareText('items', JsonFields.Pairs[I + 1].JsonString.Value) = 0) then

          begin

            // "listHelper":[2] - ignore

            Inc(I);

            // "items":[{},{}]

            jsonFieldVal := JsonFields.Pairs[I].JsonValue;

            LValue := rField.GetValue(Data); // Get FListHelper

            SetTListHelperValueFromArrayValue(FRTTICtx, LValue,

              function (AArrType: TRttiType): TValue

              begin

                Result := JSONToTValue(jsonFieldVal, AArrType);

              end);

            rField.SetValue(Data, LValue); // Set FListHelper

          end

          else

            SetFieldArray(Data, FieldName, TJSONArray(jsonFieldVal));

        end

Immer dann, wenn ein Array nicht deklariert ist, gibt GetFieldType(Data, FieldName) NIL zurück, worauf prompt eine AccessViolation - Exception folgt. In unserem Fall waren das die Arrays 'images' und 'available_markets'.
Deshalb habe ich nun versucht, diese in die Typ-Deklarationen einzufügen. Bei 'images' ist mir das gelungen, nicht jedoch bei 'available_markets', was laut Spotify Web API Dokumentation als 'Array of Strings' deklariert ist.

zusammenfalten · markieren

Delphi-Quellcode:

			  
// Von mir hinzugefügt:

TImage = class

  private

    FHeight: Integer;

    FWidth: Integer;

    FUrl: String;

  public

    property height: Integer read FHeight;

    property width: Integer read FWidth;

    property URL: String read FUrl;

  end;

  TAlbum = class

  private

    FArtists: TArray<TArtist>;

    FMarkets: TArray<String>;

    FName: string;

  public

    property Artists: TArray<TArtist> read FArtists;

    property available_markets: TArray<string> read FMarkets;  // funktioniert nicht

    property Name: string read FName;

  end;

  TTrack = class

  private

    FAlbum: TAlbum;

    FArtists: TArray<TArtist>;

    FId: string;

    FName: string;

    FMarkets: TArray<String>;

  public

    property Album: TAlbum read FAlbum;

    property Artists: TArray<TArtist> read FArtists;

    property Id: string read FId;

    property Name: string read FName;

    property available_markets: TArray<String> read FMarkets; // funktioniert nicht

   [...]

  TPlayList = class

  private

    FName: string;

    FImages: TArray<TImage>;

    FTracks: TPaging<TPlaylistTrack>;

  public

    property Name: string read FName;

    property Images: TArray<TImage> read FImages;               //das funktioniert!

    property Tracks: TPaging<TPlaylistTrack> read FTracks;

  end;

Was mache ich bei der Deklaration falsch?

**Uwe Raabe**

Wenn der JSON-Value available_markets heisst, dann muss auch das Feld FAvailable_markets heißen. Delphi geht nach den Feldern, nicht nach den Properties. Die Regel ist: F entfernen, den dann ersten Buchstaben klein schreiben

Alternativ kann man den Namen auch mit einem Attribut überschreiben:

zusammenfalten · markieren

Delphi-Quellcode:

			  TAlbum = class

  private

    FArtists: TArray<TArtist>;

    [JSONName('available_markets')] 

    FMarkets: TArray<String>;

    FName: string;

  public

    property Artists: TArray<TArtist> read FArtists;

    property Markets: TArray<string> read FMarkets;

    property Name: string read FName;

  end;

**Maekkelrajter**

Nachdem das Ganze prinzipiell funktionierte, tauchte prompt die nächste Hürde auf. Die Spotify Web API limitiert nämlich die Zugriffe bei einer Playlist auf 100 Einträge. Ist die Liste länger, müssen weitere 'Seiten' des Paging-Objects nachgeladen und eingelesen werden. Die Frage war also, wie die weiteren Tracks dem Playlist-Objekt, soll heißen dem Array TPlaylist.Tracks.Items hinzugefügt werden können. Ich wollte nämlich keine zusätzliche 'externe' Liste für die Einträge anlegen, sondern nach Verlassen der Prozedur 'GetPlaylistTracks' sollte das Objekt 'Playlist' den kompletten Baum des von Spotify gelieferten Playlist-Objekts zur weiteren universellen Verwendung enthalten. Anderenfalls hätte man sich den ganzen Aufwand auch sparen können. Nach vielen Stunden mühsamer Recherche und viel Try & Error habe ich folgende Lösung gefunden:

zusammenfalten · markieren

Delphi-Quellcode:

			Function TSpManager.SendRequest(accesspoint:string; offset: Integer = 0; Limit: Integer = 50):TJSONValue;

begin

  result:= NIL;

  If FAuthorized Then

  begin

    RESTRequest1.Params.ParameterByName('offset').Value:= offset.ToString;

    RESTRequest1.Params.ParameterByName('limit').Value:= limit.ToString;

    RESTRequest1.Resource:= AccessPoint;

    RestRequest1.Execute;

    result:= RestResponse1.JSONValue;

  end else If NoSpotifyAccessMsg = mrYes Then AuthorizespotifyAccess;

end;

function TSpManager.GetPlaylistTracks(var Playlist: TPlaylist; PlaylistID: string): Boolean; //komplette Playlist-Daten holen

var

  JValue,oitem: TJSONValue;

  oItems: TJSONArray;

  newitem: TPlaylisttrack;

  offs,nextpos,totalItems: Integer;

begin

  result := false;

  offs:= 0;

  JValue:= SendRequest('v1/playlists/' + PlaylistID);

  if JValue is TJSONObject then

  begin

    playlist := TJson.JsonToObject<TPlaylist>(TJSONObject(JValue));

    if playlist <> nil then

    begin

      totalItems:= playlist.Tracks.total;

      offs:= length(playlist.Tracks.Items);

      while offs < TotalItems do                  // nächste 'Seite' des Paging-Objects

      begin

        Jvalue:= SendRequest('v1/playlists/' + PlaylistID + '/tracks',offs,100);

        If JValue is TJSONObject Then

        begin

          oItems := TJSONArray(TJSONObject(JValue).GetValue('items'));

         // Erweitert das Array Playlist.Tracks.Items um oItems.count und liefert die bisherige Größe als Offset zurück:

          nextpos:= playlist.IncreaseItems(oitems.count);

          for oItem in oItems do

          begin

            newitem:= TJson.JsonToObject<TPlaylisttrack>(TJSONObject(oitem));

            playlist.SetItem(newitem,nextpos);  // schreibt newitem in das Array

            inc(nextpos);

          end;

        end;

        inc(offs, oitems.Count);

      end;

    end;

  end;

  result:= playlist <> NIL;

end;

Das funktioniert auch perfekt, und sogar die Performance (incl. Ladevorgang) ist akzeptabel. Aber wie immer, wenn ich so etwas zusammen gefrickelt habe, kommt die Frage auf, ob diese Lösung wirklich 'State of The Art' ist und es nicht womöglich effizienter und/oder eleganter geht

Gruß LP

**Maekkelrajter**

Zitat von Maekkelrajter:

Dass aber ein Funktionsrückgabewert innerhalb einer Methode nicht auf Gültigkeit überprüft wird und eine Accessviolation auslöst, kann man doch nur als Bug ansehen.
Gruß LP

Nachtrag:
Dieser Bug in der Version 10.3.2 wurde schon in der Version 10.3.3 behoben.
Auf meinem Windows7 - System, auf dem ich dieses Projekt bisher entwickelt habe, läuft leider nur 10.3.2, so dass ich mich noch mit dem Bug herumschlagen musste.
Auf meinem Win10 - System läuft sowohl die IDE als auch mein Programm unter 10.3.3 fehlerfrei: Nicht deklarierte Arrays werden einfach ignoriert und lösen keine Exception mehr aus. Geht doch!

Gruß LP

Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

AW: Problem bei JSON-Abfrage

Forumregeln

Uwe Raabe Online Registriert seit: 20. Jan 2006 Ort: Lübbecke 11.631 Beiträge Delphi 12 Athens	#4 AW: Problem bei JSON-Abfrage 21. Sep 2020, 11:40 Es sollte nicht unerwähnt bleiben, dass der Code alles andere als vollständig ist. So werden die erzeugten Objekt-Instanzen unter non-ARC Plattformen nicht wieder freigegeben. Das müsste man noch im Destructor ergänzen. Uwe Raabe Certified Delphi Master Developer Embarcadero MVP Blog: The Art of Delphi Programming
	Zitat