Tous les produits
Search
Centre de documentation

Realtime Compute for Apache Flink:Extension VS Code pour le développement local

Dernière mise à jour :Aug 19, 2026

L'extension Realtime Compute for Apache Flink pour VS Code simplifie le processus de développement local des jobs Flink. Elle vous permet de développer, déployer et gérer des jobs SQL, JAR et Python, ainsi que de synchroniser les configurations de jobs depuis le cloud. Cette rubrique explique comment utiliser l'extension.

Prérequis

Limitations

  • La configuration des journaux n'est pas prise en charge.

  • L'extension ne permet pas de récupérer les jobs existants depuis le cloud.

Installer et configurer l'extension

  1. Téléchargez et installez l'extension.

    • Méthode 1 : Accédez à la place de marché VS Code et cliquez sur Install.

    • Méthode 2 :

      1. Ouvrez VS Code et cliquez sur EXTENSIONS dans le volet de navigation de gauche.

      2. Dans la barre de recherche, saisissez Flink Realtime Compute Studio.

      3. Cliquez sur Install.

  2. Dans la barre de menu supérieure, accédez à File > Open Folder et sélectionnez un dossier local.

  3. Configurez vos informations AccessKey.

    Current workspace

    1. Dans le volet de navigation de gauche, cliquez sur l'icône image. Dans la section Configure AK&SK, cliquez sur Configure in a .vvprc file. L'extension crée automatiquement un fichier avec l'extension .vvprc.

    2. Ajoutez la configuration suivante au fichier :

      {
        "accessKey": "xxx",
        "secretKey": "xxx",
        "namespace": "xxx",
        "workspace": "xxx",
        "regionId" : "xxx"
      }

      Parameter

      Description

      Notes

      accessKey

      L'AccessKey ID de votre compte Alibaba Cloud.

      Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?

      secretKey

      L'AccessKey Secret de votre compte Alibaba Cloud.

      namespace

      Le nom du namespace Flink.

      Pour plus d'informations, consultez Afficher et supprimer un namespace.

      workspace

      L'ID de l'espace de travail Flink.

      Pour plus d'informations, consultez Comment afficher l'ID de l'espace de travail et d'autres informations ?.

      regionId

      L'ID de la région.

      Trouvez l'ID de la région dans Endpoints.

    Global

    1. Dans le volet de navigation de gauche, cliquez sur l'icône image.

    2. Dans la section Configure AK&SK, cliquez sur Configure in global user settings. VS Code ouvre la page des paramètres globaux.

      Recherchez flinkStudio et définissez les champs suivants : Flink Studio: Access Key, Flink Studio: Secret Key, Flink Studio: Namespace, Flink Studio: Region ID (par défaut : cn-hangzhou) et Flink Studio: Workspace.

    3. Sélectionnez User ou Workspace pour la configuration, selon vos besoins.

      Remarque

      Nous recommandons de définir la portée sur User, ce qui applique la configuration à tous les projets. La portée Workspace applique la configuration uniquement à l'espace de travail actuel.

      Parameter

      Description

      Notes

      Access Key

      L'AccessKey ID de votre compte Alibaba Cloud.

      Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?

      Secret Key

      L'AccessKey Secret de votre compte Alibaba Cloud.

      Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?

      Namespace

      Le nom du namespace Flink.

      Pour plus d'informations, consultez Afficher et supprimer un namespace.

      Workspace

      L'ID de l'espace de travail Flink.

      Pour plus d'informations, consultez Comment afficher l'ID de l'espace de travail et d'autres informations ?.

      Region ID

      L'ID de la région.

      Trouvez l'ID de la région dans Endpoints.

    Remarque

    Priorité de la configuration : Dossier actuel > Dossier parent > Global.

    Une fois la configuration appliquée, le nom du namespace s'affiche dans la barre d'état en bas de l'éditeur.

  4. (Facultatif) Vous pouvez installer les extensions suivantes pour améliorer l'expérience de développement.

    • Flink SQL : Installez l'extension Flink SQL Language Features. Elle fournit un service linguistique pour Flink SQL et prend en charge la syntaxe complète de Flink SQL.

    • Configuration Flink : Nous recommandons d'installer l'extension YAML VS Code, qui offre la saisie semi-automatique pour les configurations Flink.

