Angular CLI + Electron 开发环境搭建


用 @angular/cli 配合 Electron 构建桌面软件开发环境,可以在 Electron 中使用 Angular 的各种特性,使开发桌面软件像开发网站一样简单、快捷,而且可以模块化,紧跟最新技术趋势。

安装 Angular CLI 和 Electron

首先使用 npm 安装 Angular Cli:

1
$ npm i -g @angular/cli

然后安装 Electron

1
$ npm i -g electron

创建项目

用 Angular CLI 创建一个新项目:

1
2
3
$ ng new PROJECT-NAME --style=scss
$ cd PROJECT-NAME
$ npm i

这里选择使用 SCSS 作为 css 预处理器。

构建 Electron 配置

安装本地 Electron 依赖:

1
$ npm i -D electron electron-reload

electron-reload 这个是 electron 的一个可以检测文件变化而实时刷新的包,在配置中配置这个每次文件更改后程序都会实时刷新。

Electron 是使用 index.js 作为入口文件的,可以去网上看相关教程,下面我把我的 index.js 文件贴出来供大家参考:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// index.js
const {
app, // 控制应用生命周期的模块。
BrowserWindow, // 创建原生浏览器窗口的模块
} = require('electron');
require('electron-reload')(__dirname);
// 保持一个对于 window 对象的全局引用,不然,当 JavaScript 被 GC,window 会被自动地关闭
let win;
const createWindow = () => {
// Create the browser window.
win = new BrowserWindow({
width: 1200,
height: 800,
frame: false,
defaultFontSize: 16,
minWidth: 1200,
minHeight: 800,
icon: `file://${__dirname}/dist/assets/icon.png`,
defaultMonospaceFontSize: 16,
defaultEncoding: "utf-8",
webPreferences: {
plugins: true
}
});
// 加载应用的 index.html
win.loadURL(`file://${__dirname}/dist/index.html`);
// 打开开发工具
win.webContents.openDevTools();
// 当 window 被关闭,这个事件会被发出
win.on('closed', () => win = null);
win.on('ready-to-show', () => {
win.show();
win.focus();
})
};
// 当 Electron 完成了初始化并且准备创建浏览器窗口的时候这个方法就被调用
app.on('ready', createWindow);
// 当所有窗口被关闭时,退出程序
app.on('window-all-closed', () => {
// 在 OS X 上,通常用户在明确地按下 Cmd + Q 之前应用会保持活动状态
process.platform !== 'darwin' && app.quit();
});
app.on('activate', () => {
// On OS X it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
win === null && createWindow();
});

因为我们使用 Angular CLI 编译后的文件是输出在 dist 文件夹的,所以我们要配置 loadURL 的地址为 dist 文件夹下的 index.html 文件。同时我们最好将静态文件都放在 src/assets 文件夹下,然后配置在 dist/assets 文件夹下就好了。因为 index.htmlbase 设置的是 /,这是绝对目录,在 election 中需要改成相对路径,<base href="./">

测试

可以在项目文件夹中运行以下命令查看效果了:

1
2
$ ng build --watch true
$ electron ./

这样就可以将项目启动起来了,而且可以实时监测文件的变化刷新软件,很便捷。

一些问题

现在软件基本可以跑起来了,但是在项目中只能使用 Chrome API,Electron 和 Node.js 提供的 API 在项目中并不能使用,因为 @angular/cli 提供的会将这部分代码编译掉,程序就会报错,那怎么办呢?有以下几个方法:

  1. 直接使用 Webpack 构建项目,Webpack 在配置文件中提供了 target 配置项,设置为 electron-renderer 就可以了。

  2. 使用 ng eject 弹出配置文件,然后在 webpack.config.js 中配置 "target": "electron-renderer",可以达到配置 webpack 的效果。

  3. 还有最后一个笨办法,那就是在每个使用 Electron 或 Node.js API 的文件中的顶部都使用 TypeScript 的声明来声明 require,强制不编译 require,方法如下;

1
2
3
4
5
6
7
declare global {
interface Window {
require: any;
}
}

const electron = window.require('electron');

这三种方法都可以实现在 @angular/cli 创建的项目中使用 Electron 或 Node.js API,但都是略麻烦,希望 项目自尽快放开 target 的配置吧。

小尾巴

下面是我最近正在用 Angular4 和 Electron 构建的项目,还没开发完成,希望给新手参考一下,也希望大佬多多指点!

最近尝试着构建了几个小项目,发现框架之类的主要是使用上的差别,重要的还是在大型项目中的数据架构的处理,目前我在使用的数据架构主要有 reduxrxjs,各有千秋,将数据架构与框架结合起来才能实现清晰明了、简单易开发的项目,努力向这个方法加油。

文章目錄
  1. 1. 安装 Angular CLI 和 Electron
  2. 2. 创建项目
  3. 3. 构建 Electron 配置
  4. 4. 测试
  5. 5. 一些问题
  6. 6. 小尾巴
|