目录

使用ArkWeb下载文件提示完成但文件为何为空

问题现象

使用ArkWeb下载文件时,下载代理提示已下载完成,并且有实际下载内容,但是保存文件时为空。

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { fileUri, picker } from '@kit.CoreFileKit';

@Entry
@Component
struct WebComponent {
  controller: webview.WebviewController = new webview.WebviewController();
  delegate: webview.WebDownloadDelegate = new webview.WebDownloadDelegate();

  build() {
    Column() {
      Button('setDownloadDelegate')
        .onClick(() => {
          // 下载开始前通知给用户,用户需要在此接口中调用WebDownloadItem.start("xxx")并提供下载路径,否则下载会一直处于PENDING状态。
          this.delegate.onBeforeDownload((webDownloadItem: webview.WebDownloadItem) => {
            console.info('EntryAbility: will start a download.');
            const documentSaveOptions = new picker.DocumentSaveOptions();
            documentSaveOptions.newFileNames =
              ['fileName_' + (new Date()).getTime() + '.txt'];
            documentSaveOptions.fileSuffixChoices = ['.txt'];
            let uris: Array<string> = [];
            let documentViewPicker = new picker.DocumentViewPicker();
            documentViewPicker.save(documentSaveOptions).then((documentSaveResult: Array<string>) => {
              uris = documentSaveResult;
              if (0 == uris.length) {
                return;
              }
              console.info(`EntryAbility: documentViewPicker.save to file succeed and uris are:${uris}`);
              webDownloadItem.start(uris[0].toString());
              console.info(`EntryAbility: download to ${uris[0].toString()}`);
            }).catch((err: BusinessError) => {
              console.error(`EntryAbility: Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
            });
          });

          this.controller.setDownloadDelegate(this.delegate);
        });
      Button('startDownload')
        .onClick(() => {
          try {
            this.controller.startDownload('www.example.com');
          } catch (error) {
            console.error(`ErrorCode: ${(error as BusinessError).code},  Message: ${(error as BusinessError).message}`);
          }
        });
      Web({ src: 'www.example.com', controller: this.controller });
    };
  }
}

日志打印下载完成:

实际下载文件为空:

背景知识

问题定位

分析结论

未设置picker选择器配置DocumentSaveOptions的pickerMode时,pickerMode = picker.DocumentPickerMode.DEFAULT,此时选择指定目录,会在目录下生成空文件,适合需要生成文件再进行数据写入的场景。

修改建议

修改picker选择器配置DocumentSaveOptions的pickerMode文档保存选项为picker.DocumentPickerMode.DOWNLOAD,选择器自动返回当前HAP包名的文件夹。修改后代码如下:

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { fileUri, picker } from '@kit.CoreFileKit';

@Entry
@Component
struct WebComponent {
  controller: webview.WebviewController = new webview.WebviewController();
  delegate: webview.WebDownloadDelegate = new webview.WebDownloadDelegate();

  build() {
    Column() {
      Button('setDownloadDelegate')
        .onClick(() => {
          // 下载开始前通知给用户,用户需要在此接口中调用WebDownloadItem.start("xxx")并提供下载路径,否则下载会一直处于PENDING状态。
          this.delegate.onBeforeDownload((webDownloadItem: webview.WebDownloadItem) => {
            console.info('EntryAbility: will start a download.');
            const documentSaveOptions = new picker.DocumentSaveOptions();
            // 修改pickerMode为DOWNLOAD,删除newFileNames和fileSuffixChoices,设置为DOWNLOAD时,配置的参数newFileNames和fileSuffixChoices将不会生效
            documentSaveOptions.pickerMode = picker.DocumentPickerMode.DOWNLOAD;
            let uris: Array<string> = [];
            let documentViewPicker = new picker.DocumentViewPicker();
            documentViewPicker.save(documentSaveOptions).then((documentSaveResult: Array<string>) => {
              // 固定返回当前HAP包名的文件夹
              uris = documentSaveResult;
              if (0 == uris.length) {
                return;
              }
              console.info(`EntryAbility: documentViewPicker.save to file succeed and uris are:${uris}`);

              const uriString = documentSaveResult[0];
              if (!uriString) {
                return;
              }
              // 添加文件路径转换
              const uri = new fileUri.FileUri(uriString);
              webDownloadItem.start(uri.path + '/fileName_' + (new Date()).getTime() + '.txt');
              console.info(`EntryAbility: download to ${uri.path}`);
            }).catch((err: BusinessError) => {
              console.error(`EntryAbility: Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
            });
          });

          this.controller.setDownloadDelegate(this.delegate);
        });
      Button('startDownload')
        .onClick(() => {
          try {
            // 运行时需替换为实际的链接
            this.controller.startDownload('XXX');
          } catch (error) {
            console.error(`ErrorCode: ${(error as BusinessError).code},  Message: ${(error as BusinessError).message}`);
          }
        });
      // 运行时需替换为实际的链接
      Web({ src: 'XXX', controller: this.controller }).fileAccess(false).geolocationAccess(false);
    };
  }
}

总结

使用选择器选择下载路径时,需要注意DocumentSaveOptions的pickerMode选项: