사용자 정의 애플리케이션 개발 develop

사용자 정의 응용 프로그램 개발을 시작하기 전에:

사용자 정의 애플리케이션 만들기 create-custom-application

로컬에 Adobe aio-cli가 설치되어 있는지 확인하십시오.

사용자 지정 응용 프로그램에 대한 예제와 아이디어는 사용자 지정 응용 프로그램 예제를 참조하십시오.

자격 증명 추가 add-credentials

애플리케이션을 생성할 때 로그인하면 대부분의 App Builder 자격 증명이 ENV 파일에 수집됩니다. 그러나 개발자 도구를 사용하려면 추가 자격 증명이 필요합니다.

개발자 도구 저장소 자격 증명 developer-tool-credentials

개발자가 Asset Compute service을(를) 사용하여 사용자 지정 앱을 평가하는 도구를 사용하려면 클라우드 저장소 컨테이너를 사용해야 합니다. 이 컨테이너는 테스트 파일을 저장하고 앱에서 생성된 렌디션의 수신 및 프레젠테이션에 필수적입니다.

지원되는 클라우드 저장소 컨테이너에 액세스할 수 있어야 합니다. 이 컨테이너는 필요할 때마다 다양한 개발자가 다른 프로젝트에 일괄적으로 사용합니다.

ENV 파일에 자격 증명 추가 add-credentials-env-file

.env 파일에 개발 도구에 대한 후속 자격 증명을 삽입합니다. 파일은 App Builder 프로젝트의 루트에 있습니다.

애플리케이션 실행 run-custom-application

asset compute 개발자 도구를 사용하여 응용 프로그램을 실행하기 전에 자격 증명을 올바르게 구성하십시오.

응용 프로그램을 개발자 도구에서 실행하려면 aio app run 명령을 사용합니다. 작업을 Adobe I/O Runtime에 배포하고 로컬 컴퓨터에서 개발 도구를 시작합니다. 이 도구는 개발 중에 애플리케이션 요청을 테스트하는 데 사용됩니다. 다음은 렌디션 요청의 예입니다.

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

응용 프로그램을 테스트하고 디버깅하는 방법은 여기를 참조하세요. 사용자 지정 응용 프로그램 개발을 마치면 사용자 지정 응용 프로그램을 배포합니다.

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(으)로 설정하여 사용할 수 있습니다.

다른 Adobe API 액세스 access-adobe-apis

설정에서 만든 Asset Compute 콘솔 작업 영역에 API 서비스를 추가합니다. 이러한 서비스는 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.yml의 inputs 내에서 기본 매개 변수를 설정합니다.

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

응용 프로그램이 I/O Runtime Adobe의 컨테이너에서 manifest.yml을(를) 통해 구성할 수 있는 limits을(를) 사용하여 실행됩니다.

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

asset compute 애플리케이션에서 수행하는 광범위한 처리로 인해 최적의 성능(바이너리 자산을 처리할 수 있을 만큼 큼)과 효율성(사용하지 않는 컨테이너 메모리로 인해 리소스를 낭비하지 않음)을 위해 이러한 제한을 조정해야 합니다.

런타임의 작업에 대한 기본 시간 제한은 1분이지만 timeout 제한(밀리초)을 설정하여 늘릴 수 있습니다. 더 큰 파일을 처리해야 하는 경우에는 이 시간을 늘립니다. 소스를 다운로드하고 파일을 처리하며 렌디션을 업로드하는 데 소요되는 총 시간을 고려합니다. 작업이 시간 초과된 경우, 즉 지정된 시간 제한 전에 활성화를 반환하지 않으면 런타임에서 컨테이너를 폐기하고 재사용하지 않습니다.

기본적으로 asset compute 애플리케이션은 네트워크 및 디스크 입력 또는 출력 바인딩되는 경향이 있습니다. 소스 파일을 먼저 다운로드해야 합니다. 처리는 리소스를 많이 사용하므로 결과 렌디션이 다시 업로드되는 경우가 많습니다.

memorySize 매개 변수를 사용하여 작업 컨테이너에 할당된 메모리를 MB로 지정할 수 있습니다. 현재 이 매개 변수는 또한 컨테이너에 액세스하는 CPU 양을 정의하며, 가장 중요한 것은 런타임 사용 비용의 주요 요소입니다(컨테이너가 클수록 더 많은 비용). 처리에서 더 많은 메모리 또는 CPU가 필요한 경우 여기에 더 큰 값을 사용하십시오. 그러나 컨테이너가 클수록 전체 처리량이 감소하므로 리소스를 낭비하지 않도록 주의하십시오.

또한 concurrency 설정을 사용하여 컨테이너 내에서 작업 동시성을 제어할 수 있습니다. 이 설정은 단일 컨테이너(동일한 작업)가 받는 동시 활성화 수입니다. 이 모델에서 작업 컨테이너는 해당 제한까지 여러 동시 요청을 수신하는 Node.js 서버와 같습니다. 런타임의 기본값 memorySize이(가) 200MB로 설정되어 더 작은 App Builder 작업에 적합합니다. asset compute 애플리케이션의 경우, 이 기본값은 더 무거운 로컬 처리 및 디스크 사용으로 인해 과도할 수 있습니다. 일부 응용 프로그램은 구현에 따라 동시 활동에서 잘 작동하지 않을 수도 있습니다. asset compute SDK를 사용하면 파일을 다른 고유 폴더에 작성하여 활성화를 구분할 수 있습니다.

응용 프로그램을 테스트하여 concurrency 및 memorySize에 대한 최적의 숫자를 찾습니다. 컨테이너가 크면 = 메모리 제한이 클수록 더 많은 동시성을 허용할 수 있지만 더 낮은 트래픽에 낭비될 수도 있습니다.