开发自定义应用程序 develop
在开始开发自定义应用程序之前:
创建自定义应用程序 create-custom-application
确保在本地安装Adobeaio-cli。
-
要创建自定义应用程序,请创建一个App Builder项目。 为此,请在终端中运行
aio app init <app-name>
。如果您尚未登录,则此命令会提示您使用Adobe ID登录Adobe Developer Console。 有关从cli登录的详细信息,请参阅此处。
Adobe建议您先登录。 如果您遇到问题,请按照中的说明创建应用程序,而不登录。
-
登录后,按照CLI中的提示操作,并选择要用于应用程序的
Organization
、Project
和Workspace
。 选择您在设置环境时创建的项目和工作区。 出现提示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
-
在出现
Which Adobe I/O App features do you want to enable for this project?
提示时,选择Actions
。 请确保取消选择Web Assets
选项,因为Web资产使用不同的身份验证和授权检查。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
-
出现提示
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
-
按照其余提示进行操作,并在Visual Studio代码(或您喜爱的代码编辑器)中打开新的应用程序。 它包含用于自定义应用程序的基架和示例代码。
请在此处阅读App Builder应用程序的主要组件。
模板应用程序利用Adobe的Asset computeSDK来上传、下载和协调应用程序呈现,因此开发人员只需要实施自定义应用程序逻辑。 在
actions/<worker-name>
文件夹中,index.js
文件是添加自定义应用程序代码的位置。
有关自定义应用程序的示例和想法,请参阅自定义应用程序示例。
添加凭据 add-credentials
在创建应用程序时登录时,系统会在ENV文件中收集大多数App Builder凭据。 但是,使用开发人员工具需要其他凭据。
开发人员工具存储凭据 developer-tool-credentials
开发人员使用Asset Compute service评估自定义应用的工具要求使用云存储容器。 此容器对于存储测试文件以及接收和演示应用程序生成的演绎版至关重要。
确保有权访问支持的云存储容器。 此容器由不同的开发人员在必要时共同用于不同的项目。
将凭据添加到环境文件 add-credentials-env-file
将开发工具的后续凭据插入到.env
文件中。 该文件位于App Builder项目的根目录下:
-
将绝对路径添加到在向App Builder项目添加服务时创建的私钥文件:
code language-conf ASSET_COMPUTE_PRIVATE_KEY_FILE_PATH=
-
从Adobe Developer Console下载文件。 转到项目的根目录并单击右上角的“全部下载”。 文件下载时文件名为
<namespace>-<workspace>.json
。 执行下列操作之一:-
将文件重命名为
console.json
,并将其移动到项目的根目录中。 -
或者,您可以向Adobe Developer Console集成JSON文件添加绝对路径。 此文件与在项目工作区中下载的
console.json
文件相同。code language-conf ASSET_COMPUTE_INTEGRATION_FILE_PATH=
-
-
添加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=
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"
}
]
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.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
文件导入环境变量,以及由启动shell设置的变量。 在此示例中,.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 computeSDK通过将文件写入不同的唯一文件夹来确保分隔激活。
测试应用程序以找到concurrency
和memorySize
的最佳数量。 更大的容器=更高的内存限制可能会允许更多的并发性,但也可能对较低的流量造成浪费。