Electron 桌面应用

本章节以 Mac OS X下 Hosts 文件管理 App 为例。

技术栈包含:

  • Electron (仅 OS X 平台)
  • Webpack 2
  • Vue 2
  • Vuex
  • Vue-Router
  • Vue-Material (UI组件)
  • Babel
  • ESLint
  • Yarn(包管理)

初始化项目

  • 安装所需的各种 NPM 包。
  • 引入 ESLint、Babel 配置文件。

配置 Vue2 + Webpack2

需要注意Webpack 2.x.x 版本与 1.x.x 版本发生了不少改动。

可以参考迁移文档: https://webpack.js.org/guides/migrating/ 进行学习。

坑1: extract-text-webpack-plugin

该插件 NPM 最新版本为1.0.1,不支持 Webpack2,所以需要通过安装 RC3 版本来获得对应支持。

yarn add --dev [email protected]
或
npm i --save-dev [email protected]

坑2:babel-plugin-transform-runtime 与 extract-text-webpack-plugin 插件有冲突

会导致 extract-text 插件报错崩溃。

解决方法,修改 .babelrc

{
  "presets": [
    "latest"
  ],
  "plugins": [
    [
      "transform-runtime",
      {
        "helpers": false,
        "polyfill": false,
        "regenerator": true
      }
    ]
  ],
  "compact": true
}

其中 设置compact属性还能阻止 500kb 限制的警告。

坑3:postcss-loader 与 extract-text-webpack-plugin 插件有冲突

目前无解,去掉了postcss-loader的使用。

下一阶段尝试。

坑4:在 Vue 中使用 Electron

首先,需要在 webpack config 中设置:

target: 'electron'

向 Electron 注册插件:

import Vue from 'vue';
import electron from 'electron';

Vue.use({
  install: (vue) => {
    vue.prototype.$electron = electron;
  }
});

前端向 IPC 发送消息:

this.$electron.ipcRenderer.send('resizePreferencesWindow', { width: 400, height: 300 });

Electron 配置

设置 App 开机自启

使用插件:https://github.com/Teamwork/node-auto-launch

import AutoLaunch from 'auto-launch';

const hostsAutoLauncher = new AutoLaunch({
  name: 'Hosts.js',
  path: '/Applications/Hosts.js.app'
});

exports.isEnabled = async () => {
  const result = await hostsAutoLauncher.isEnabled();
  return result;
};

exports.enable = () => {
  hostsAutoLauncher.enable();
};

exports.disable = () => {
  hostsAutoLauncher.disable();
};

添加 Electron Vue DevTools

可以直接通过插件实现,地址:https://github.com/MarshallOfSound/electron-devtools-installer

devtools.js:

import installExtension, { VUEJS_DEVTOOLS } from 'electron-devtools-installer';

module.exports = installExtension(VUEJS_DEVTOOLS);

窗口加载:

if (process.env.NODE_ENV === 'development') {
  // 开发模式加载 devtools
  const devtools = require('../lib/devtools');
  devtools.then(() => { // 注意调用方式
    this.preferencesWindow.loadURL('http://localhost:3000/build/app.html');
  });
} else {
  this.preferencesWindow.loadURL(`file://${path.join(__dirname, '../../build/app.html')}`);
}

设计核心模块

i18n

国际化支持,没有什么难度,根据语言参数找到对应的翻译文件,配置默认语言(英文):

import { readdirSync } from 'fs';

const locales = readdirSync(__dirname);

/*
 try `zh-CN` first
 then `zh`
 or otherwise `default`
 */
module.exports = (lang = 'default') => {
  let locale = locales.filter(x => x.indexOf(lang) !== -1)[0];
  /* eslint import/no-dynamic-require:0,global-require:0 */
  if (locale !== undefined) {
    const file = require(`./${locale}`);
    return file;
  }
  const langPrefix = lang.split('-')[0];
  locale = locales.filter(x => x.indexOf(langPrefix) !== -1)[0];
  if (locale !== undefined) {
    const file = require(`./${locale}`);
    return file;
  }
  const file = require('./default');
  return file;
};

