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

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

Contexte

Blockchain App Builder initialise et soutient un projet de code chaîne prêt à l'emploi. Sur la base d'une entrée simple, la commande Créer un code chaîne peut générer des projets de code chaîne complexes avec des fonctionnalités telles que :

Plusieurs actifs (modèles) et leurs comportements (contrôleurs)
Générer automatiquement des méthodes CRUD (Créer/Lire/Mettre à jour/Supprimer) et non-CRUD
Validation automatique des arguments
Marquage/désérialisation des arguments
Capacité de persistance transparente (ORM)
Prise en charge des requêtes enrichies
Prise en charge des données transitoires et privées
Gestion de l'identité

Le projet généré suit le modèle/contrôleur de gestion et le modèle de décorateur, ce qui permet de spécifier les propriétés d'une immobilisation qui sont gérées dans le livre en tant que champs saisis et de les étendre avec des comportements et des règles de validation spécifiques. Cela réduit le nombre de lignes de code qui peuvent aider à 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 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 panneau Spécifications, sélectionnez Créer un fichier de spécifications.
Dans le volet Détails des spécifications, procédez comme suit :
- Entrez le nom du fichier de spécification.
- Sélectionnez le type du fichier. Les formats YAML et JSON sont pris en charge.
- Vous pouvez éventuellement saisir une description du 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 de votre espace de travail, si vous disposez d'un fichier que vous souhaitez utiliser comme modèle. Si rien n'est sélectionné, le fichier créé sera vide et vous pourrez saisir votre spécification à partir de zéro.
- Saisissez l'emplacement où le fichier de spécification doit être stocké sur votre système.
Cliquez sur Enregistrer.

Le fichier de spécification est créé et affiché dans le panneau 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 panneau Spécifications, cliquez sur Actions supplémentaires, puis sélectionnez Importer la spécification.
Accédez à votre fichier et cliquez sur Importer la spécification.

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

Dupliquer un fichier de spécification

Vous pouvez également dupliquer un fichier de spécifications qui se trouve déjà dans le panneau 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 d'informations sur le contenu des fichiers de spécifications, reportez-vous à la section Input Specification File. 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é lors de la saisie. Les fonctionnalités de validation suivantes sont prises en charge automatiquement :

Exécution de la commande
Finalisation des noeuds scalaires vers les valeurs de schéma par défaut
Aide contextuelle lorsque vous survolez une propriété ou une méthode
Intentions pour les éléments de tableau lors de la saisie
Détection des erreurs de syntaxe

Échafaudage du projet Chaincode

Une fois que vous avez créé un fichier de spécification, vous pouvez générer un projet de code chaîne.

Dans le panneau Codes chaîne, sélectionnez Créer un code chaîne.
Dans le panneau Détails du code chaîne, procédez comme suit.
- Saisissez le nom du projet de code chaîne.
- Sélectionnez la langue : TypeScript ou Go.
- Sélectionnez le fichier de spécification que vous utilisez pour créer le code chaîne.
- Entrez l'emplacement ou le domaine Go dans lequel vous souhaitez que le projet soit créé dans votre environnement de développement local.
Cliquez sur Créer.

Une fois le projet créé, il est affiché dans le panneau Codes chaîne. Tous les fichiers requis par le code chaîne seront dans le projet. Pour une présentation détaillée des fichiers créés, reportez-vous aux sections suivantes :

Pour une présentation détaillée d'un projet basé sur des jetons, voir également :

Remarques :

Le panneau Codes chaîne vous permet d'ouvrir et d'utiliser le contenu du projet de code chaîne, mais ne vous permet pas d'ajouter, de supprimer ou de renommer des fichiers dans le projet. Pour cela, cliquez avec le bouton droit de la souris sur votre projet et sélectionnez Ouvrir dans l'explorateur. Le projet s'ouvre alors dans la vue Visual Studio Code Explorer.
La suppression ou le changement de nom de fichiers dans le projet de code 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 chaîne existant

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