Skip to content

说明

v4 重构了框架核心,提供更好的开发体验、加密、ts支持、代码优化、结构调整等。未来几年应该不会有大的改动,推荐升级。

升级指南

  1. 准备,建议开发者新开一个项目分支,来做此次升级,因为有较大改动。
  2. 升级依赖包版本:npm i ee-bin@latest -D && npm i ee-core@latest
  3. 调整配置文件:
    • 删除 项目/electron/config/ 中除 config外的所有文件,该目录仅作为主进程配置文件使用。
    • 在项目中添加 ./cmd/bin.js|build.xxx.json 文件,参照 demo配置
  4. 调整 package.json 配置,参照 package.json
  5. 删除 ./main.js./electron/index.js 文件,添加 ./electron/main.js./electron/preload/xxx.js 共 4 个文件。 参照 demo
  6. 废弃了 ./electron/ 中 addon 功能,业务代码转移到了 ./electron/service/os/ 中。
  7. 去掉所有 controller 代码中的继承构造函数,去掉所有 service 代码中的继承修改导出方式。参照 demo
  8. 废弃了一些不常用 api 和 冗余代码,如果你的项目中使用 ee-core 库导出的 api 无法正常使用,请查阅最新的文档api-v4
  9. 生产环境的 ./data/./log/ 目录,从 系统软件数据目录,移动到了 用户家目录/.软件名/ 目录下,请参照文档数据位置
  10. 主进程与渲染进程通信的频道,由 controller.example.test 改为 controller/example/test, 可在配置文件中更改默认的分隔符,属性:channelSeparator

其它说明

新版本的开发流程,推荐使用以下命令。

bash
# 开发,可在 cmd/bin.js 中启用热重载
npm run dev

# 构建
npm run build

# 预览
npm run start

# 打包
npm run build-xxx