• 背景情况
• 命令行
• 使用量
  • 安装
  • 要求模块
  • 上传文件
    • 支持的选项
      • 直接二进制上传选项
      • 上传文件选项
    • 处理错误
    • 上传事件
      • 上传会话数据
      • 文件夹事件数据
      • 文件事件数据
      • 文件进度事件数据
      • 文件出错事件数据
      • 错误事件数据
  • 上传本地文件
    • 支持的文件选项
  • 日志
  • 代理支持
• 特征
• 释放
• 捐款
• 许可证发放
• 维护者

背景情况

在 AEM 资产 6.5 和 先前中,向服务器发送一个邮件请求,以管理资产二进制即可上传文件。 可配置更新的 AEM 版本 用于直接上传二进制,这意味着资产二进制不再直接上传到AEM. 因为这样,有一个更复杂的 上传资产二进制时遵循的算法。 此库将检查目标 AEM 实例的配置, 并视配置情况使用直接的二进制上传算法或创建资产服务器 .

提供此工具便于上传, 可以用作命令行可执行文件 或要求作为节点.js模块.

命令行

用于将资产上传到 AEM 实例的命令行工具可作为 Adobe I/O CLI 的插件 。 请 见 插件仓库 更多信息.

使用量

此库支持将文件上传到目标实例,同时为监测提供支持 转让进度、取消转让和其他特性.

安装

这个项目使用 节点 财务报告和审定财务报表 无检查他们是否在当地安装.

它可以像其他任何节点.js模块一样被安装.

$ npm install @adobe/aem-upload

要求模块

要将模块添加到您的 Node.js 项目中:

1. 安装 模块.
2. 需要javascript文件中的模块, 其消耗地点 :

const DirectBinary = require('@adobe/aem-upload');

上传文件

下面是上传文件到目标 AEM 实例所需的最小码量 .

const DirectBinary = require('@adobe/aem-upload');

// URL to the folder in AEM where assets will be uploaded. Folder
// must already exist.
const targetUrl = 'http://localhost:4502/content/dam/target';

// list of all local files that will be uploaded.
const uploadFiles = [
    {
        fileName: 'file1.jpg', // name of the file as it will appear in AEM
        fileSize: 1024, // total size, in bytes, of the file
        filePath: '/Users/me/Documents/my_file.jpg' // Full path to the local file
    },
    {
        fileName: 'file2.jpg',
        fileSize: 512,
        filePath: '/Users/me/Documents/file2.jpg'
    }
];

const upload = new DirectBinary.DirectBinaryUpload();
const options = new DirectBinary.DirectBinaryUploadOptions()
    .withUrl(targetUrl)
    .withUploadFiles(uploadFiles);

// this call will upload the files. The method returns a Promise, which will be resolved
// when all files have uploaded.
upload.uploadFiles(options)
    .then(result => {
        // "result" contains various information about the upload process, including
        // performance metrics and errors that may have occurred for individual files

        // at this point, assuming no errors, there will be two new assets in AEM:
        //  http://localhost:4502/content/dam/target/file1.jpg
        //  http://localhost:4502/content/dam/target/file2.jpg
    })
    .catch(err => {
        // the Promise will reject if something causes the upload process to fail at
        // a high level. Note that individual file failures will NOT trigger this

        // "err" will be an instance of UploadError. See "Error Handling"
        // for more information
    });

支持的选项

直接二进制上传选项

这个 DirectBinaryUploadOptions 类支持以下选项.

上传文件选项

处理错误

如果文件上传失败, 进程会移动到列表中的下一个文件 。 二. 总体进程 只有当灾难发生 阻止它继续发生 上传文件。 由消费者来确定是否有个人文件上传 失败并作出相应反应.

上传过程报告的所有出错都将是 UploadError,这些是 标准日记 Error 额外实例 code 表示的数值 错误类型。 具体代码见 DirectBinary.DirectBinaryUploadErrorCodes。 。 。 .

以下是处理错误的例子,无论是在进程还是文件级别.

const codes = DirectBinary.DirectBinaryUploadErrorCodes;
const upload = new DirectBinary.DirectBinaryUpload();
upload.uploadFiles(options) // assume that options is defined previously
    .then(result => {
        // use this method to retrieve ALL errors during the process
        const { errors = [] } = result;
        errors.forEach(error => {
            if (error.code === codes.ALREADY_EXISTS) {
                // handle case where a file already exists
            }
        });
        const { detailedResult = [] } = result;
        // or retrieve individual file errors
        detailedResult.forEach((fileResult) => {
            const { result = {} } = fileResult;
            const { errors = [] } = result;
            errors.forEach((fileErr) => {
                // content of fileErr may vary
            });
        });
    })
    .catch(err => {
        if (err.code === codes.NOT_SUPPORTED) {
            // handle case where direct binary access is not enabled
            // on the target instance
        }
    });

处理个人文件错误的另一种方式是监听上传进程 活动。 。 。 .