Procédure

Étape 1 : Créer une tâche

  • Méthode 1 : Dans le volet de navigation de gauche, cliquez sur l'icône image. Dans la section QUICK START, cliquez sur Create a new deployment. Saisissez un nom en haut et appuyez sur Entrée pour créer un fichier avec l'extension .vvp. Cette extension génère une tâche avec des champs par défaut.

  • Méthode 2 : Créez directement un nouveau fichier avec l'extension .vvp dans l'explorateur de fichiers. L'extension remplit le fichier avec une configuration de tâche par défaut.

Étape 2 : Configurer la tâche

Vous pouvez configurer les paramètres directement dans le formulaire de l'interface utilisateur.

Si vous maîtrisez la configuration des tâches, cliquez sur Raw File en haut à gauche pour configurer la tâche dans le fichier source. Le fait de cliquer sur un nom de paramètre dans le formulaire de l'interface utilisateur permet d'accéder à sa définition dans le fichier source.

{
  "name": "test",
  "artifact": {
    "kind": "SQLSCRIPT",
    "sqlArtifact": {
      "additionalDependencies": [],
      "sqlScript": ""
    }
  },
  "deploymentTarget": {
    "mode": "PER_JOB",
    "name": "default-queue"
  },
  ...
}
  • Basic : configurez les paramètres de base.

    Tâche SQL

    Paramètre

    Description

    Nom du déploiement

    Le nom du déploiement.

    Mode d'exécution

    Le mode de déploiement. Utilisez STREAM pour le mode streaming ou BATCH pour le mode batch.

    Version du moteur

    Pour plus d'informations sur les versions du moteur, consultez Versions du moteur. Nous vous recommandons d'utiliser la dernière version recommandée.

    Cible de déploiement

    La file d'attente de ressources pour le déploiement. Pour plus d'informations, consultez Gérer une file d'attente de ressources.

    Type de déploiement

    Sélectionnez SQL.

    Script SQL

    Cliquez sur Open in external editor pour ouvrir l'éditeur local. Rédigez votre code DDL et DML.

    Remarque

    Le fichier ouvert dans l'éditeur est un fichier virtuel qui n'est pas stocké dans le système de fichiers réel. Par conséquent, si vous rouvrez VS Code, un onglet d'éditeur pour un fichier virtuel non fermé affichera le message d'erreur The editor could not be opened because the file was not found. Pour ouvrir le fichier, cliquez à nouveau sur Open in external editor.

    Dépendances supplémentaires

    Les dépendances supplémentaires requises par la tâche. Saisissez l'URI du fichier de dépendance cible.

    Description

    Facultatif. Saisissez une description pour la tâche.

    Tâche JAR

    Pour plus d'informations sur la configuration des paramètres, consultez Déployer une tâche JAR.

    Paramètre

    Description

    Nom du déploiement

    Le nom du déploiement.

    Mode d'exécution

    Le mode de déploiement. Utilisez STREAM pour le mode streaming ou BATCH pour le mode batch.

    Version du moteur

    La version du moteur. Pour plus d'informations, consultez Versions du moteur. Nous vous recommandons d'utiliser la dernière version recommandée.

    Cible de déploiement

    La file d'attente de ressources pour le déploiement. Pour plus d'informations, consultez Gérer une file d'attente de ressources.

    Type de déploiement

    Le type de tâche à déployer. Sélectionnez JAR.

    URI JAR

    Le chemin OSS ou l'URL du package JAR.

    Assurez-vous d'avoir téléchargé les fichiers de dépendance pertinents dans Artifacts de la console de développement ou dans un bucket OSS lié, et d'avoir obtenu le chemin correspondant.

    Classe du point d'entrée

    La classe principale à exécuter. Requis si le manifeste JAR ne spécifie pas de classe principale.

    Arguments principaux du point d'entrée

    Saisissez les arguments d'entrée à transmettre à la méthode principale.

    Dépendances supplémentaires

    Saisissez le chemin OSS ou l'URL des fichiers de dépendance supplémentaires. Actuellement, seules les URL se terminant par un nom de fichier sont prises en charge.

    Assurez-vous d'avoir téléchargé les fichiers de dépendance pertinents dans Artifacts de la console de développement ou dans un bucket OSS lié, et d'avoir obtenu le chemin correspondant.

    Description

    Facultatif. Saisissez une description pour la tâche.

    Tâche Python

    Pour plus d'informations sur la configuration des paramètres, consultez Déployer une tâche Python.

    Paramètre

    Description

    Nom du déploiement

    Le nom du déploiement.

    Mode d'exécution

    Le mode de déploiement. Utilisez STREAM pour le mode streaming ou BATCH pour le mode batch.

    Version du moteur

    La version du moteur. Pour plus d'informations, consultez Versions du moteur. Nous vous recommandons d'utiliser la dernière version recommandée.

    Cible de déploiement

    La file d'attente de ressources pour le déploiement. Pour plus d'informations, consultez Gérer une file d'attente de ressources.

    Type de déploiement

    Le type de tâche à déployer. Sélectionnez Python.

    URI Python

    L'URI du fichier de tâche Python, qui peut être un fichier .py ou .zip.

    Module d'entrée

    Le module d'entrée à exécuter.

    • Non requis pour les fichiers .py.

    • Requis pour les fichiers .zip.

    Arguments principaux du point d'entrée

    Saisissez les arguments d'entrée à transmettre à la méthode principale.

    Bibliothèques Python

    Packages Python tiers. Ces packages sont ajoutés au PYTHONPATH du processus worker Python, ce qui les rend directement accessibles dans les fonctions définies par l'utilisateur Python. Pour savoir comment utiliser les packages Python tiers, consultez Utiliser des packages Python tiers.

    Archives Python

    Fichiers d'archive. Pour plus d'informations, consultez Utiliser un environnement virtuel Python personnalisé et Utiliser des fichiers de données.

    Dépendances supplémentaires

    Saisissez le chemin OSS ou l'URL des fichiers de dépendance supplémentaires.

    Assurez-vous d'avoir téléchargé les fichiers de dépendance pertinents dans Artifacts de la console de développement ou dans un bucket OSS lié, et d'avoir obtenu le chemin correspondant.

    Description

    Facultatif. Saisissez une description pour la tâche.

  • Resources : pour plus d'informations sur les paramètres de ressources des tâches, consultez Configurer les ressources des tâches.

  • Parameters : pour plus d'informations sur les paramètres d'exécution des tâches, consultez Configurer les paramètres d'exécution.

