:Praktik terbaik: Larang fungsi MAX_PT

Langkah 1: Konfigurasikan event bus kustom

1. Masuk ke Konsol EventBridge. Di panel navigasi kiri, klik Event Bus.

2. Klik ikon untuk Create Custom Event Bus.

   1. Pada bagian Event Bus, masukkan Name untuk event bus kustom, lalu klik Next step untuk mengonfigurasi sumber event.

   2. Klik Skip untuk melewati konfigurasi Event Source, Rule, dan Target. Anda juga harus memasukkan Description.

3. Di panel navigasi kiri, klik Event Bus. Temukan event bus yang telah Anda buat dan klik namanya untuk membuka halaman ikhtisar.

   • Di panel navigasi kiri, klik Event Rules, lalu klik Create Rule.

   • Dalam praktik terbaik ini, event bus EventBridge kustom didefinisikan untuk menerima pesan event commit file dan penerapan file dari DataWorks. Contoh berikut menunjukkan pengaturan parameter inti.

     1. Configure basic info: Tentukan nama kustom untuk aturan tersebut.

     2. Configure event pattern.

        • Event Source Type: Pilih Custom Event Source.

        • Event Source: Biarkan tidak dikonfigurasi.

        • Pattern content: Masukkan konten berikut dalam format JSON.

          {
              "source": [
                  "acs.dataworks"
              ],
              "type": [
                  "dataworks:FileChange:CommitFile",
                  "dataworks:FileChange:DeployFile"
              ]
          }

          • source: Menentukan identifier nama produk event, yaitu acs.dataworks.

          • type: Menentukan identifier jenis event untuk produk tersebut. Atur parameter ini ke dataworks:FileChange:CommitFile dan dataworks:FileChange:DeployFile.

        • Event pattern debugging: Ubah nilai source dan type, lalu uji event tersebut. Jika pengujian berhasil, klik Next Step. Klik Test untuk memverifikasi apakah event kustom sesuai dengan pola. Jika pengujian lolos, halaman akan menampilkan pesan bahwa kecocokan berhasil dan event dapat dipicu.

     3. Configure targets.

        • Service Type: Pilih HTTPS atau HTTP. Untuk informasi lebih lanjut tentang jenis layanan, lihat Kelola aturan event.

        • URL: Masukkan URL untuk menerima pesan dari event bus kustom. Misalnya, masukkan https://server_address:port_number/extensions/consumer.

        • Body: Pilih Complete Event.

        • Network Type: Pilih Public Network.

Langkah 2: Konfigurasikan saluran distribusi event

1. Masuk ke Konsol DataWorks. Di wilayah target, klik More > Open Platform di panel navigasi kiri. Klik Go to Open Platform untuk membuka halaman Developer Backend.

2. Di halaman Developer Backend, klik OpenEvent di panel navigasi kiri. Di halaman yang muncul, klik Add Event Distribution Channel dan konfigurasikan parameter dalam dialog tersebut.

   • Workspace for Distribution of Event Messages: Pilih ruang kerja yang telah Anda buat.

   • Specify Custom Event Bus in EventBridge for Distribution of Event Messages: Pilih event bus yang telah Anda buat di Langkah 1.

3. Setelah menyimpan saluran distribusi event, temukan saluran tersebut dan klik Enable di kolom Operation untuk mengaktifkannya.

Langkah 3: Daftarkan dan konfigurasikan ekstensi

1. Masuk ke Konsol DataWorks. Di wilayah target, klik More > Open Platform di panel navigasi kiri. Klik Go to Open Platform untuk membuka halaman Developer Backend.

