Entwickeln eines benutzerdefinierten Programms develop

Bevor Sie mit der Entwicklung eines benutzerdefinierten Programms beginnen:

Erstellen eines benutzerdefinierten Programms create-custom-application

Stellen Sie sicher, dass Adobe aio-cli lokal installiert ist.

Beispiele und Ideen für benutzerdefinierte Programme finden Sie unter Beispiele für benutzerdefinierte Programme.

Hinzufügen von Anmeldeinformationen add-credentials

Bei der Anmeldung während der Erstellung des Programms werden die meisten Anmeldeinformationen von App Builder in Ihrer ENV-Datei gesammelt. Die Verwendung des Entwickler-Tools erfordert jedoch zusätzliche Anmeldeinformationen.

Anmeldeinformationen für die Datenspeicherung des Entwickler-Tools developer-tool-credentials

Das Tool für Entwickelnde zum Auswerten benutzerdefinierter Apps mithilfe des Asset Compute service setzt die Verwendung eines Cloud-Speicher-Containers voraus. Dieser Container ist für die Speicherung von Testdateien sowie für den Empfang und die Darstellung der von den Apps erstellten Ausgabedarstellungen unerlässlich.

Stellen Sie sicher, dass Sie Zugriff auf einen unterstützten Cloud-Speicher-Container haben. Dieser Container wird bei Bedarf von verschiedenen Entwickelnden für verschiedene Projekte gemeinsam verwendet.

Hinzufügen von Anmeldeinformationen zur ENV-Datei add-credentials-env-file

Fügen Sie die nachfolgenden Anmeldeinformationen für das Entwicklungs-Tool in die .env-Datei ein. Die Datei befindet sich im Stammverzeichnis des App Builder-Projekts:

Ausführen des Programms run-custom-application

Bevor Sie die Anwendung mit dem Asset Compute-Entwickler-Tool ausführen, müssen Sie die Anmeldeinformationen ordnungsgemäß konfigurieren.

Um das Programm im Entwickler-Tool auszuführen, verwenden Sie den Befehl aio app run. Die Aktion wird in Adobe I/O Runtime bereitgestellt und das Entwicklungs-Tool wird auf Ihrem lokalen Computer gestartet. Dieses Tool wird zum Testen von Programmanforderungen während der Entwicklung verwendet. Hier finden Sie ein Beispiel für eine Ausgabedarstellungsanforderung:

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

Weitere Informationen zum Testen und Debuggen Ihres Programms finden Sie hier. Wenn Sie mit der Entwicklung Ihres benutzerdefinierten Programms fertig sind, stellen Sie Ihr benutzerdefiniertes Programm bereit.

Testen des von Adobe bereitgestellten Beispielprogramms try-sample

Im Folgenden finden Sie Beispiele für benutzerdefinierte Programme:

Benutzerdefiniertes Vorlagenprogramm template-custom-application

worker-basic ist ein Vorlagenprogramm. Durch einfaches Kopieren der Quelldatei wird eine Ausgabedarstellung generiert. Der Inhalt dieses Programms ist die Vorlage, die Sie bei der Erstellung der aio-App erhalten, wenn Sie Adobe Asset Compute auswählen.

Die Programmdatei worker-basic.js verwendet das asset-compute-sdk, um die Quelldatei herunterzuladen, die jeweilige Ausgabedarstellungsverarbeitung zu koordinieren und die resultierenden Ausgabedarstellungen zurück in den Cloud-Speicher hochzuladen.

In dem im Anwendungs-Code definierten renditionCallback wird die gesamte Anwendungsverarbeitungslogik ausgeführt. Der Ausgabedarstellungs-Callback in worker-basic kopiert einfach den Inhalt der Quelldatei in die Ausgabedarstellungsdatei.

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);
});

Aufrufen einer externen API call-external-api

Im Programm-Code können Sie externe API-Aufrufe durchführen, um die Programmverarbeitung zu unterstützen. Nachfolgend finden Sie ein Beispiel für eine Anwendungsdatei, die eine externe API aufruft.

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

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

Beispielsweise sendet worker-animal-pictures mithilfe der Bibliothek node-httptransfer eine Abrufanfrage an eine statische URL von Wikimedia.

Übergeben benutzerdefinierter Parameter pass-custom-parameters

Sie können benutzerdefinierte Parameter über die Ausgabedarstellungsobjekte übergeben. Sie können innerhalb des Programms in rendition Anweisungen referenziert werden. Hier finden Sie ein Beispiel für ein Ausgabedarstellungsobjekt:

"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"
    }
]

Dies ist ein Beispiel für eine Anwendungsdatei, die auf benutzerdefinierte Parameter zugreift:

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 übergibt einen benutzerdefinierten Parameter animal, um zu bestimmen, welche Datei von Wikimedia abgerufen werden soll.

Unterstützung bei Authentifizierung und Autorisierung authentication-authorization-support

Standardmäßig werden benutzerdefinierte Asset Compute-Anwendungen mit Autorisierungs- und Authentifizierungsprüfungen für das App Builder-Projekt bereitgestellt. Die Aktivierung erfolgt, indem die Anmerkung require-adobe-auth in der Datei manifest.yml auf true gesetzt wird.

Zugriff auf andere Adobe-APIs access-adobe-apis

