Tous les produits
Search
Centre de documentation

:Annexe : Bibliothèque d'exemples DataWorks Open Platform

Dernière mise à jour :Aug 10, 2026

DataWorks Open Platform propose des exemples de code pour divers scénarios d'application afin de vous aider à mieux comprendre et utiliser les différentes fonctionnalités d'Open Platform, telles que OpenAPI, OpenEvent et Extensions. Cette rubrique explique comment exécuter le code d'exemple téléchargé depuis GitHub sur votre machine locale pour illustrer les capacités d'ouverture de DataWorks dans différents contextes métier.

Contexte

DataWorks Open Platform propose les modules OpenAPI, OpenEvent et Extensions. Utilisez ces modules pour intégrer DataWorks à vos applications et vous abonner aux messages d'événements. Ils facilitent l'interconnexion de vos systèmes applicatifs avec DataWorks pour le contrôle des flux de données, la gouvernance des données ainsi que l'exploitation et la maintenance (O&M) des données. Grâce à ces modules, vous pouvez également réagir rapidement aux changements d'état métier de vos différents systèmes applicatifs. Pour plus d'informations sur Open Platform, consultez la rubrique Présentation.

Initialisation du projet

Étape 1 : Préparer l'environnement de développement

  1. Installez le Java Development Kit (JDK).

    Pour installer le JDK, rendez-vous sur le site officiel d'Oracle et téléchargez la version du JDK compatible avec votre système d'exploitation.

    Remarque

    Dans cet exemple, la version du JDK doit être Java 1.8 ou ultérieure. Une fois l'installation terminée, ouvrez l'invite de commande ou un terminal, puis exécutez la commande java -version pour vérifier la version de Java.

  2. Installez Maven.

    Maven est un outil de gestion de projet Java. Rendez-vous sur le site officiel de Maven et téléchargez le package compatible avec votre système d'exploitation. Après le téléchargement, suivez les instructions de la page Installing Apache Maven pour décompresser le package et installer Maven.

  3. Installez Node.js.

    Cet exemple utilise une interface frontend. Vous devez donc installer l'environnement Node.js sur le client pour exécuter le code JavaScript. Pour installer l'environnement Node.js, rendez-vous sur le site officiel de Node.js et téléchargez l'environnement approprié.

    Remarque

    Dans cet exemple, la version de Node.js doit être supérieure à 14. Une fois l'installation terminée, ouvrez l'invite de commande ou un terminal, puis exécutez la commande node --version pour vérifier la version de Node.js.

  4. Installez pnpm.

    pnpm est un gestionnaire de packages pour les projets JavaScript. Dans cet exemple, la bibliothèque d'exemples utilise le mode workspace pour éviter l'envoi des composants courants vers npm. Vous devez donc installer pnpm. Cliquez sur Installation pour installer l'outil pnpm. Si Node.js est déjà installé, exécutez la commande suivante pour installer pnpm :

    npm install -g pnpm
  5. Vérifiez l'environnement de développement.

    Après avoir effectué les étapes précédentes, exécutez les commandes suivantes pour vérifier que les environnements requis pour cet exemple sont bien installés :

    java -version // If JDK is installed, the command output shows the JDK version. Otherwise, the "command not found" error is reported. 
    mvn -v // If Maven is installed, the command output shows the Maven version. Otherwise, the "command not found" error is reported. 
    npm -v // If Node.js is installed, the command output shows the Node.js version. Otherwise, the "command not found" error is reported. 
    pnpm -v // If pnpm is installed, the command output shows the pnpm version. Otherwise, the "command not found" error is reported.

Étape 2 : Exécuter le code d'exemple

  1. Installez les dépendances.

    Une fois l'environnement de développement prêt, téléchargez le projet d'exemple sur votre machine locale et exécutez le code suivant pour installer les dépendances :

    pnpm install
  2. Saisissez votre AccessKey ID et votre AccessKey secret.

    Une fois l'installation terminée, localisez le fichier de configuration application.properties dans le répertoire racine. Dans ce fichier, spécifiez les informations clés telles que l'Access Key (AK), la Secret Key (SK), le Region-id et l'endpoint. Ces informations seront lues et synchronisées avec chaque application d'exemple au démarrage du projet.

    Remarque

    Lors de l'exécution du projet, les informations clés spécifiées dans le fichier de configuration sont utilisées pour se connecter aux modules de DataWorks Open Platform.

    ## The AccessKey ID of a RAM user.
    api.access-key-id={access-key}
    
    ## The AccessKey secret of a RAM user.
    api.access-key-secret={secret-key}
    
    ## The ID of the region where the DataWorks service is deployed. Sample values: cn-shanghai and cn-hangzhou.
    # api.region-id=cn-hangzhou
    api.region-id={regionId}
    
    ## The service of DataWorks API operations. The default value is dataworks-public.
    api.product=dataworks-public
    
    ## The endpoint of DataWorks OpenAPI.
    ## If DataWorks OpenAPI is accessed over the Internet, the endpoint is in the format of dataworks.${regionId}.aliyuncs.com. By default, DataWorks OpenAPI is accessed over the Internet.
    ## If DataWorks OpenAPI is accessed over a virtual private cloud (VPC), the endpoint is in the format of dataworks-vpc.${regionId}.aliyuncs.com.
    # api.endpoint=dataworks.cn-hangzhou.aliyuncs.com
    api.endpoint={endpoint}
    
    ## Specify the network environment. For access over the Internet, set the parameter to false. For access over a VPC, set the parameter to true.
    api.vpc-env=false
  3. Exécutez le code d'exemple.

    Une fois les configurations précédentes effectuées, exécutez les commandes suivantes pour lancer le code d'exemple.

    npm run example:workbench-screen // Execute the sample code for Operation Center.
    npm run example:meta-api // Execute the sample code for metadata.
    npm run example:event-instance-status // Execute the sample code for subscribing to the status change events of an auto triggered node instance.
    npm run example:extension-maxpt // Execute the sample code for prohibiting the use of the MAX_PT function.
    npm run example:extension-deploy-control // Execute the sample code for configuring the settings in DataWorks Open Platform to perform a lockdown.
  4. Consultez le résultat de l'exécution.

    Après l'exécution du code, visualisez les résultats dans un navigateur web.

    • Pour un exemple disposant d'une interface frontend interactive, accédez à la page via l'URL suivante :

      https://localhost:8080
    • Pour un exemple backend uniquement, accédez au backend via l'URL suivante :

      http://localhost:8008

Obtenir le code d'exemple pour un scénario d'application

Vous pouvez obtenir du code d'exemple pour les scénarios suivants depuis la bibliothèque d'exemples Open Platform :