目录结构

.
├── default.js
├── index.js
└── zh-CN.js

如有其它语言,添加对应语言文件即可。

Hosts.js 分级列表

Hosts.js项目源码: https://github.com/js-cool/Hosts.js

特点:

  • 支持顶级项目
  • 支持二级目录项目
  • 目录不含有启动状态,目录下的子项目有
  • 支持排序
[
  {
    name: 'Default',
    order: 2,
    id: 'default',
    type: 'item',
    enabled: true
  },
  {
    namename: 'Folder',
    order: 1,
    id: 'xxx1',
    type: 'folder',
    children: [
      {
        name: 'Sub Item 2',
        order: 2,
        id: 'xxxs2',
        type: 'item',
        enabled: false
      },
      {
        name: 'Sub Item 1',
        order: 1,
        id: 'xxxs1',
        type: 'item',
        enabled: true
      },
      {
        name: 'Sub Item 4',
        order: 4,
        id: 'xxxs4',
        type: 'item',
        enabled: true
      },
      {
        name: 'Sub Item 3',
        order: 3,
        id: 'xxxs3',
        type: 'item',
        enabled: true
      }
    ]
  }
]

排序算法

  1. 对顶级项目进行排序
  2. 对子菜单项目进行排序
const reorderItems = arr => arr.sort((x, y) => x.order - y.order > 0 ? 1 : -1).map((i, iIndex) => {
  i.order = iIndex + 1;
  if (i.type === 'folder') {
    i.children = i.children.sort((x, y) => x.order - y.order > 0 ? 1 : -1).map((j, jIndex) => {
      j.order = jIndex + 1;
      return j;
    });
  }
  return i;
});

删除元素算法

  1. 默认项禁止删除
  2. 编程过程中的异常捕获,实际操作中不会发生
  3. 子菜单超过两个项目禁止删除
const deleteItem = (arr, id, pid = '') => {
  if(id==='default') return false;
  let index;
  if (pid === '') {
    index = arr.findIndex(x => x.id === id);
    // 异常捕获
    if (index === -1) return false;
    // 子菜单超过两个项目禁止删除
    if (typeof arr[index].children === 'object' && arr[index].children.length > 1) return false;
    arr.splice(index, 1);
    return reorderItems(arr);
  }
  index = arr.findIndex(x => x.id === pid);
  // 异常捕获
  if (index === -1) return false;
  arr[index].children = deleteItem(arr[index].children, id);
  return reorderItems(arr);
};

添加元素算法

  1. 不能建立二级目录
  2. 编程过程中的异常捕获,实际操作中不会发生
const uuid = require('uuid');
const insertItem = (arr, name, pid = '', type = 'item') => {
  if (type === 'folder' && pid !== '') return false;
  const item = {
    name,
    type,
    order: -1,
    id: uuid.v4(),
  };
  if (type === 'item') {
    item.enabled = false;
  } else {
    item.children = [];
  }
  if (pid === '') {
    item.order = arr.length;
    arr.push(item);
  } else {
    const index = arr.findIndex(x => x.id === pid);
    // 异常捕获
    if (index === -1) return false;
    item.order = arr[index].length;
    arr[index].children.push(item);
  }
  return reorderItems(arr);
};

位置调整算法

  1. Default 不能移动
  2. 编程过程中的异常捕获,实际操作中不会发生

上移

const moveUpItem = (arrOrigin, id, pid = '') => {
  if (id === 'default') return arrOrigin;
  const arr = reorderItems(arrOrigin);
  let index;
  if (pid === '') {
    index = arr.findIndex(x => x.id === id);
    if (index === -1) return false;
    if (index - 1 === -1) return arr;
    arr[index].order -= 1;
    arr[index - 1].order += 1;
    return arr;
  }
  index = arr.findIndex(x => x.id === pid);
  // 异常捕获
  if (index === -1) return false;
  arr[index].children = moveUpItem(arr[index].children, id);
  return reorderItems(arr);
};