进程执行自动 HTTP 重试处理, 即如果 HTTP 请求失败 然后进程将等待指定的间隔, 并重试相同的 HTTP 请求给定 次数。 如果请求在给定的复试次数后仍然失败,则会 使用最后一个错误将错误报告为正常。 导致重试的任何错误,在 无论是成功还是失败的情景,都将在结果中加以报告 结构.

上传事件

随着上传过程通过单个文件移动,它会随时间推移发送事件 通过文件上传的阶段。 这些事件列举如下.

上传会话数据

文件夹事件数据

文件事件数据

文件进度事件数据

此事件数据包括来自 文件事件数据,加上:

文件出错事件数据

此事件数据包括来自 文件事件数据,加上:

错误事件数据

以下是如何处理各种事件的例子.

const upload = new DirectBinary.DirectBinaryUpload();
upload.on('filestart', data => {
    const { fileName } = data;

    // specific handling that should occur when a file begins uploading
});
upload.on('fileprogress', data => {
    const { fileName, transferred } = data;

    // specific handling that should occur as a file uploads
});
upload.on('fileend', data => {
    const { fileName } = data;

    // specific handling that should occur when a file finishes uploading successfully
});
upload.on('fileerror', data => {
    const { fileName, errors } = data;

    // specific handling that should occur when a file files to upload
});

// assume options has been declared previously
upload.uploadFiles(options);

上传本地文件

库支持上传本地文件和文件夹. 对于文件夹, 工具 将包含文件夹中的所有即时儿童文件。 它不会处理子文件夹, 除非指定“ 深上传” 选项 .

当深度上传时,库会创建目标中的文件夹结构来映射正在上传的文件夹. 新书的标题 创建的文件夹将匹配本地文件系统中存在的文件夹名称 。 目标路径可根据 路径字符限制,并取决于上传中提供的选项(参见“处理文件夹节点名称的功能”) 更多信息.

当图书馆创建新文件夹时,它就会发出 foldercreated 活动。 详情见事件文档.

以下示例说明了如何上传本地文件.

const {
    FileSystemUploadOptions,
    FileSystemUpload
} = require('@adobe/aem-upload');

// configure options to use basic authentication
const credentials = Buffer.from('admin:admin').toString('base64')
const options = new FileSystemUploadOptions()
    .withUrl('http://localhost:4502/content/dam/target-folder')
    .withHttpOptions({
        headers: {
            Authorization: `Basic ${credentials}`
        }
    });

// upload a single asset and all assets in a given folder
const fileUpload = new FileSystemUpload();
await fileUpload.upload(options, [
    '/Users/me/myasset.jpg',
    '/Users/me/myfolder'
]);

支持的文件选项

有一套选择, FileSystemUploadOptions,用于上传本地文件。 临Τ 默认选项,有以下选项.

日志

库会通过上传项目的过程记录各种消息. 它会使用它给定的日志, 只要对象支持方法 debug(), (中文(简体) ), info(), (中文(简体) ), warn(),以及 error()。为了尽可能详细,库中还假定这些方法中的每一方法都能够接受格式化的信息: log.info('message with %s', 'formatting');。无论格式化支持如何,记录都会奏效,但格式化工作正确时会有更多信息.

为图书馆提供记录器,通过 log 选项中的元素 DirectBinaryUpload 建筑师。 以下是一个简单的例子, 可以将所有库的信息记录到 console数字 :

const upload = new DirectBinary.DirectBinaryUpload({
  log: {
    debug: (...theArguments) => console.log.apply(null, theArguments),
    info: (...theArguments) => console.log.apply(null, theArguments),
    warn: (...theArguments) => console.log.apply(null, theArguments),
    error: (...theArguments) => console.log.apply(null, theArguments),
  }
});

请注意,这还将与难民署合作 FileSystemUpload 建筑师.

代理支持

库利用了Fetch API,因此在浏览器中运行时,代理设置会被浏览器检测和应用. 在Node.JS中,所有HTTP请求都直接被发送到目标,而不通过代理. 自动检测系统代理设置在Node.JS中不支持,但 消费者可以使用 DirectBinaryUploadOptions.withHttpOptions() 以证明 agent 建议的数值 node-fetch。 。 。 .

特征

• 良好的调谐,以利用节点,实现最佳上传性能
• 跟踪文件传输进度
• 取消在进行中的转让
• 传输多个“ 批量” 文件
• 上传本地文件夹/文件结构

释放

此模块使用 语义释放 当发布新版本时。 合并后即启动这一进程 master 树枝。 审查语义-释放文件 承诺信息格式.

消息不符合语义发布格式的PR会 没有 生成新版本.

发布注释基于 git 承诺消息生成. 发布注释将出现在 CHANGELOG.md。 。 。 .

捐款

欢迎捐款! 读取 贡献指南 更多信息.

许可证发放

这个项目根据Apache V2许可证获得许可. 见 自由主义 更多信息.

维护者

• @张俊
• @马克·弗里斯贝伊(Mark Frisbey)