Créer un projet de code de chaîne avec l'extension de code VS du générateur d'applications de chaîne de blocs

Pour créer un projet de chaîne de blocs lors de l'utilisation du générateur d'applications de chaîne de blocs, vous devez balayer un projet de chaîne de blocs à partir d'un fichier de spécification détaillé. Cela génère un projet avec tous les fichiers dont vous avez besoin.

Contexte

Blockchain App Builder initialise et transmet un projet de code de chaîne prêt à l'emploi pour vous. Sur la base d'une entrée simple, le service Créer un nouveau code de chaîne peut générer des projets de code de chaîne complexes comportant des fonctions telles que :

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

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

Créer un fichier de spécification

Avant de commencer, vous devez créer un fichier de spécification d'entrée. Notez que 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 volet Spécifications, sélectionnez Créer un nouveau fichier de spécifications.
Le volet Détails des spécifications s'ouvre :
- Entrez le nom du fichier de spécification.
- Sélectionnez le type de fichier - YAML et JSON sont pris en charge.
- Entrez éventuellement 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 préexistant dans votre espace de travail si vous avez un fichier que vous souhaitez utiliser comme modèle. Si rien n'est sélectionné, le fichier créé sera vide et vous pourrez 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 nouveau fichier de spécification est créé et s'affiche dans le volet Spécifications. Cliquez dessus pour l'ouvrir dans l'éditeur.

Importer un fichier de spécification

Si vous avez un fichier de spécification préexistant, vous pouvez l'importer :

Dans le volet Spécifications, cliquez sur Actions supplémentaires et sélectionnez Spécification d'importation.
Accédez à votre fichier et cliquez sur Spécification d'importation.

Le fichier de spécification est importé et s'affiche 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 le 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.

Les détails sur le contenu des fichiers de spécifications sont décrits ici : 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 de prise en charge du langage YAML, le fichier de spécification est automatiquement validé au fur et à mesure que vous tapez. Les fonctionnalités de validation suivantes sont prises en charge automatiquement :

Achèvement de la commande
Achèvement des noeuds scalaires aux valeurs par défaut de schéma
Aide contextuelle lorsque vous pointez la souris sur une propriété ou une méthode
Indentations des éléments de tableau au fur et à mesure que vous tapez
Détection d'erreurs de syntaxe

Échafaudage du projet de code de chaîne

Lorsque vous avez un fichier de spécification qui répond à vos besoins, générer le projet de code de chaîne.

Dans le volet Code de chaîne, sélectionnez Créer un nouveau code de chaîne.
Le volet Détails de la chaîne s'ouvre :
- Entrez le nom du projet de code de chaîne.
- Sélectionnez la langue : TypeScript ou Go.
- Sélectionnez 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.

Une fois votre projet créé, il s'affiche dans le volet Code de chaîne. Tous les fichiers requis par le code de chaîne seront dans le projet. Pour obtenir un aperçu détaillé des fichiers créés, voir :

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

Note :

Le volet Code de chaîne vous permet d'ouvrir le contenu du projet de code de chaîne et de l'utiliser, mais ne vous permet pas d'ajouter, de supprimer ou 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. Cela ouvre le projet dans la vue VS Code Explorer.
La suppression ou le changement de nom des 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 chaîne de blocs au moyen de l'interface de ligne de commande ou si vous avez nettoyé le contenu de la chaîne de blocs VS Code et que vous voulez importer un projet enregistré localement, dans le volet Code de chaîne, cliquez sur l'icône Actions supplémentaires... et sélectionnez Importer le code de chaîne. Accédez au projet et cliquez sur Importer le code de chaîne.