開發自訂應用程式 develop

開始開發自訂應用程式之前:

建立自訂應用程式 create-custom-application

確定已在本機安裝Adobeaio-cli

  1. 若要建立自訂應用程式,請建立App Builder專案。 若要這麼做,請在您的終端機中執行aio app init <app-name>

    如果您尚未登入,這個命令會提示您使用Adobe ID登入Adobe Developer Console。 請參閱這裡以取得有關從cli登入的詳細資訊。

    Adobe建議您先登入。 如果您發生問題,請依照指示建立應用程式而不登入

  2. 登入後,依照CLI中的提示操作,並選取要用於應用程式的OrganizationProjectWorkspace。 選擇您設定您的環境時所建立的專案和工作區。 出現提示Which extension point(s) do you wish to implement ?時,請確定選取DX Asset Compute Worker

    code language-sh
    $ aio app init <app-name>
    Retrieving information from Adobe I/O Console.
    ? Select Org My Adobe Org
    ? Select Project MyAdobe Developer App BuilderProject
    ? Which extension point(s) do you wish to implement ? (Press <space> to select, <a>
    to toggle all, <i> to invert selection)
    ❯◯ DX Experience Cloud SPA
    ◯ DX Asset Compute Worker
    
  3. 當以Which Adobe I/O App features do you want to enable for this project?提示時,請選取Actions。 請務必取消選取Web Assets選項,因為網頁資產使用不同的驗證和授權檢查。

    code language-bash
    ? Which Adobe I/O App features do you want to enable for this project?
    select components to include (Press <space> to select, <a> to toggle all, <i> to invert selection)
    ❯◉ Actions: Deploy Runtime actions
    ◯ Events: Publish to Adobe I/O Events
    ◯ Web Assets: Deploy hosted static assets
    ◯ CI/CD: Include GitHub Actions based workflows for Build, Test and Deploy
    
  4. 出現提示Which type of sample actions do you want to create?時,請確定選取Adobe Asset Compute Worker

    code language-bash
    ? Which type of sample actions do you want to create?
    Select type of actions to generate
    ❯◉ Adobe Asset Compute Worker
    ◯ Generic
    
  5. 依照其餘的提示進行,並在Visual Studio Code (或您喜愛的程式碼編輯器)中開啟新的應用程式。 它包含自訂應用程式的支架和範常式式碼。

    在此處閱讀有關App Builder應用程式🔗的主要元件。

    範本應用程式會利用Adobe的Asset computeSDK來上傳、下載及協調應用程式轉譯,因此開發人員只需要實作自訂應用程式邏輯。 在actions/<worker-name>資料夾中,index.js檔案是新增自訂應用程式程式碼的位置。

請參閱自訂應用程式範例,以取得自訂應用程式的範例和概念。

新增認證 add-credentials

當您在建立應用程式時登入時,系統會在ENV檔案中收集大部份App Builder認證。 不過,使用開發人員工具需要其他認證。

開發人員工具儲存憑證 developer-tool-credentials

開發人員若要使用Asset Compute service評估自訂應用程式,就必須使用雲端儲存容器。 此容器對於儲存測試檔案以及接收和展示應用程式產生的轉譯至關重要。

NOTE
此容器與Adobe Experience Manager的雲端儲存區分開,做為Cloud Service。 它僅適用於使用Asset Compute開發人員工具進行開發和測試。

確定可以存取支援的雲端儲存空間容器。 如有需要,各種開發人員會針對不同的專案集體使用此容器。

新增認證至ENV檔案 add-credentials-env-file