Fügen Sie die API-Services dem bei der Einrichtung erstellten Asset Compute-Console-Arbeitsbereich hinzu. Diese Services sind Teil des JWT-Zugriffs-Tokens, das von Asset Compute Service erstellt wird. Auf das Token und andere Anmeldeinformationen kann innerhalb des Programmaktionsobjekts params zugegriffen werden.

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

Übergeben von Anmeldeinformationen für Drittanbietersysteme pass-credentials-for-tp

Um Anmeldeinformationen für andere externe Services zu verarbeiten, übergeben Sie diese als Standardparameter für die Aktionen. Sie werden bei der Übertragung automatisch verschlüsselt. Weitere Informationen finden Sie unter „Erstellen von Aktionen“ im Adobe I/O Runtime-Entwicklerhandbuch. Legen Sie sie dann während der Bereitstellung mithilfe von Umgebungsvariablen fest. Auf diese Parameter kann im Objekt params innerhalb der Aktion zugegriffen werden.

Legen Sie die Standardparameter in inputs in der Datei manifest.yml fest:

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

Der Ausdruck $VAR liest den Wert aus einer Umgebungsvariablen mit dem Namen VAR.

Bei der Entwicklung können Sie den Wert in der lokalen .env-Datei zuweisen. Der Grund dafür ist, dass aio Umgebungsvariablen aus .env-Dateien automatisch zusammen mit den von der Initiierungs-Shell festgelegten Variablen importiert. In diesem Beispiel sieht die .env-Datei wie folgt aus:

#...
SECRET_KEY=secret-value

Bei der Produktionsbereitstellung können die Umgebungsvariablen im CI-System festgelegt werden, z. B. mithilfe von Geheimnissen in GitHub-Aktionen. Greifen Sie auf die Standardparameter im Programm als solche zu:

const key = params.secretKey;

Dimensionieren von Programmen sizing-workers

Eine Anwendung wird in einem Container in Adobe I/O Runtime mit Beschränkungen ausgeführt, die über manifest.yml konfiguriert werden können:

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

Aufgrund der umfangreichen Verarbeitung, die von Asset Compute-Anwendungen durchgeführt wird, müssen Sie diese Beschränkungen anpassen, um eine optimale Leistung (groß genug für binäre Assets) und Effizienz (keine Ressourcenverschwendung durch ungenutzten Container-Speicherplatz) zu erzielen.

Der Standard-Timeout für Aktionen in Runtime ist eine Minute, kann jedoch durch Setzen der timeout-Beschränkung (in Millisekunden) erhöht werden. Wenn Sie mit der Verarbeitung größerer Dateien rechnen, erhöhen Sie diese Zeit. Berücksichtigen Sie die Gesamtzeit, die zum Herunterladen der Quelle, zum Verarbeiten der Datei und zum Hochladen der Ausgabedarstellung erforderlich ist. Bei Zeitüberschreitung einer Aktion, wenn also die Aktivierung nicht vor der angegebenen Timeout-Beschränkung zurückgegeben wird, verwirft Runtime den Container und verwendet ihn nicht erneut.

Asset Compute-Anwendungen sind von Natur aus eher an Netzwerk- und Datenträger-E/A-Vorgänge gebunden. Die Quelldatei muss zuerst heruntergeladen werden. Die Verarbeitung ist häufig ressourcenintensiv und die resultierenden Ausgabedarstellungen werden dann erneut hochgeladen.

Mit dem Parameter memorySize können Sie den einem Aktions-Container zugewiesenen Speicher in Megabyte festlegen. Derzeit wird mit diesem Parameter auch definiert, inwieweit der Container CPU-Zugriff erhält. Vor allem ist dies aber ein wichtiger Kostenfaktor bei der Verwendung von Runtime (größere Container kosten mehr). Verwenden Sie hier einen größeren Wert, wenn die Verarbeitung mehr Speicher oder CPU erfordert. Achten Sie aber darauf, keine Ressourcen zu verschwenden, denn je größer der Container, desto geringer der Gesamtdurchsatz.

Darüber hinaus ist es möglich, die Parallelität von Aktionen innerhalb eines Containers mithilfe der Einstellung concurrency zu steuern. Diese Einstellung entspricht der Anzahl der gleichzeitigen Aktivierungen, die ein einzelner Container (derselben Aktion) erhält. In diesem Modell ähnelt der Aktions-Container einem Node.js-Server, der bis zu diesem Grenzwert mehrere gleichzeitige Anfragen empfängt. Die Standardeinstellung memorySize in Runtime ist auf 200 MB eingestellt. Dieser Wert ist ideal für kleinere App Builder-Aktionen. Bei Asset Compute-Anwendungen kann dieser Standardwert aufgrund der stärkeren lokalen Verarbeitung und Festplattenauslastung zu hoch sein. Einige Programme funktionieren je nach Implementierung möglicherweise auch bei gleichzeitigen Aktivitäten nicht gut. Das Asset Compute-SDK stellt sicher, dass Aktivierungen getrennt werden, indem Dateien in verschiedene eindeutige Ordner geschrieben werden.

Testen Sie die Programme, um die optimalen Werte für concurrency und memorySize zu finden. Größere Container (= höhere Speicherbeschränkung) könnten mehr Parallelität ermöglichen, aber bei geringerem Traffic zu unnötigen Ausgaben führen.