Chaincode-Projekt mit der Blockchain App Builder VS Code-Erweiterung erstellen

Um ein Chaincode-Projekt zu erstellen, wenn Sie Blockchain App Builder verwenden, müssen Sie ein Chaincode-Projekt aus einer detaillierten Spezifikationsdatei erstellen. Dadurch wird ein Projekt mit allen benötigten Dateien generiert.

Hintergrund

Blockchain App Builder initialisiert und erstellt ein Chaincode-Projekt sofort für Sie. Basierend auf einfacher Eingabe kann Neuen Chaincode erstellen komplexe Chaincode-Projekte mit folgenden Features generieren:
  • Mehrere Assets (Modelle) und ihr Verhalten (Controller)
  • CRUD-Methoden (Erstellen/Lesen/Aktualisieren/Löschen) und Nicht-CRUD-Methoden automatisch generieren
  • Automatische Validierung von Argumenten
  • Marshalling/Unmarshalling von Argumenten
  • Transparente Persistenzfähigkeit (ORM)
  • Rich Abfragen aufrufen
  • Transiente und private Datenunterstützung
  • Identity Management

Das generierte Projekt folgt dem Modell-/Controller- und Dekorationsmuster. Dadurch können die Eigenschaften eines Assets, die im Buch verwaltet werden, als typisierte Felder angegeben und mit bestimmten Verhaltensweisen und Validierungsregeln erweitert werden. Dadurch wird die Anzahl der Codezeilen reduziert, die bei der Lesbarkeit und Skalierbarkeit helfen.

Spezifikationsdatei erstellen

Bevor Sie beginnen, müssen Sie eine Eingabespezifikationsdatei erstellen. Beachten Sie, dass Sie die Beispielspezifikationsdateien, die als Teil von Blockchain App Builder installiert wurden, nicht ändern können. Sie können sie jedoch duplizieren oder als Referenzdatei für Ihre eigenen Spezifikationsdateien verwenden.

  1. Wählen Sie im Bereich Spezifikationen die Option Neue Spezifikationsdatei erstellen aus.
  2. Der Bereich Spezifikationsdetails wird geöffnet:
    • Geben Sie den Namen für die Spezifikationsdatei ein.
    • Wählen Sie den Dateityp aus - YAML und JSON werden unterstützt.
    • Geben Sie optional eine Beschreibung für die Datei ein.
    • In der Dropdown-Liste Referenzdatei können Sie die Spezifikationsdatei aus einer bereits vorhandenen Datei in Ihrem Workspace generieren, wenn Sie eine Datei haben, die Sie als Vorlage verwenden möchten. Wenn nichts ausgewählt ist, ist die erstellte Datei leer, und Sie können Ihre Spezifikation von Grund auf neu eingeben.
    • Geben Sie den Speicherort ein, an dem die Spezifikationsdatei im System gespeichert werden soll.
    Klicken Sie auf Speichern.
Die neue Spezifikationsdatei wird erstellt und im Bereich Spezifikationen angezeigt. Klicken Sie darauf, um es im Editor zu öffnen.

Spezifikationsdatei importieren

Wenn bereits eine Spezifikationsdatei vorhanden ist, können Sie sie importieren:
  1. Klicken Sie im Bereich Spezifikationen auf Weitere Aktionen, und wählen Sie Spezifikation importieren aus.
  2. Navigieren Sie zu Ihrer Datei, und klicken Sie auf Spezifikation importieren.
Die Spezifikationsdatei wird importiert und im Bereich Spezifikationen angezeigt. Klicken Sie darauf, um es im Editor zu öffnen.

Spezifikationsdatei duplizieren

Sie können auch eine Spezifikationsdatei duplizieren, die sich bereits im Bereich Spezifikationen befindet, indem Sie mit der rechten Maustaste darauf klicken und Duplizieren auswählen. Klicken Sie mit der rechten Maustaste auf die Datei, und wählen Sie Umbenennen aus, um den Namen zu aktualisieren.

Die Details zum Inhalt der Spezifikationsdateien werden hier beschrieben: Eingabespezifikationsdatei. Verwenden Sie diese Informationen und die Beispielspezifikationsvorlagen, um den Spezifikationsinhalt zu erstellen.

Spezifikationsdatei validieren

Wenn Sie die YAML Language Support-Erweiterung installiert haben, wird die Spezifikationsdatei automatisch beim Eingeben validiert. Die folgenden Validierungsfunktionen werden automatisch unterstützt:
  • Ausführung des Befehls
  • Abschluss von skalaren Knoten auf Schemastandardwerte
  • Kontextbezogene Hilfe, wenn Sie den Mauszeiger über eine Eigenschaft oder Methode bewegen
  • Indents für Arrayelemente während der Eingabe
  • Syntaxfehlererkennung

Das Chaincode-Projekt

Wenn Sie über eine Spezifikationsdatei verfügen, die Ihren Anforderungen entspricht, generieren Sie Ihr Chaincode-Projekt.
  1. Wählen Sie im Bereich Chaincodes die Option Neuen Chaincode erstellen aus.
  2. Der Bereich Chaincode-Details wird geöffnet:
    • Geben Sie den Namen des Chaincode-Projekts ein.
    • Wählen Sie die Sprache: TypeScript oder Go.
    • Wählen Sie die Spezifikationsdatei aus, die Sie zum Erstellen des Chaincodes verwenden.
    • Geben Sie den Speicherort oder die Go-Domain ein, an dem bzw. der das Projekt in Ihrer lokalen Entwicklungsumgebung erstellt werden soll.
    Klicken Sie auf Create.
Wenn Ihr Projekt erstellt wird, wird es im Bereich Chaincodes angezeigt. Alle für den Chaincode erforderlichen Dateien befinden sich im Projekt. Eine detaillierte Übersicht über die erstellten Dateien finden Sie unter: Eine detaillierte Übersicht über ein tokenbasiertes Projekt finden Sie auch unter:

Hinweis:

  • Im Bereich Chaincodes können Sie Inhalte innerhalb des Chaincode-Projekts öffnen und damit arbeiten. Sie können jedoch keine Dateien innerhalb des Projekts hinzufügen, löschen oder umbenennen. Klicken Sie dazu mit der rechten Maustaste auf Ihr Projekt, und wählen Sie Im Explorer öffnen aus. Dadurch wird das Projekt in der Ansicht "VS-Code-Explorer" geöffnet.
  • Das Löschen oder Umbenennen von Dateien im Chaincode-Projekt kann möglicherweise den Link zwischen den Projektdateien und der zu seiner Erstellung verwendeten Spezifikationsdatei aufheben. Wenn Sie Ihren Code zwischen den beiden synchronisieren möchten, ändern Sie die Dateinamen nicht.

Vorhandenes Chaincode-Projekt importieren

Wenn Sie ein Chaincode-Projekt über die CLI erstellt haben oder Ihren VS Code-Blockchain-Inhalt bereinigt haben und ein lokal gespeichertes Projekt importieren möchten, klicken Sie im Bereich Chaincodes auf das Symbol Weitere Aktionen..., und wählen Sie Kettencode importieren aus. Navigieren Sie zum Projekt, und klicken Sie auf Kettencode importieren.