TypeID-JS: Typsichere, K-sortierbare eindeutige IDs für Javascript

Seit wir TypeID letztes Jahr zum ersten Mal angekündigt haben, haben wir eine erhebliche Akzeptanz und großes Interesse seitens der Community festgestellt. Die Community hat 23 Clients in verschiedenen Sprachen beigesteuert und 90.000 wöchentliche NPM-Downloads unserer Typescript-Implementierung .

Letzte Woche haben wir Version 1.0 unserer Typescript-Implementierung TypeID-JS veröffentlicht. Um diese Veröffentlichung zu feiern, wollten wir mehr darüber erzählen, warum wir TypeID geschrieben haben und wie wir es verwenden, um die Typsicherheit bei Jetify zu gewährleisten.

Typsicherheit und eindeutige Bezeichner

Wir haben die Idee für TypeID entwickelt, als wir Jetify Cloud entwickelten, unsere Lösung für die Bereitstellung und Verwaltung von Devbox- oder Docker-basierten Projekten in Ihrem gesamten Team. Die Architektur von Jetify Cloud umfasst viele verschiedene Einheiten, die wir verwalten müssen: Organisationen, Benutzer, Bereitstellungen, Geheimnisse und Projekte, die alle eindeutige Kennungen benötigen, um sie zu unterscheiden.

Ursprünglich haben wir damit begonnen, Best Practices zu befolgen und jeder Instanz einer Entität eine UUID zuzuweisen. Dennoch stießen wir schnell auf ein Problem: UUIDv7 fehlt die Typsicherheit! Nehmen Sie den folgenden Code als Beispiel:

export const getMember = async (
  memberId: UUID,
  orgId: UUID,
) => {
  const { member, organization } =
    await authClient.organizations.members.get({
      organization_id: orgId,
      member_id: memberId,
    });

  return { member, organization };
};

Diese Funktion verwendet zwei UUIDs, um ein Mitglied und eine Organisation zu suchen. Allerdings kann die Funktion nicht sicherstellen, dass memberID und orgID die richtige Entität darstellen! Wenn ein Entwickler versehentlich eine Mitglieds-ID verwendet, an der wir eine Organisations-ID erwartet hatten, würden wir das Problem erst zur Laufzeit entdecken.

Als wir nach Lösungen für dieses Problem suchten, stießen wir auf die Objekt-ID von Stripe, die Typinformationen mithilfe eines Präfixes in IDs kodiert. Dies schien eine großartige Lösung zu sein, aber leider konnten wir keinen klar definierten Standard für die konsistente Implementierung typisierter IDs in mehreren Sprachen finden.

TypeID: K-sortierbare, typsichere, global eindeutige Bezeichner

TypeID ist unser Versuch, einen solchen einheitlichen Standard zu schaffen. TypeID ist eine typsichere, K-sortierbare, global eindeutige Kennung, die von den Präfixtypen von Stripe inspiriert ist. TypeID bietet auch einen konsistenten Standard für andere Sprachen zur Implementierung ihrer Clients und Bibliotheken.

TypeIDs kodieren eindeutige Bezeichner als Kleinbuchstabenzeichenfolge mit drei Teilen:

1. Ein Präfix, das den Typ der ID darstellt (63 Zeichen, ASCII-Kleinbuchstaben)
2. Ein Unterstrich-Trennzeichen (_)
3. Eine 128-Bit-UUIDv7, kodiert als 26-stellige Zeichenfolge unter Verwendung einer modifizierten Base32-Kodierung.

  user_2x4y6z8a0b1c2d3e4f5g6h7j8k
  └──┘ └────────────────────────┘
  type    uuid suffix (base32)

Mit diesem Format kann ein TypeID-kompatibler Client Typinformationen in Ihre IDs kodieren und dekodieren und dann beim Erstellen oder Kompilieren Überprüfungen durchführen, um sicherzustellen, dass Sie die richtige ID verwenden. Wenn wir beispielsweise eine zufällige TypeID für eine Benutzerentität erstellen möchten, könnten wir so etwas tun:

Mit TypeID können wir unseren Funktionen auch Typprüfungen hinzufügen und Fehler zur Laufzeit abfangen. Wenn wir das obige Beispiel umschreiben, können wir jetzt sicher sein, dass Entwickler die richtigen IDs an der richtigen Stelle verwenden:

import { TypeID } from 'typeid-js';

export const getMember = async (
  memberId: TypeID<'member'>,
  orgId: TypeID<'org'>,
) => {
    ...
}

Zusätzlich zur Typsicherheit verfügt dieses Format über einige Eigenschaften, die es für Entwickler benutzerfreundlich machen:

1. UUIDv7-kompatibel:Sie können eine TypeID ganz einfach in eine UUID umwandeln, indem Sie das Präfix entfernen und das Suffix dekodieren.
2. K-sortierbar: Sie können eine TypeID als sortierbaren Primärschlüssel in Ihrer Datenbank mit guter Lokalität verwenden.
3. URL-sicher: Wir verwenden TypeIDs in unseren URLs, um das Kopieren, Einfügen und Teilen zu vereinfachen. Durch das Einfügen von TypeIDs in die URL wird die Generierung des Seitenstatus vereinfacht.
4. Einfach auswählbar:Sie können es kopieren und durch Doppelklick einfügen (Probieren Sie es aus!)

Neue Funktionen in TypeID-JS v1.0

Heute kündigen wir Version 1.0 unserer TypeID-JS-Bibliothek an. Dieses Update fügt mehrere neue Funktionen hinzu, um die Benutzerfreundlichkeit und Typsicherheit zu verbessern, darunter:

1. Unboxed, funktionsbasierte, streambare TypeIDs: Dadurch ist es möglich, TypeIDs zu serialisieren, ohne sie in Strings umzuwandeln, und Sie können TypeIDs als Schlüssel in Maps und Sets verwenden.
2. Strengere Typ- und Laufzeitprüfung: TypeID gibt jetzt einen Fehler aus, wenn Sie versuchen, eine leere Zeichenfolge oder eine Typ-ID mit dem falschen Präfix zu analysieren.
3. Kompatibilität mit TypeID spec v3: JS TypeIDs können jetzt Unterstriche im Präfix verwenden. Beispiel: pro_subscription_2x4y6z8a0b1c2d3e4f5g6h7j8k ist eine gültige TypeID mit dem Präfix pro_subscription.

So verwenden Sie TypeID mit Ihrem Projekt

Sie können TypeID zu Ihrem JS-Projekt hinzufügen, indem Sie den NodeJS-Paketmanager Ihrer Wahl verwenden. Verwenden Sie kein JS? TypeID verfügt über 26 verschiedene Implementierungen, die von Go über OCaml bis hin zu SQL reichen. Wenn Sie daran interessiert sind, Ihre eigene Implementierung von TypeID zu schreiben, können Sie sich unsere formale Spezifikation ansehen.

Möchten Sie Ihr Entwicklungsteam stärken?

Unser Team bei Jetify entwickelt leistungsstarke Entwicklertools. Vereinfachen Sie Ihre Bereitstellungen und Projekte mit Jetify Cloud oder automatisieren Sie Onboarding + Entwicklungsumgebungen mit Devbox. Sie können uns auf Twitter folgen oder live mit unseren Entwicklern auf unserem Discord-Server chatten. Wir freuen uns auch über Probleme und Pull-Requests in unserem Github Repo.

Das obige ist der detaillierte Inhalt vonTypeID-JS: Typsichere, K-sortierbare eindeutige IDs für Javascript. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!