Tutorial: Verwenden der Sqids-Codierung

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Tutorials zu Datenbanken und LiveBindings


Dieses Tutorial zeigt, wie die Sqids-Codierung in RAD Studio verwendet wird. Sqids ist eine praktische Funktion für die Navigation in einer Datenstruktur wie einer Datenbanktabelle.

RAD Server stellt standardmäßig URLs bereit, die spezifische Informationen über die Datensätze enthalten können. So wird beispielsweise erwartet, dass ein einzelner Datensatz anhand des Primärschlüssels, häufig einer ID, identifiziert wird. Daher können Server Endpunkte mit einer ähnlichen Endung wie /customer/12345 haben.

Dies ist aus mehreren Gründen nicht ideal, angefangen bei der Tatsache, dass Sie interne Details weitergeben (die möglicherweise nicht so neutral sind wie eine Nummer), bis hin zu den potenziellen Sicherheitsauswirkungen der Offenlegung einer Datensatz-ID.

Es gibt viele Lösungen für dieses Problem, hauptsächlich eine bidirektionale Zuordnung der Datensatz-ID zu einem String. Anstatt eine eigene Lösung zu implementieren, werden wir ab RAD Studio 12.0 die Sqids-Bibliothek übernehmen.

Was ist Sqids?

Es handelt sich um eine Open-Source-Bibliothek, die kurze IDs aus positiven Zahlen generiert (mit den Standardeinstellungen von Sqids wird beispielsweise 12345 in A6da codiert).

Außerdem erlaubt Sqids die Codierung einer oder mehrerer positiver Zahlen in einer einzigen ID. Es gibt keine Begrenzung für die Anzahl der zu codierenden Zahlen, aber es gibt eine Begrenzung für ihre Länge (je nach Implementierungssprache).

Unter Sqids FAQ (EN) erhalten Sie weitere Informationen zu Sqids.

Codebeispiel: So verwenden Sie die Sqids-Codierung

Um Sqids zu implementieren, wurde mit RAD Studio 12.0 die neue Klasse System.NetEncoding.Sqids.TSqidsEncoding eingeführt, die alle Methoden zur Verwendung von Sqids bereitstellt. So implementieren Sie diese Klasse:

  1. Nehmen Sie die Unit System.NetEncoding.Sqids in die uses-Klausel auf.
  2. Erstellen Sie die TSqidsEncoding-Instanz mit der Methode Create.
  3. Codieren Sie die ID oder IDs mit der Methode Encode.
  4. Decodieren Sie die ID oder IDs mit einer der folgenden Methoden, je nach den Anforderungen Ihrer Anwendung:
  5. Sie können die TSqidsEncoding-Instanz mit der Methode Destroy freigeben.

Mit Sqids eine Anforderung an einen Webserver stellen

Es gibt zwei Möglichkeiten, mit Sqids eine Anforderung an einen Webserver zu stellen:

Wenn im zweiten Fall eine Anforderung gesendet werden soll, deren Parametername mit # beginnt, erstellt TRESTClient automatisch eine Instanz von TSqidsEncoding mit den Eigenschaften TRESTClient.SqidsAlphabet und TRESTClient.SqidsMinLength.

Wenn der Parametername ResourceSuffix in einer RAD Server-Ressource mit # beginnt, wird der Wert hingegen von Sqids decodiert. Die Konfiguration des Algorithmus basiert auf der Datei EMSServer.ini, insbesondere auf den Parametern Alphabet und MinHashLength: 

[Server.Sqids]
;# The following options control URL parameters Sqids decoding
;#
;# Optional alphabet for Sqids decoding
Alphabet=
;# Optional minimal hash length for Sqids decoding
MinHashLength=0
Hinweis: Informationen zur Bearbeitung der Datei EMSServer.ini finden Sie unter Manuelles Bearbeiten der Konfiguration der RAD Server Engine.

Siehe auch

Abgerufen von „https://docwiki.embarcadero.com/RADStudio/Athens/d/index.php?title=Tutorial:_Verwenden_der_Sqids-Codierung&oldid=220073“