Étape 3 : Déployer la tâche

Une fois le développement ou la configuration de la tâche terminé, cliquez sur Create en bas pour déployer une nouvelle tâche, ou cliquez sur Update pour mettre à jour et déployer une tâche locale existante.

Pour les tâches SQL, l'extension valide le script SQL, le plan de ressources et les autres configurations, puis affiche les résultats de la validation.

Étape 4 : Démarrer la tâche

Pour une tâche déployée, le dernier statut s'affiche dans le coin supérieur droit. Vous pouvez cliquer sur Start et sélectionner un mode de démarrage. Pour plus d'informations sur les modes de démarrage, consultez Démarrer une tâche.

Étape 5 : Exploitation et maintenance (O&M) des tâches

Une fois la tâche déployée et en cours d'exécution, un statut vert RUNNING apparaît dans la barre d'action en haut de l'éditeur. La zone Basic affiche les informations clés du déploiement dans un tableau, notamment l'ID de déploiement, le nom du déploiement, le mode d'exécution, la version du moteur (par exemple, vvr-8.0.7-flink-1.17), la cible de déploiement et le type de déploiement.

  • Open Online : cliquez sur Open Online pour ouvrir la page d'O&M des tâches dans la console de développement, où vous pouvez consulter le statut d'exécution et effectuer des opérations d'O&M.

  • Synchronize : extrait la configuration de la tâche depuis le cloud. Cliquer sur Synchronize ouvre un aperçu de la configuration en ligne. Remarque : l'aperçu n'inclut pas les modifications brouillon apportées aux tâches SQL dans la console. Cliquez sur Accept pour écraser votre fichier local avec la configuration en ligne.

  • Cancel : arrête la tâche en cours d'exécution.

Documentation connexe