2. Di halaman Developer Backend, klik Extension di panel navigasi kiri. Lalu, klik Register Extension dan konfigurasikan parameter dalam dialog tersebut.

   1. Deployment Method: Pilih Deploy based on self-managed service.

   2. Daftarkan ekstensi

      • Extension Name: Masukkan nama kustom.

      • Extension Point Event: Pilih Pre-event for Node Commit dan Pre-event for Node Deployment.

      • Workspace for Testing: Setelah mengonfigurasi parameter ini, Anda dapat menguji ekstensi di ruang kerja yang ditentukan setelah ekstensi dibuat tetapi sebelum diajukan.

      • Parameter Configurations for Extension

        Gunakan parameter ini untuk mengontrol cakupan ekstensi. Di ruang kerja yang ditentukan:

        • Saat node dikomit (Pre-event for Node Commit), pemeriksaan ekstensi tidak dipicu, dan proses commit tidak diblokir.

        • Saat node diterapkan (Pre-event for Node Deployment), pemeriksaan ekstensi dipicu. Jika validasi gagal, proses penerapan diblokir.

        Atur parameter menjadi extension.project.commit-file.disabled=YourProjectId. Ganti YourProjectId dengan ID ruang kerja tempat ekstensi dinonaktifkan untuk event titik ekstensi tertentu.

      • Options for Extension: Gunakan ini untuk menentukan opsi tanggapan untuk validasi yang gagal. Dalam contoh berikut, opsi yang tersedia adalah Alert dan Disable.

        {
          "type":"object",
          "properties":{
            "checkStatus":{
              "type":"number",
              "title":"Check method for MAX_PT function",
              "x-decorator":"FormItem",
              "x-component":"Radio.Group",
              "x-decorator-props":{
                "tooltip":"Description file"
              },
              "x-component-props":{
                "dataSource":[
                  {
                    "value":"WARN",
                    "label":"Alert"
                  },
                  {
                    "value":"FAIL",
                    "label":"Disable"
                  }
                ],
                "mode":"multiple"
              }
            }
          }
        }

3. Setelah menyelesaikan konfigurasi, klik Determine untuk menyimpan ekstensi yang telah didaftarkan.

4. Di kolom Operation untuk ekstensi yang Anda buat, klik Submit untuk memulai proses peninjauan.

   Catatan

   • Ekstensi ditinjau oleh platform DataWorks. Peninjauan biasanya selesai dalam tiga hari kerja.

   • Untuk menguji ekstensi yang Anda buat, Anda harus mengonfigurasi Workspace for Testing.

5. Setelah ekstensi disetujui, klik Publish di kolom Actions.

6. Klik tombol Manage Extensions untuk membuka halaman Management Center > Extension. Pilih ekstensi yang telah Anda buat, aktifkan, lalu klik Settings untuk mengonfigurasi tingkat kontrol penggunaan fungsi MAX_PT di ruang kerja.

Kode contoh

Kode contoh ini memanggil API UpdateIDEEventResult untuk mengembalikan hasil pemrosesan. Kode ini menggunakan parameter messageId dalam API untuk mengambil informasi detail event, memeriksa apakah fungsi terlarang termasuk di dalamnya, lalu mengembalikan hasilnya ke DataWorks menggunakan UpdateIDEEventResult. Untuk informasi lebih lanjut, lihat Kembangkan ekstensi.

Lingkungan build: Java 8 dan tool build Maven.

package com.aliyun.dataworks.demo;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.dataworks.config.Constants;
import com.aliyun.dataworks.config.EventCheckEnum;
import com.aliyun.dataworks.config.ExtensionParamProperties;
import com.aliyun.dataworks.services.DataWorksOpenApiClient;
import com.aliyun.dataworks_public20200518.Client;
import com.aliyun.dataworks_public20200518.models.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author dataworks demo
 */