將開發工具的後續認證插入.env檔案。 檔案位於App Builder專案的根目錄:

  1. 將絕對路徑新增至新增服務至App Builder專案時建立的私密金鑰檔案:

    code language-conf
    ASSET_COMPUTE_PRIVATE_KEY_FILE_PATH=
    
    note note
    NOTE
    JWT已過時,無法下載私密金鑰。 在我們更新測試工具時,請注意,使用OAuth建立的自訂背景工作程式可以部署,但devtools無法運作。
  2. 從Adobe Developer Console下載檔案。 前往專案的根目錄,然後按一下右上角的「全部下載」。 檔案下載時檔名為<namespace>-<workspace>.json。 執行下列任一項作業:

    • 將檔案重新命名為console.json,並將其移至專案的根目錄。

    • 或者,您也可以將絕對路徑新增至Adobe Developer Console整合JSON檔案。 此檔案與您專案工作區中下載的console.json檔案相同。

      code language-conf
      ASSET_COMPUTE_INTEGRATION_FILE_PATH=
      
  3. 新增S3或Azure儲存體認證。 您只需要存取一個雲端儲存解決方案。

    code language-conf
    # S3 credentials
    S3_BUCKET=
    AWS_ACCESS_KEY_ID=
    AWS_SECRET_ACCESS_KEY=
    AWS_REGION=
    
    # Azure Storage credentials
    AZURE_STORAGE_ACCOUNT=
    AZURE_STORAGE_KEY=
    AZURE_STORAGE_CONTAINER_NAME=
    
TIP
config.json檔案包含認證。 從您的專案中,將JSON檔案新增至您的.gitignore檔案以防止其共用。 同樣的情況適用於.env.aio檔案。

執行應用程式 run-custom-application

在使用Asset compute開發人員工具執行應用程式之前,請正確設定認證

若要在開發人員工具中執行應用程式,請使用aio app run命令。 它會部署動作以AdobeI/O Runtime,並在您的本機電腦上啟動開發工具。 此工具用於在開發期間測試應用程式請求。 以下是範例轉譯請求:

"renditions": [
    {
        "worker": "https://1234_my_namespace.adobeioruntime.net/api/v1/web/example-custom-worker-master/worker",
        "name": "image.jpg"
    }
]
NOTE
請勿在run命令中使用--local旗標。 無法搭配Asset Compute自訂應用程式和Asset compute開發人員工具使用。 自訂應用程式是由Asset Compute服務呼叫,無法存取在開發人員本機電腦上執行的動作。

請參閱這裡如何測試和偵錯您的應用程式。 當您完成自訂應用程式的開發時,部署您的自訂應用程式

嘗試Adobe提供的範例應用程式 try-sample

以下是自訂應用程式的範例:

範本自訂應用程式 template-custom-application

worker-basic是範本應用程式。 它只會透過複製來源檔案來產生轉譯。 此應用程式的內容是在建立aio應用程式中選擇Adobe Asset Compute時收到的範本。

應用程式檔案worker-basic.js使用asset-compute-sdk來下載來源檔案、協調每個轉譯處理,以及將產生的轉譯上傳回雲端儲存空間。

應用程式程式碼內定義的renditionCallback是執行所有應用程式處理邏輯的位置。 worker-basic中的轉譯回呼只會將來源檔案內容複製到轉譯檔案。

const { worker } = require('@adobe/asset-compute-sdk');
const fs = require('fs').promises;

exports.main = worker(async (source, rendition) => {
    // copy source to rendition to transfer 1:1
    await fs.copyFile(source.path, rendition.path);
});

呼叫外部API call-external-api

在應用程式的程式碼中,您可以進行外部API呼叫,以協助處理應用程式。 以下為叫用外部API的應用程式檔案範例。

exports.main = worker(async function (source, rendition) {

    const response = await fetch('https://adobe.com', {
        method: 'GET',
        Authorization: params.AUTH_KEY
    })
});

例如,worker-animal-pictures使用node-httptransfer資料庫從Wikimedia對靜態URL發出擷取要求。

傳遞自訂引數 pass-custom-parameters

您可以透過轉譯物件傳遞自訂已定義的引數。 可以在rendition指示中的應用程式內參考它們。 以下是轉譯物件的範例:

"renditions": [
    {
        "worker": "https://1234_my_namespace.adobeioruntime.net/api/v1/web/example-custom-worker-master/worker",
        "name": "image.jpg",
        "my-custom-parameter": "my-custom-parameter-value"
    }
]

存取自訂引數之應用程式檔案的範例如下:

exports.main = worker(async function (source, rendition) {

    const customParam = rendition.instructions['my-custom-parameter'];
    console.log('Custom paramter:', customParam);
    // should print out `Custom parameter: "my-custom-parameter-value"`
});

example-worker-animal-pictures傳遞自訂引數animal以決定要從Wikimedia擷取的檔案。

