electron开发本地音乐播放器踩坑总结

最近研究了一下electron,于是就来做个实践项目local-music-player,主要功能就是导入音乐到歌曲列表,播放音乐、删除音乐等。附上地址,下载跑起来,自己打包出一个app。
github地址

技术用electron、原生js。

先看最终产品效果,首先是空白列表。


播放器1.png

然后先点击【添加歌曲】


弹框可以点击多选音乐

导入音乐.png

导入音乐之后就可以播放音乐了,也可暂停、删除音乐。


播放暂停删除音乐.png

启动项目

我直接看官网 https://www.electronjs.org/ ,这个官网也是挺垃圾的,经常打不开,打开慢,我还是翻墙了的。

# 克隆示例项目的仓库
$ git clone https://github.com/electron/electron-quick-start

# 进入这个仓库改名为local-music-player
$ cd local-music-player

# 安装依赖并运行
$ npm install && npm start

如果你是Windows用户,一般都会失败,因为这里要下载一堆环境依赖如Visual C++ 软件包、Python等,所以先别走上面的步骤,先点下面链接,这里按照它的说明,把这些前期环境工作做好https://github.com/felixrieseberg/windows-build-tools,然后再进入项目npm install && npm start

然后就开始开发了。

开发

electron由Node.js+Chromium+Native APIs构成。你可以理解成,它是一个得到了Node.js和基于不同平台的Native APIs加强的Chromium浏览器,可以用来开发跨平台的桌面级应用。有意思的是:我们可以在一个js文件里面同时操作dom与nodejs的api。

electron通信架构

electron的核心概念是主进程和渲染进程,主进程main.js创建应用,并且提供访问操作系统的能力, 而渲染进程 BrowserWindow 主要负责web ui开发。这个就是参考了chromium的架构思想。进程之间通信用ipcMain\ ipcRenderer或者渲染进程直接调用remote.xxx来操作主进程的方法,而主进程可以通过

const win = new BrowserWindow({...})
win.webContents.xxx

来操作渲染进程的方法。我这里只用了ipcMain\ ipcRenderer方式通信。本地导入音乐用到了一个electron-store的库,这里主要就是生成一个文件来记录歌曲列表的增删改之后的信息的。用了它就会在本地的这个目录生成一个json文件,文件名在代码中控制

music data.json

musicdata

打包

打包是个巨坑,这次开发经历简直可以说是开发5分钟,打包两小时! 并不是打包慢,主要问题是打包需要明白怎么配置和打包过程中各种包下载失败报错。因为它号称跨平台的,所以可以打包成任意格式的包,如windows平台的nsis (Installer), nsis-web (Web installer), portable ; mac的 dmg, pkg, mas, mas-dev; linux的deb, rpm, freebsd, pacman, p5p, apk.
我这里用了electron-builder,文档是英文的,需要配置package.json配置build选项,我的配置如下,主要是配置了win平台的,打包出来exe文件。

{
  "name": "local-music-player",
  "version": "1.0.0",
  "description": "一个音乐播放器",
  "main": "main.js",
  "scripts": {
    "start": "nodemon --watch main.js --exec electron .",
    "build": "electron-builder"
  },
  "build": {
    "appId": "local.music.app",
    "productName": "音乐播放器",
    "mac": {
      "category": "public.app-category.productivity",
      "artifactName": "${productName}-${version}.${ext}"
    },
    "win": {
      "target": [
        {
          "target": "nsis",
          "arch": [
            "x64",
            "ia32"
          ]
        }
      ],
      "icon": "./build/icon/icon.ico",
      "artifactName": "${productName}-${version}.${ext}",
      "publisherName": "xxx"
    },
    "nsis": {
      "allowToChangeInstallationDirectory": true,
      "oneClick": false,
      "perMachine": false,
      "installerIcon": "./build/icon/icon.ico",
      "uninstallerIcon": "./build/icon/icon.ico",
      "installerHeaderIcon": "./build/icon/icon.ico",
      "createDesktopShortcut": true
    },
    "copyright": "©2020 xx公司."
  },
  "repository": "https://github.com/electron/electron-quick-start",
  "keywords": [
    "Electron",
    "quick",
    "start",
    "tutorial",
    "demo"
  ],
  "author": "GitHub",
  "license": "CC0-1.0",
  "devDependencies": {
    "electron": "^9.1.0",
    "electron-builder": "^22.7.0",
    "nodemon": "^2.0.4"
  },
  "dependencies": {
    "bootstrap": "^4.5.0",
    "electron-store": "^6.0.0",
    "uuid": "^8.2.0"
  }
}

更多配置可以参考这篇文章:Electron-builder打包详解

巨坑:downloading错误。
我也是参考这篇文章:Electron 打包问题:electron-builder 下载各种依赖出错,然后需要自己根据报错,自己去手动下载包到对应的目录,真是服了。我一开始去https://github.com/electron/electron/releases/tag/v9.1.0
找下载,结果下载非常慢,等着下载又容易失败,最后我还是手动去淘宝镜像
里面去找资源,结果是秒下。

打包总结
1、先配置build选项,然后执行npm run build,对了,根目录还要自己创建一个build文件夹里面弄个256x256的ico图标,如build选项下的win选项里面的"icon": "./build/icon/icon.ico",
2、根据下载错误,参考这篇文章:Electron 打包问题:electron-builder 下载各种依赖出错淘宝镜像拿资源。

最后打包成功,在dist目录里面


dist
打包

所以最终的成果其实拿 dist/音乐播放器-1.0.0.exe 这个安装包就行了。

最后

本次实践,完整走了一次桌面端开发流程。但是还有很多不完善的地方,没有采用工程化的方式开发。所以,实际开发可以考虑参考electron-vue,或者自己用webpack来搭建脚手架,折腾一下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,527评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,314评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,535评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,006评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,961评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,220评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,664评论 3 392
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,351评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,481评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,397评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,443评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,123评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,713评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,801评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,010评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,494评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,075评论 2 341