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

Pour créer un projet de code chaîne lors de l'utilisation du générateur d'applications de chaîne de blocs, vous devez mettre à l'échelle 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 dont vous avez besoin.

Contexte

Blockchain App Builder initialise et soumet un projet de code chaîne prêt à l'emploi pour vous. En fonction de la saisie simple, la création d'un code chaîne peut générer des projets de code chaîne complexes avec des fonctionnalités 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 non CRUD
  • Validation automatique des arguments
  • Marquage/désérialisation des arguments
  • Fonctionnalité de persistance transparente (ORM)
  • Appeler des requêtes enrichies
  • 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 le modèle de décorateur, ce qui permet de spécifier les propriétés d'une immobilisation tenues à jour dans le livre en tant que champs saisis et étendues avec des comportements spécifiques et des règles de validation. Cela réduit le nombre de lignes de code, ce qui facilite 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.

  1. Dans le panneau Spécifications, sélectionnez Créer un fichier de spécifications.
  2. 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 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 préexistant dans 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 de toutes pièces.
    • Saisissez l'emplacement où vous souhaitez que le fichier de spécification soit stocké sur votre système.
    Cliquez sur Enregistrer.
Le nouveau fichier de spécification est créé et apparaît 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 :
  1. Dans le panneau Spécifications, cliquez sur Actions supplémentaires et sélectionnez Importer la spécification.
  2. Accédez au fichier et cliquez sur Importer la spécification.
Le fichier de spécifications est importé et apparaît 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écification qui se trouve déjà dans le panneau Spécifications en cliquant avec le bouton droit de la souris dessus 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 relatifs au contenu des fichiers de spécifications sont décrits ici : Fichier de spécifications d'entrée. Utilisez ces informations et les exemples de modèle de spécification pour créer votre contenu de spécification.

Valider un fichier de spécification

Si vous avez installé l'extension de support linguistique YAML, le fichier de spécification est automatiquement validé au fur et à mesure de la saisie. Les fonctionnalités de validation suivantes sont prises en charge automatiquement :
  • Exécution de la commande
  • Finalisation des noeuds scalaires sur les valeurs par défaut de schéma
  • Aide contextuelle lorsque vous passez le pointeur de la souris sur une propriété ou une méthode
  • Retrait des éléments de tableau lors de la saisie
  • Détection des erreurs de syntaxe

Echafaudage du projet de code chaîne

Lorsque vous disposez d'un fichier de spécification qui répond à vos besoins, générez votre projet de code chaîne.
  1. Dans le panneau Code chaîne, sélectionnez Créer un code chaîne.
  2. Le panneau Détails du code chaîne s'ouvre :
    • Saisissez le nom de votre 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 de destination où vous souhaitez que le projet soit créé dans votre environnement de développement local.
    Cliquez sur Créer.
Une fois votre projet créé, il apparaît 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 un jeton, reportez-vous également à :

Remarques :

  • Le panneau Code chaîne vous permet d'ouvrir le contenu du projet de code chaîne et de l'utiliser, mais ne vous permet pas d'ajouter, de supprimer ou de renommer des fichiers au sein du 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 VS 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.

Import d'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é votre contenu de chaîne de blocs de code VS et que vous voulez 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 un code chaîne.