【Electron Playground 系列】文件下载篇

作者:long.woo

文件下载是我们开发中比较常见的业务需求,比如:导出 excel。

web 应用文件下载存在一些局限性,通常是让后端将响应的头信息改成 Content-Disposition: attachment; filename=xxx.pdf,触发浏览器的下载行为。

在 electron 中的下载行为,都会触发 session 的 will-download 事件。在该事件里面可以获取到 downloadItem 对象,通过 downloadItem 对象实现一个简单的文件下载管理器:

1. 如何触发下载

由于 electron 是基于 chromium 实现的,通过调用 webContents 的 downloadURL 方法,相当于调用了 chromium 底层实现的下载,会忽略响应头信息,触发 will-download 事件。

// 触发下载
win.webContents.downloadURL(url)

// 监听 will-download
session.defaultSession.on('will-download', (event, item, webContents) => {})

2. 下载流程

3. 功能设计

实现一个简单的文件下载管理器功能包含:

  • 设置保存路径

  • 暂停/恢复和取消

  • 下载进度

  • 下载速度

  • 下载完成

  • 打开文件和打开文件所在位置

  • 文件图标

  • 下载记录

3.1 设置保存路径

如果没有设置保存路径,electron 会自动弹出系统的保存对话框。不想使用系统的保存对话框,可以使用 setSavePath 方法,当有重名文件时,会直接覆盖下载。

item.setSavePath(path)

为了更好的用户体验,可以让用户自己选择保存位置操作。当点击位置输入框时,渲染进程通过 ipc 与主进程通信,打开系统文件选择对话框。

主进程实现代码:

/**
 * 打开文件选择框
 * @param oldPath - 上一次打开的路径
 */
const openFileDialog = async (oldPath: string = app.getPath('downloads')) => {
  if (!win) return oldPath

  const { canceled, filePaths } = await dialog.showOpenDialog(win, {
    title: '选择保存位置',
    properties: ['openDirectory', 'createDirectory'],
    defaultPath: oldPath,
  })

  return !canceled ? filePaths[0] : oldPath
}

ipcMain.handle('openFileDialog', (event, oldPath?: string) => openFileDialog(oldPath))

渲染进程代码:

const path = await ipcRenderer.invoke('openFileDialog', 'PATH')

3.2 暂停/恢复和取消

拿到 downloadItem 后,暂停、恢复和取消分别调用 pauseresumecancel 方法。当我们要删除列表中正在下载的项,需要先调用 cancel 方法取消下载。

3.3 下载进度

在 DownloadItem 中监听 updated 事件,可以实时获取到已下载的字节数据,来计算下载进度和每秒下载的速度。

// 计算下载进度
const progress = item.getReceivedBytes() / item.getTotalBytes()

在下载的时候,想在 Mac 系统的程序坞和 Windows 系统的任务栏展示下载信息,比如:

  • 下载数:通过 app 的 badgeCount 属性设置,当为 0 时,不会显示。也可以通过 dock 的 setBadge 方法设置,该方法支持的是字符串,如果不要显示,需要设置为 ''。

  • 下载进度:通过窗口的 setProgressBar 方法设置。

由于 Mac 和 Windows 系统差异,下载数仅在 Mac 系统中生效。加上 process.platform === 'darwin' 条件,避免在非 Mac、Linux 系统下出现异常错误。

下载进度(Windows 系统任务栏、Mac 系统程序坞)显示效果:

// mac 程序坞显示下载数:
// 方式一
app.badgeCount = 1
// 方式二
app.dock.setBadge('1')

// mac 程序坞、windows 任务栏显示进度
win.setProgressBar(progress)

3.4 下载速度

由于 downloadItem 没有直接为我们提供方法或属性获取下载速度,需要自己实现。

思路:在 updated 事件里通过 getReceivedBytes 方法拿到本次下载的字节数据减去上一次下载的字节数据。

// 记录上一次下载的字节数据
let prevReceivedBytes = 0

item.on('updated', (e, state) => {
  const receivedBytes = item.getReceivedBytes()
  // 计算每秒下载的速度
  downloadItem.speed = receivedBytes - prevReceivedBytes
  prevReceivedBytes = receivedBytes
})

需要注意的是,updated 事件执行的时间约 500ms 一次。

3.5 下载完成

当一个文件下载完成、中断或者被取消,需要通知渲染进程修改状态,通过监听 downloadItem 的 done 事件。

item.on('done', (e, state) => {
  downloadItem.state = state
  downloadItem.receivedBytes = item.getReceivedBytes()
  downloadItem.lastModifiedTime = item.getLastModifiedTime()

  // 通知渲染进程,更新下载状态
  webContents.send('downloadItemDone', downloadItem)
})

3.6 打开文件和打开文件所在位置

使用 electron 的 shell 模块来实现打开文件(openPath)和打开文件所在位置(showItemInFolder)。

由于 openPath 方法支持返回值 Promise<string>,当不支持打开的文件,系统会有相应的提示,而 showItemInFolder 方法返回值是 void。如果需要更好的用户体验,可使用 nodejs 的 fs 模块,先检查文件是否存在。

import fs from 'fs'

// 打开文件
const openFile = (path: string): boolean => {
  if (!fs.existsSync(path)) return false

  shell.openPath(path)
  return true
}

