全部产品
Search
文档中心

:Lampiran: Perpustakaan kode contoh platform terbuka DataWorks

更新时间:Jul 06, 2025

DataWorks Open Platform menyediakan kode contoh untuk berbagai skenario aplikasi guna membantu Anda memahami dan menggunakan fitur-fiturnya seperti OpenAPI, OpenEvent, dan Extensions. Topik ini menjelaskan cara mengeksekusi kode contoh yang diperoleh dari GitHub di mesin lokal Anda untuk menunjukkan kemampuan keterbukaan DataWorks dalam berbagai skenario bisnis.

Informasi latar belakang

DataWorks Open Platform mencakup modul OpenAPI, OpenEvent, dan Extensions. Modul-modul ini memungkinkan integrasi DataWorks dengan aplikasi Anda serta langganan pesan peristiwa. Dengan modul-modul tersebut, Anda dapat menghubungkan berbagai sistem aplikasi ke DataWorks untuk kontrol proses data, tata kelola data, dan operasi & pemeliharaan data. Selain itu, Anda dapat merespons perubahan status bisnis dari berbagai sistem aplikasi secara real-time. Untuk informasi lebih lanjut tentang Open Platform, lihat Ikhtisar.

Inisialisasi proyek

Langkah 1: Siapkan lingkungan pengembangan

  1. Instal Java Development Kit (JDK).

    Untuk menginstal JDK, kunjungi situs resmi Oracle dan unduh versi JDK yang kompatibel dengan sistem operasi Anda.

    Catatan

    Dalam contoh ini, versi JDK harus Java 1.8 atau lebih baru. Setelah instalasi selesai, buka Command Prompt atau terminal dan jalankan perintah java -version untuk memeriksa versi Java.

  2. Instal Maven.

    Maven adalah alat lingkungan runtime Java. Anda dapat mengunjungi situs resmi Maven dan mengunduh paket Maven yang sesuai dengan sistem operasi Anda. Setelah pengunduhan selesai, rujuk ke Installing Apache Maven untuk mengekstrak paket dan menginstal Maven.

  3. Instal Node.js.

    Dalam contoh ini, halaman frontend digunakan. Oleh karena itu, Anda harus menginstal lingkungan Node.js di klien untuk mengeksekusi kode JavaScript. Untuk menginstal lingkungan Node.js, kunjungi situs resmi Node.js dan unduh versi Node.js yang sesuai.

    Catatan

    Dalam contoh ini, versi Node.js harus lebih baru dari 14. Setelah instalasi selesai, buka Command Prompt atau terminal dan jalankan perintah node --version untuk memeriksa versi Node.js.

  4. Instal pnpm.

    pnpm adalah alat manajemen paket untuk proyek JavaScript. Dalam contoh ini, basis kode contoh menggunakan mode workspace untuk mencegah komponen umum dikirim ke npm. Oleh karena itu, Anda harus menginstal pnpm. Anda dapat mengunjungi Installation untuk menginstal alat pnpm. Jika Anda sudah menginstal Node.js, Anda dapat menjalankan perintah berikut untuk menginstal pnpm:

    npm install -g pnpm
  5. Periksa lingkungan pengembangan.

    Setelah menyelesaikan sublangkah sebelumnya, jalankan perintah berikut untuk memeriksa apakah lingkungan yang diperlukan telah diinstal:

    java -version // Jika JDK diinstal, output perintah menunjukkan versi JDK. Jika tidak, kesalahan "command not found" dilaporkan. 
    mvn -v // Jika Maven diinstal, output perintah menunjukkan versi Maven. Jika tidak, kesalahan "command not found" dilaporkan. 
    npm -v // Jika Node.js diinstal, output perintah menunjukkan versi Node.js. Jika tidak, kesalahan "command not found" dilaporkan. 
    pnpm -v // Jika pnpm diinstal, output perintah menunjukkan versi pnpm. Jika tidak, kesalahan "command not found" dilaporkan.

Langkah 2: Eksekusi kode contoh

  1. Instal dependensi.

    Setelah menyiapkan lingkungan pengembangan, unduh proyek contoh ke mesin lokal Anda dan jalankan kode berikut untuk menginstal dependensi:

    pnpm install
  2. Masukkan ID AccessKey dan Rahasia AccessKey Anda.

    Setelah instalasi selesai, temukan file konfigurasi application.properties di direktori root. Dalam file konfigurasi, tentukan informasi kunci seperti Access Key (AK), Secret Key (SK), Region-id, dan titik akhir. Informasi ini akan dibaca dan disinkronkan ke setiap aplikasi contoh saat proyek dimulai.

    Catatan

    Saat menjalankan proyek, informasi kunci yang Anda tentukan dalam file konfigurasi digunakan untuk terhubung ke modul-modul DataWorks Open Platform.

    ## ID AccessKey pengguna RAM.
    api.access-key-id={access-key}
    
    ## Rahasia AccessKey pengguna RAM.
    api.access-key-secret={secret-key}
    
    ## ID wilayah tempat layanan DataWorks diterapkan. Contoh nilai: cn-shanghai dan cn-hangzhou.
    # api.region-id=cn-hangzhou
    api.region-id={regionId}
    
    ## Layanan Operasi API DataWorks. Nilai default adalah dataworks-public.
    api.product=dataworks-public
    
    ## Titik akhir DataWorks OpenAPI.
    ## Jika DataWorks OpenAPI diakses melalui Internet, titik akhirnya dalam format dataworks.${regionId}.aliyuncs.com. Secara default, DataWorks OpenAPI diakses melalui Internet.
    ## Jika DataWorks OpenAPI diakses melalui virtual private cloud (VPC), titik akhirnya dalam format dataworks-vpc.${regionId}.aliyuncs.com.
    # api.endpoint=dataworks.cn-hangzhou.aliyuncs.com
    api.endpoint={endpoint}
    
    ## Tentukan lingkungan jaringan. Untuk akses melalui Internet, atur parameter ke false. Untuk akses melalui VPC, atur parameter ke true.
    api.vpc-env=false
  3. Eksekusi kode contoh.

    Setelah menyelesaikan konfigurasi di atas, jalankan perintah berikut untuk mengeksekusi kode contoh:

    npm run example:workbench-screen // Eksekusi kode contoh untuk Pusat Operasi.
    npm run example:meta-api // Eksekusi kode contoh untuk metadata.
    npm run example:event-instance-status // Eksekusi kode contoh untuk berlangganan peristiwa perubahan status instance node yang dipicu otomatis.
    npm run example:extension-maxpt // Eksekusi kode contoh untuk melarang penggunaan fungsi MAX_PT.
    npm run example:extension-deploy-control // Eksekusi kode contoh untuk mengonfigurasi pengaturan di DataWorks Open Platform untuk melakukan lockdown.
  4. Lihat hasil eksekusi.

    Setelah kode dieksekusi, Anda dapat melihat hasilnya di browser web.

    • Untuk contoh yang memiliki halaman frontend interaktif, akses halaman menggunakan URL berikut:

      https://localhost:8080
    • Untuk contoh hanya backend, akses backend menggunakan URL berikut:

      http://localhost:8008

Dapatkan kode contoh untuk skenario aplikasi

Anda dapat memperoleh kode contoh untuk skenario berikut dari perpustakaan kode contoh platform terbuka: