跳至主要内容

下载

Download 对象由页面通过 Page.onDownload(handler) 事件分发。

当浏览器上下文关闭时，所有属于该浏览器上下文的下载文件都会被删除。

下载事件会在下载开始时触发。下载路径将在下载完成后可用。

// Wait for the download to start
Download download = page.waitForDownload(() -> {
    // Perform the action that initiates download
    page.getByText("Download file").click();
});

// Wait for the download process to complete and save the downloaded file somewhere
download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));

方法​

取消​

Added in: v1.13 download.cancel

取消下载。如果下载已完成或已取消，操作不会失败。成功取消后，download.failure()将解析为'canceled'。

用法

Download.cancel();

返回

createReadStream​

Added before v1.9 download.createReadStream

返回一个成功下载的可读流，或在下载失败/取消时抛出异常。

用法

Download.createReadStream();

返回

删除​

Added before v1.9 download.delete

删除已下载的文件。如有必要，将等待下载完成。

用法

Download.delete();

返回

失败​

Added before v1.9 download.failure

如果有下载错误则返回错误信息。必要时会等待下载完成。

用法

Download.failure();

返回

页面​

Added in: v1.12 download.page

获取下载所属的页面。

用法

Download.page();

返回

路径​

Added before v1.9 download.path

对于成功的下载，返回下载文件的路径；对于失败/取消的下载则抛出异常。该方法会在必要时等待下载完成。当远程连接时会抛出异常。

请注意下载的文件名是一个随机GUID，使用Download.suggestedFilename()来获取建议的文件名。

用法

Download.path();

返回

saveAs​

Added before v1.9 download.saveAs

将下载内容复制到用户指定的路径。在下载仍在进行时调用此方法是安全的。如有必要，将等待下载完成。

用法

download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));

参数

  • path Path#

    下载文件应复制到的路径。

返回

建议的文件名​

Added before v1.9 download.suggestedFilename

返回此下载的建议文件名。通常由浏览器根据Content-Disposition响应头或download属性计算得出。详情请参阅whatwg规范。不同浏览器可能采用不同的计算逻辑。

用法

Download.suggestedFilename();

返回

网址​

Added before v1.9 download.url

返回下载的URL。

用法

Download.url();

返回