Créer un projet de code de chaîne avec l'extension Blockchain App Builder Visual Studio Code

Pour créer un projet de code de chaîne avec le générateur d'applications Blockchain, vous copiez un projet de code de chaîne à partir d'un fichier de spécification détaillé. Cela génère un projet avec tous les fichiers nécessaires.

Arrière-plan

Blockchain App Builder initialise et échafaude un projet de code de chaîne prêt à l'emploi. En se basant sur une entrée simple, la commande Créer un code de chaîne peut générer des projets de code de chaîne complexes comportant des fonctions telles que :

Plusieurs ressources (modèles) et leurs comportements (contrôleurs)
Générer automatiquement des méthodes CRUD (Créer/Lire/Mettre à jour/Supprimer) et autres que CRUD
Validation automatique des arguments
Marquage/déconversion des arguments
Capacité de persistance transparente (ORM)
Prise en charge étendue des interrogations
Prise en charge des données transitoires et privées
Identity Management

Le projet généré suit le modèle de modèle/contrôleur et de décorateur, ce qui permet aux propriétés d'une immobilisation mises à jour dans le livre d'être spécifiées en tant que champs de type et étendues avec des comportements et des règles de validation spécifiques. Cela réduit le nombre de lignes de code, ce qui peut faciliter la lisibilité et l'évolutivité.

Créer un fichier de spécification

Vous devez d'abord créer un fichier de spécification d'entrée. Vous ne pouvez pas modifier les exemples de fichiers de spécification qui ont été installés dans le cadre de Blockchain App Builder, mais vous pouvez les dupliquer ou les utiliser comme fichier de référence pour vos propres fichiers de spécification.

Dans le volet Spécifications, sélectionnez Créer un fichier de spécifications.
Dans le volet Détails des spécifications, effectuez les étapes suivantes.
- Entrez le nom du fichier de caractéristiques.
- Sélectionnez le type de fichier. Les formats YAML et JSON sont pris en charge.
- Facultativement, entrez une description pour le fichier.
- La liste déroulante Fichier de référence vous permet de générer votre fichier de spécification à partir d'un fichier dans votre espace de travail, si vous avez un fichier à utiliser comme modèle. Si rien n'est sélectionné, le fichier créé sera vide et vous pouvez entrer votre spécification à partir de zéro.
- Entrez l'emplacement où le fichier de caractéristiques doit être stocké dans votre système.
Cliquez sur Enregistrer.

Le fichier de spécification est créé et affiché dans le volet Spécifications. Cliquez dessus pour l'ouvrir dans l'éditeur.

Importer un fichier de spécification

Si vous disposez d'un fichier de spécification préexistant, vous pouvez l'importer.

Dans le volet Spécifications, cliquez sur Actions supplémentaires, puis sélectionnez Importer la spécification.
Naviguez jusqu'à votre fichier et cliquez sur Spécification d'importation.

Le fichier de spécification est importé et affiché dans le volet Spécifications. Cliquez dessus pour l'ouvrir dans l'éditeur.

Dupliquer un fichier de spécification

Vous pouvez également dupliquer un fichier de spécification qui se trouve déjà dans votre volet Spécifications en cliquant dessus avec le bouton droit de la souris et en sélectionnant Dupliquer. Cliquez avec le bouton droit de la souris sur le fichier et sélectionnez Renommer pour mettre à jour le nom.

Pour plus de détails sur le contenu des fichiers de spécifications, voir Fichier de spécification d'entrée. Utilisez ces informations et les exemples de modèles de spécification pour créer votre contenu de spécification.

Valider un fichier de spécification

Si vous avez installé l'extension YAML Language Support, le fichier de spécification est automatiquement validé au fur et à mesure que vous tapez. Les fonctions de validation suivantes sont prises en charge automatiquement :

Achèvement de la commande
Achèvement des noeuds scalaires par rapport aux valeurs par défaut du schéma
Aide contextuelle lorsque vous positionnez le pointeur de la souris sur une propriété ou une méthode
Décalements pour les articles de tableau lorsque vous tapez
Détection des erreurs de syntaxe

Échafaudage du projet Chaincode

Après avoir créé un fichier de spécification, vous pouvez générer un projet de code de chaîne.

Dans le volet Codes de chaîne, sélectionnez Créer un nouveau code de chaîne.
Dans le volet Détails du code de chaîne, effectuez les étapes suivantes.
- Entrez le nom de votre projet de code de chaîne.
- Sélectionnez la langue : TypeScript ou Go.
- Sélectionner le fichier de spécification que vous utilisez pour créer le code de chaîne.
- Entrez l'emplacement ou le domaine Go où vous voulez que le projet soit créé dans votre environnement de développement local.
Cliquez sur Créer.

Lorsque votre projet sera créé, il sera affiché dans le volet Codes de chaîne. Tous les fichiers requis par le code de chaîne seront dans le projet. Pour un aperçu détaillé des fichiers créés, voir :

Pour un aperçu détaillé d'un projet basé sur un jeton, voir aussi :

Note :

Le volet Codes de chaîne vous permet d'ouvrir le projet de code de chaîne et de l'utiliser, mais vous ne permet pas d'ajouter, de supprimer ni de renommer des fichiers dans le projet. Pour ce faire, cliquez avec le bouton droit de la souris sur votre projet et sélectionnez Ouvrir dans l'explorateur. Le projet s'ouvre dans la vue Visual Studio Code Explorer.
La suppression ou le changement de nom de fichiers dans le projet de code de chaîne peut potentiellement rompre le lien entre les fichiers de projet et le fichier de spécification utilisé pour le créer. Si vous prévoyez de synchroniser votre code entre les deux, ne modifiez pas les noms de fichier.

Importer un projet de code de chaîne existant

Si vous avez créé un projet de code de chaîne au moyen de l'interface de ligne de commande ou que vous avez nettoyé le contenu de la chaîne de blocs de Visual Studio Code et que vous voulez importer un projet enregistré localement, dans le volet Codes de chaîne, cliquez sur l'icône Actions supplémentaires... et sélectionnez Importer le code de chaîne. Naviguez jusqu'au projet et cliquez sur Importer le code de chaîne.