驗證和授權支援 authentication-authorization-support

根據預設,Asset compute自訂應用程式會隨App Builder專案的授權和驗證檢查提供。 在manifest.yml中將require-adobe-auth註解設定為true來啟用。

存取其他AdobeAPI access-adobe-apis

將API服務新增至安裝程式中建立的Asset Compute主控台工作區。 這些服務是Asset Compute Service產生的JWT存取權杖的一部分。 可在應用程式動作params物件中存取權杖和其他認證。

const accessToken = params.auth.accessToken; // JWT token for Technical Account with entitlements from the console workspace to the API service
const clientId = params.auth.clientId; // Technical Account client Id
const orgId = params.auth.orgId; // Experience Cloud Organization

傳遞協力廠商系統的認證 pass-credentials-for-tp

若要處理其他外部服務的認證,請將其傳遞為動作上的預設引數。 傳輸中會自動將資料加密。 如需詳細資訊,請參閱Adobe I/O Runtime開發人員指南中的建立動作。 然後在部署期間使用環境變數設定它們。 這些引數可以在動作內的params物件中存取。

manifest.ymlinputs內設定預設引數:

packages:
  __APP_PACKAGE__:
    actions:
      worker:
        function: 'index.js'
        runtime: 'nodejs:10'
        web: true
        inputs:
           secretKey: $SECRET_KEY
        annotations:
          require-adobe-auth: true

$VAR運算式會從名為VAR的環境變數讀取值。

在開發時,您可以在本機.env檔案中指派值。 原因在於aio會自動從.env檔案匯入環境變數,以及由起始殼層設定的變數。 在此範例中,.env檔案如下所示:

#...
SECRET_KEY=secret-value

對於生產部署,您可以在CI系統中設定環境變數,例如在GitHub動作中使用秘密。 最後,存取應用程式內的預設引數,如下所示:

const key = params.secretKey;

調整應用程式大小 sizing-workers

應用程式在AdobeI/O Runtime的容器中執行,具有限制,可透過manifest.yml設定:

    actions:
      myworker:
        function: /actions/myworker/index.js
        limits:
          timeout: 300000
          memorySize: 512
          concurrency: 1

由於Asset compute應用程式進行了廣泛的處理,您必須調整這些限制以獲得最佳效能(夠大以處理二進位資產)和效率(不會因為未使用的容器記憶體而浪費資源)。

執行階段中動作的預設逾時為一分鐘,但可透過設定timeout限制(以毫秒為單位)來增加逾時。 如果您希望處理較大的檔案,請增加此時間。 考慮下載來源、處理檔案及上傳轉譯所需的總時間。 如果動作逾時,也就是說,它不會在指定的逾時限制之前傳回啟動,執行階段會捨棄容器,不會重複使用容器。

asset compute應用程式本質上往往是網路和磁碟的輸入或輸出繫結。 必須先下載來源檔案。 處理通常需要大量資源,然後才會重新上傳產生的轉譯。

您可以使用memorySize引數指定配置給動作容器的記憶體(MB)。 目前,此引數也會定義容器取得的CPU存取許可權,而最重要的是,這是使用執行階段成本的關鍵元素(容器越大,成本越高)。 當您的處理需要更多記憶體或CPU時,請在此使用較大的值,但請小心不要浪費資源,因為容器越大,整體處理量就越低。

此外,也可以使用concurrency設定控制容器內的動作並行。 此設定是單一容器(相同動作)所取得的並行啟用數。 在此模型中,動作容器就像是Node.js伺服器,可接收多個並行要求,最多可達該限制。 執行階段中的預設memorySize設定為200 MB,適用於較小的App Builder動作。 對於Asset compute應用程式,由於本機處理和磁碟使用量較高,因此此預設值可能過高。 視其實施而定,某些應用程式可能無法順利與並行活動搭配運作。 Asset Compute SDK會將檔案寫入不同的唯一資料夾,藉此確保可分隔啟用專案。

測試應用程式以尋找concurrencymemorySize的最佳數目。 較大的容器=較高的記憶體限制可能會允許更多的並行存取,但也可能對較低的流量造成浪費。

recommendation-more-help
b027be24-3772-44c0-a56d-a4ba23dcb50b