下移

const moveDownItem = (arrOrigin, id, pid = '') => {
  if (id === 'default') return arrOrigin;
  const arr = reorderItems(arrOrigin);
  let index;
  if (pid === '') {
    index = arr.findIndex(x => x.id === id);
    if (index === -1) return false;
    if (index + 1 === arr.length) return arr;
    arr[index].order += 1;
    arr[index + 1].order -= 1;
    return arr;
  }
  index = arr.findIndex(x => x.id === pid);
  // 异常捕获
  if (index === -1) return false;
  arr[index].children = moveUpItem(arr[index].children, id);
  return reorderItems(arr);
};

新增了重命名和切换启用状态的两个方法,不再展开。

优化

  • 以 class 形式封装
  • 抛出简单的外部接口
/* eslint class-methods-use-this: [2, { "exceptMethods": ["_deleteItem","_moveUpItem","_moveDownItem"] }] */

import { existsSync, mkdirSync, writeFileSync, readFileSync } from 'fs';
import uuid from 'uuid';
import locales from '../locales';

module.exports = class Category {
  constructor(lang) {
    this.locale = locales(lang);
    this.DIR_PATH = `${process.env.HOME}/.hosts.js`;
    this.FILE_PATH = `${this.DIR_PATH}/.category.js`;
    this.init();
  }

  init() {
    const defaultData = [{
      name: this.locale.default,
      order: 1,
      id: 'default',
      type: 'item',
      enabled: true
    }];
    if (!existsSync(this.DIR_PATH)) {
      mkdirSync(this.DIR_PATH);
    }
    if (!existsSync(this.FILE_PATH)) {
      this.data = defaultData;
    } else {
      const data = readFileSync(this.FILE_PATH, 'utf-8');
      try {
        this.data = JSON.parse(data);
      } catch (e) {
        this.data = defaultData;
      }
    }
  }

  reorder() {
    this.data = this.data.sort((x, y) => x.order - y.order > 0 ? 1 : -1)
      .map((i, iIndex) => {
        i.order = iIndex + 1;
        if (i.type === 'folder') {
          i.children = i.children.sort((x, y) => x.order - y.order > 0 ? 1 : -1).map((j, jIndex) => {
            j.order = jIndex + 1;
            return j;
          });
        }

        return i;
      });
    return true;
  }

  _deleteItem(arr, id) {
    const index = arr.findIndex(x => x.id === id);
    // 异常捕获
    if (index === -1) return false;
    // 子菜单超过两个项目禁止删除
    if (typeof arr[index].children === 'object' && arr[index].children.length > 1) return false;
    arr.splice(index, 1);
    return arr;
  }

  _moveUpItem(arr, id) {
    const index = arr.findIndex(x => x.id === id);
    if (index === -1) return false;
    if (index - 1 === -1) return false;
    arr[index].order -= 1;
    arr[index - 1].order += 1;
    return arr;
  }

  _moveDownItem(arr, id) {
    const index = arr.findIndex(x => x.id === id);
    if (index === -1) return false;
    if (index + 1 === arr.length) return false;
    arr[index].order += 1;
    arr[index + 1].order -= 1;
    return arr;
  }

  delete(id, pid = '') {
    if (pid === '') {
      const data = this._deleteItem(this.data, id);
      if (data === false) return false;
      this.data = data;
    } else {
      const index = this.data.findIndex(x => x.id === pid);
      // 异常捕获
      if (index === -1) return false;
      const data = this._deleteItem(this.data[index].children, id);
      if (data === false) return false;
      this.data[index].children = data;
    }
    return this.reorder();
  }

  insert(name, pid = '', type = 'item') {
    if (['item', 'folder'].indexOf(type) === -1) return false;
    if (type === 'folder' && pid !== '') return false;
    const item = {
      name,
      type,
      id: uuid.v4()
    };
    if (type === 'item') {
      item.enabled = false;
    } else {
      item.children = [];
    }
    if (pid === '') {
      item.order = this.data.length + 1;
      this.data.push(item);
    } else {
      const index = this.data.findIndex(x => x.id === pid);
      // 异常捕获
      if (index === -1) return false;
      item.order = this.data[index].children.length + 1;
      this.data[index].children.push(item);
    }
    return this.reorder();
  }

  moveUp(id, pid = '') {
    if (id === 'default') return false;
    let index;
    if (pid === '') {
      index = this.data.findIndex(x => x.id === id);
      if (index === 1 || index === -1) return false;
      const data = this._moveUpItem(this.data, id);
      if (data === false) return false;
      this.data = data;
      return this.reorder();
    }
    index = this.data.findIndex(x => x.id === pid);
    // 异常捕获
    if (index === -1) return false;
    const data = this._moveUpItem(this.data[index].children, id);
    if (data === false) return false;
    this.data[index].children = data;
    return this.reorder();
  }

  moveDown(id, pid = '') {
    if (id === 'default') return false;
    if (pid === '') {
      const data = this._moveDownItem(this.data, id);
      if (data === false) return false;
      this.data = data;
      return this.reorder();
    }
    const index = this.data.findIndex(x => x.id === pid);
    // 异常捕获
    if (index === -1) return false;
    const data = this._moveDownItem(this.data[index].children, id);
    if (data === false) return false;
    this.data[index].children = data;
    return this.reorder();
  }

  rename(name, id, pid = '') {
    if (pid === '') {
      const index = this.data.findIndex(x => x.id === id);
      // 异常捕获
      if (index === -1) return false;
      this.data[index].name = name;
    } else {
      const index = this.data.findIndex(x => x.id === pid);
      // 异常捕获
      if (index === -1) return false;
      const indexChildren = this.data[index].children.findIndex(x => x.id === id);
      // 异常捕获
      if (indexChildren === -1) return false;
      this.data[index].children[indexChildren].name = name;
    }
    return this.reorder();
  }

  toggle(id, pid = '') {
    if (id === 'default') return false;
    if (pid === '') {
      const index = this.data.findIndex(x => x.id === id);
      // 异常捕获
      if (index === -1 || !Reflect.has(this.data[index], 'enabled')) return false;
      this.data[index].enabled = !this.data[index].enabled;
    } else {
      const index = this.data.findIndex(x => x.id === pid);
      // 异常捕获
      if (index === -1) return false;
      const indexChildren = this.data[index].children.findIndex(x => x.id === id);
      // 异常捕获
      if (indexChildren === -1) return false;
      this.data[index].children[indexChildren].enabled = !this.data[index].children[indexChildren].enabled;
    }
    return true;
  }

  reload() {
    return this.data;
  }

  save() {
    writeFileSync(this.FILE_PATH, JSON.stringify(this.data, null, 2));
    return true;
  }
};

该文件源码如有更新,在: https://github.com/js-cool/Hosts.js/blob/master/src/lib/category.js 上查看。

Demo

import Category from './category';

const categories = new Category();

// 增加目录:
categories.insert('目录名称', '', 'folder');

// 增加项目:
categories.insert('项目名称');
categories.insert('项目名称', '目录 id');

// 删除项目:
categories.delete('根目录项目 id');
categories.delete('项目 id', '目录 id');

// 向上移动
categories.moveUp('根目录项目 id');
categories.moveUp('项目 id', '目录 id');

// 向下移动
categories.moveDown('根目录项目 id');
categories.moveDown('项目 id', '目录 id');

// 重命名
categories.rename('项目名称', '根目录项目 id');
categories.rename('项目名称', '项目 id', '目录 id');

// 切换启用状态
categories.toggle('根目录项目 id');
categories.toggle('项目 id', '目录 id');

// 保存更改到配置文件
categories.save();

// 获取最新的列表数据
const data = categories.reload();

console.log(JSON.stringify(data, null, 2));