// 打开文件所在位置
const openFileInFolder = (path: string): boolean => {
  if (!fs.existsSync(path)) return false

  shell.showItemInFolder(path)
  return true
}

3.7 文件图标

很方便的是使用 app 模块的 getFileIcon 方法来获取系统关联的文件图标,返回的是 Promise<NativeImage> 类型,我们可以用 toDataURL 方法转换成 base64,不需要我们去处理不同文件类型显示不同的图标。

const getFileIcon = async (path: string) => {
  const iconDefault = './icon_default.png'
  if (!path) Promise.resolve(iconDefault)

  const icon = await app.getFileIcon(path, {
    size: 'normal'
  })

  return icon.toDataURL()
}

3.8 下载记录

随着下载的历史数据越来越多,使用 electron-store 将下载记录保存在本地。


对 Electron 感兴趣?请关注我们的开源项目 Electron Playground,带你极速上手 Electron。

我们每周五会精选一些有意思的文章和消息和大家分享,来掘金关注我们的 晓前端周刊


我们是好未来 · 晓黑板前端技术团队。
我们会经常与大家分享最新最酷的行业技术知识。

(0)

相关推荐

  • Electron 的断点续下载

    最近用 Electron 做了个壁纸程序,需要断点续下载,在这里记录一下. HTTP断点下载相关的报文 Accept-Ranges 告诉客户端服务器是否支持断点续传,服务器返回 Content-Ran ...

  • 如何科学的复制文件路径[Windows]

    @jerrylus 同学在发现频道推荐了老牌工具:Path Copy Copy,听这个名字就是专门用来复制文件路径的 Windows 小工具:路径,复制复制!@Appinn 不过在此之前,有必要回顾下 ...

  • node.js静态资源访问

    node.js静态资源访问

  • webpack 5 带来的全新改变

    安装 webpack-dev-server npm install webpack-dev-server -D 在 webpack配置文件中配置服务: devServer:{ port: 8080, ...

  • python 桌面应用 h5

    进入项目目录需要先在根目录进行创建两个文件,分别为package.json.main.js,这两个文件与你项目的index.html在同一个文件内 package.json内的文件内容 { 'name ...

  • 【Electron Playground 系列】窗口篇

    作者:Kurosaki 本文主要讲解Electron 窗口的 API 和一些在开发之中遇到的问题. 官方文档 虽然比较全面,但是要想开发一个商用级别的桌面应用必须对整个 Electron API  有 ...

  • 战国历史科普系列补充篇——《皓镧传》的原型赵姬究竟是一个什么样的女人?

    刘焕曰:三国历史科普系列完结了,每个系列十篇,从这一期开始,每一期的乱世文章最后都补充一篇,乱世的女人,从神秘的赵姬开始. 魏璎珞 <皓镧传>曾经在荧幕掀起收视热潮,原型赵姬也是一位传奇女 ...

  • 【自传体】退休殇感★心思絮语(散文随笔系列前言篇)

     [自传体]退休殇感★心思絮语(散文随笔系列前言篇)---    作者///桂西老庞说 [内容简介//前言]: 是啊,在我的这一生中,飘零创痕曲折,真的是"我昔自蜀归,百年已过半.观棋未终局 ...

  • 【03】退休殇感★心思絮语(散文随笔系列之三篇)

    [03]退休殇感★心思絮语(散文随笔系列之三篇)--- 作者///桂西老庞说 - 题记:春花秋月何时了,往事知多少:退休的光景里,才知道那些曾经创痕过往,在心思絮语里,形成一行行象形文字所组成的斑痕韵 ...

  • 【04】退休殇感★心思絮语(散文随笔系列之四篇)

    [04]退休殇感★心思絮语(散文随笔系列之四篇)--- 作者///桂西老庞说 - 题记:春花秋月何时了,往事知多少:退休的光景里,才知道那些曾经创痕过往,在心思絮语里,形成一行行象形文字所组成的斑痕韵 ...

  • 技术系列—第二篇

    上一课我们学习了K线的包含关系,现在交易软件上的K线应该都是没有包含关系的K线了.那么我们学习下一步-- 为了形象直观,我们用实物苹果演示一下: 正品字如同山顶的形状 –顶分 倒品字如同山底的形状-底 ...

  • 基本面投资系列第一篇——为什么要做价值投资?

    之前每周的周五.周六都没更新,现在在思考这两天要不要利用起来,写一些除了财报和基金播报之外的文章,现在初步想到的是写一些基本面投资的常识吧,虽然说接触这一块也不是很多年,但是对于很多小白来说,应该会有 ...

  • 基本面投资系列第二篇——财务指标分析是基础

    上周六写了第一篇价值投资的文章,今晚抽空写的第二篇,主要给大家讲一讲价值投资里面最基础的东西--财务指标分析. 我没做过统计,不太清楚多少股民朋友不了解财务指标分析这一投资领域比较基础的知识.可能有些 ...

  • 剑桥艺术史:绘画欣赏 ·13创作水平(本系列末篇)

    13 创作水平 艺术家都要和自己的技能作斗争,他们使用的材料有时很棘手,有时表现出事前不知道的特点.但对艺术家来说,最困难的是如何用颜料.木炭.马赛克或彩色玻璃等把他们想表现的东西按他们观察到的形象丝 ...