@RestController
@RequestMapping("/extensions")
public class ExtensionsController {
  @Autowired(required = false)
  private DataWorksOpenApiClient dataWorksOpenApiClient;
  @Autowired
  private ExtensionParamProperties extensionParamProperties;
  /**
   * Menerima pesan yang didorong dari EventBridge.
   *
   * @param jsonParam
   */
  @PostMapping("/consumer")
  public void consumerEventBridge(@RequestBody String jsonParam) {
    JSONObject jsonObj = JSON.parseObject(jsonParam);
    String eventCode = jsonObj.getString(Constants.EVENT_CODE_FILED);
    if (Constants.COMMIT_FILE_EVENT_CODE.equals(eventCode) || Constants.DEPLOY_FILE_EVENT_CODE.equals(eventCode)) {
      // Inisialisasi client.
      Client client = dataWorksOpenApiClient.createClient();
      try {
        // Dapatkan informasi tentang parameter event saat ini.
        String messageId = jsonObj.getString("id");
        JSONObject data = jsonObj.getObject("data", JSONObject.class);
        Long projectId = data.getLong("projectId");
        // Inisialisasi callback event.
        UpdateIDEEventResultRequest updateIDEEventResultRequest = new UpdateIDEEventResultRequest();
        updateIDEEventResultRequest.setMessageId(messageId);
        updateIDEEventResultRequest.setExtensionCode(extensionParamProperties.getExtensionCode());
        // Kueri snapshot data titik ekstensi saat event titik ekstensi dipicu.
        GetIDEEventDetailRequest getIDEEventDetailRequest = new GetIDEEventDetailRequest();
        getIDEEventDetailRequest.setMessageId(messageId);
        getIDEEventDetailRequest.setProjectId(projectId);
        GetIDEEventDetailResponse getIDEEventDetailResponse = client.getIDEEventDetail(getIDEEventDetailRequest);
        String content = getIDEEventDetailResponse.getBody().getEventDetail().getCommittedFile().getContent();
        // Periksa apakah kode berisi fungsi terlarang.
        if (content.contains(Constants.CHECK_CODE)) {
          // Dapatkan konfigurasi opsi ekstensi di ruang kerja.
          GetOptionValueForProjectRequest getOptionValueForProjectRequest = new GetOptionValueForProjectRequest();
          getOptionValueForProjectRequest.setProjectId(String.valueOf(projectId));
          getOptionValueForProjectRequest.setExtensionCode(extensionParamProperties.getExtensionCode());
                  GetOptionValueForProjectResponse getOptionValueForProjectResponse = client.getOptionValueForProject(getOptionValueForProjectRequest);
                  JSONObject jsonObject = JSON.parseObject(getOptionValueForProjectResponse.getBody().getOptionValue());
                  // Catatan: Anda harus mengisi format berdasarkan pengaturan aktual di DataWorks.
                  String checkStatus = jsonObject.getString("checkStatus");
                  updateIDEEventResultRequest.setCheckResult(checkStatus);
                  updateIDEEventResultRequest.setCheckResultTip("Kode berisi fungsi terlarang.");
              } else {// Callback berhasil.
                  updateIDEEventResultRequest.setCheckResult(EventCheckEnum.OK.getCode());
                  updateIDEEventResultRequest.setCheckResultTip(EventCheckEnum.OK.getName());
              }
              // Kirim callback ke DataWorks.
              UpdateIDEEventResultResponse response = client.updateIDEEventResult(updateIDEEventResultRequest);
              // ID unik permintaan, digunakan untuk troubleshooting selanjutnya.
              System.out.println("response:" + response.getBody().getRequestId());
          } catch (Exception e) {
              // Deskripsi error.
              System.out.println("ErrMsg:" + e.getMessage());
          }
      } else {
          System.out.println("Gagal menyaring event lainnya. Periksa langkah konfigurasi.");
      }
  }
}

Langkah verifikasi

1. Di halaman Pengembangan Data, buat node. Di node tersebut, edit kode agar menyertakan fungsi MAX_PT yang dilarang, lalu simpan dan komit node tersebut.

2. Klik tombol Publish. Di halaman Create Deployment Package, terapkan node tersebut secara langsung. Ini akan memicu pemeriksaan ekstensi.

   Catatan

   Sesuai konfigurasi ekstensi, pemeriksaan tidak berlaku untuk event commit file di ruang kerja yang ditentukan. Oleh karena itu, pemeriksaan ekstensi tidak dipicu saat Anda mengkomit node yang berisi fungsi MAX_PT. Pemeriksaan hanya dipicu saat Anda menerapkan node yang berisi fungsi MAX_PT.