npm 包 ele-updater 使用教程

阅读时长 7 分钟读完

前言

对于前端开发者而言,使用网络上的第三方资源是很平常的事了。其中,npm 是前端开发者最为熟悉的包管理工具之一。在使用 npm 的过程中,我们往往需要保证自己所使用的包一直处于最新版本或者是处于一个我们可以接受的版本范围之内。这时候,ele-updater 就派上用场了,它是一个在 Electron 中使用的自动检查更新程序,并且它也是一个 npm 包。下面,我们将详细介绍如何使用 ele-updater。

安装 ele-updater

首先,我们需要安装 ele-updater。在 npm 中,ele-updater 的安装命令很简单:

这条命令可以将 ele-updater 安装在本地,并将其添加到 package.json 中的 dependencies 中。

使用 ele-updater

安装好 ele-updater 后,接下来我们可以开始使用它检查并更新应用了。为了使用 ele-updater,我们需要做以下准备工作:

打包应用程序

ele-updater 需要读取应用程序的 package.json,因此你需要将你的应用程序打包成一个结构相似的文件夹,并确保这个文件夹下拥有一个 package.json 文件和你的应用程序的可执行文件(.exe、.app 或者是 .dmg 等等)。

创建一个更新服务器

ele-updater 没有预先配置好的更新服务器,因此你需要创建一个。推荐使用 electron-updater-api 创建一个基于 Express 的更新服务器。

在这个更新服务器中,你需要提供以下接口:

  • /update/latest 返回请求中的应用程序版本是否是当前最新版本
  • /update/download 提供可下载的应用程序的 URL,应该带上当前版本号

配置 ele-updater

ele-updater 需要一些配置项来使其工作。你需要在你的代码中创建一个 config 对象,并作为 ele-updater 的一个参数进行传递。config 对象的结构如下:

其中,server 是一个对象,指定了更新服务器的 URL 和更新通道的名称。在 ele-updater 中,更新通道被视为标记新版本的属性名称。isPackaged 是一个布尔值,指定是否打包应用程序。

打包后的应用程序与源代码开放的应用程序不同。你需要根据不同的情况设置 dialog 的相关目录路径。因此,当 ele-updater 检查到应用程序从源代码开放变为打包的应用程序时,它需要一个信号来获取正确的 dialog 目录。建议针对 debug 和 production 两种模式设置不同的路径。你可以将路径设置为 proddev,ele-updater 会自动设置 dialog 目录。

引入 ele-updater

在你的代码中,你需要引入 ele-updater 并初始化它。

-- -------------------- ---- -------
----- - ---- ------ - - -------------------
----- - ----------- - - ---------------------------
----- ---- - ---------------
----- - ------ - - -------------------

------------------------------------------------------------------------------

-- ------------------- -
  ----- ------------- - ------
  ------ - -
    -------- ----------------------
    --------------- -----------------------------
    ------------- --------------------------
  -
-

----------------------------------- ------- ------------- ------------ -- -
  ----- ---------- - -
    ----- -------
    -------- -------- ------
    ------ -------
    -------- ---------------- --- ------- - ------------ - ------------
    ------- -------------------
  -

  ----------------------------------------- -------- -- -- -
    -- --------- --- -- --------------------------------- -----
  --
--

--------------- -- -- -
  -----------------------------
--

这样,就可以在你的应用程序启动时自动检查更新,更新的时候会弹出 dialog 要求用户选择是否立即重启应用程序。

示例代码

下面是一份示例代码,你可以参考它使用 ele-updater。

-- -------------------- ---- -------
----- - ---- ------ - - -------------------
----- - ----------- - - ---------------------------
----- ---- - ---------------
----- - ------ - - -------------------

------------------------------------------------------------------------------

-- ------------------- -
  ----- ------------- - ------
  ------ - -
    -------- ----------------------
    --------------- -----------------------------
    ------------- --------------------------
  -
-

----------------------------------- ------- ------------- ------------ -- -
  ----- ---------- - -
    ----- -------
    -------- -------- ------
    ------ -------
    -------- ---------------- --- ------- - ------------ - ------------
    ------- -------------------
  -

  ----------------------------------------- -------- -- -- -
    -- --------- --- -- --------------------------------- -----
  --
--

--------------- -- -- -
  -----------------------------
--

总结

本文介绍了如何使用 ele-updater 来检测和更新 Electron 应用程序。在进行更新之前,你需要对应用程序进行打包,创建一个更新服务器,然后在代码中进行相关的配置和初始化操作。在之后的应用开发过程中,你可以直接使用 ele-updater 来进行应用程序的自动更新,并在更新时弹出 dialog。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cba81e8991b448da442

纠错
反馈