使用 Cordova 和 Vue.js 创建移动应用

获取代码

Cordova 是一个你可以使用HTML, JavaScript 和 CSS 等 web 技术开发移动应用的框架。它支持使用一套基本代码面向多平台,如 Android 和 iOS 。尽管你在开发中仍然需要用到该平台特定的技术,例如 Android SDK 或 Xcode ,你也无需再编写任何 Android 或 iOS 代码就能完成应用开发。

既然你能够掌握 HTML 和 JavaScript 代码的编写,使用Vue.js 这样配有 Cordova 的 JavaScript 库就是小菜一碟了。

这个教程将为您展示如何使用 Cordova 和 Vue.js 开发一个简单的生成随机单词的移动应用。

准备工作

配置一个 Cordova 工程

创建一个名为 RandomWord 的工程:

cordova create RandomWord
cd RandomWord

将会创建一个 Cordova 工程的目录结构:

Cordova Vue.js Directory Structure

  • config.xml -包含应用相关信息,使用到的插件以及面向的平台

  • platforms - 包含应用运行平台如 Android 和 iOS 上对应的 Cordova 库

  • plugins - 包含应用所需插件的 Cordova 库,使得应用能够访问例如照相机和电池状态相关的事项。

  • www - 包含应用源代码,例如 HTML, JavaScript 和 CSS 文件

  • hooks - 包含为个性化应用编译系统所需的脚本

添加安卓平台:

cordova platform add android --save

这样就可以将安卓平台库添加到平台目录(platforms/android)当中。

它也可以添加白名单插件用于限制应用访问或在浏览器当中打开指定 URL 地址。随机单词生成器应用无需这种功能,但是你可以了解关于白名单的更多事项。这里

--save flag 将平台引擎添加到 config.xml ,是cordova prepare 从一个config.xml 文件初始化 Cordova 工程需要的命令。

...
    <engine name="android" spec="~5.2.1" />
</widget>

检查你是否具备使用 Cordova 开发/运行 Android 应用的条件:

cordova requirements

如果有条件缺失,查看 Android 版 Cordova 文档 以及以及以及教程底部的 Help。这的确是教程当中最难的部分。耐心一点,参考链接提到的部分。一旦所有需求都满足了,教程剩下的部分就是小意思了。

创建一个 Android 应用:

cordova build android

将手机连接在电脑上,运行该 Android 程序:

cordova run android

如果没有 Android 手机可以连接到电脑,Cordova 将在仿真器上运行应用。

示例应用相当简单,它所做的只是更改标签的背景色

Cordova Sample Screen

要用 iOS 替代 Android ,按上述步骤进行操作,只需把 android 换成 ios。如果不满足条件,查看iOS 版 Cordova 文档 以及教程底部的 Help 。如果在 Windows 系统的电脑上运行 Cordova ,你无法创建/运行 iOS 应用,因为 iOS Cordova 需要苹果系统。

或者,你可以使用你的浏览器替代手机设备,只需使用 browser 平台。同样按上述步骤,只需把 android 换成 browser。

在 config.xml 文件中更改有关随机单词生成器应用的信息:

<?xml version='1.0' encoding='utf-8'?>
<widget id="io.coligo.randomword" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
    <name>RandomWord</name>
    <description>
        A mobile app for generating a random word.
    </description>
    <author email="[email protected]" href="http://www.michaelviveros.com/">
        Michael Viveros
    </author>
    ...

添加 Vue.js

与所有的 HTML 文件一样,添加 Vue.js CDN 到 www/index.html 底部:

...
        <script type="text/javascript" src="cordova.js"></script>
        <script src="http://cdn.jsdelivr.net/vue/1.0.16/vue.js"></script>
        <script type="text/javascript" src="js/index.js"></script>
    </body>
</html>

为了使应用可以访问 Vue.js 库,我们还需要在 www/index.html 文件中把下面代码添加到内容安全协议(CSP) meta 标签的最后:

; script-src 'self' http://cdn.jsdelivr.net/vue/1.0.16/vue.js 'unsafe-eval'

内容安全协议的网页允许你创建来自可信来源的白名单,并引导浏览器只执行那些可信来源的操作或资源渲染。这和上面提到的白名单插件不同,因为白名单插件主要用于定义应用允许访问什么链接,而 CSP 拥有定义应用可以执行何种脚本以及应用向哪个 url 提出 http 请求。

CSP meta 标签的 script-src 部分定义了应用可以执行的脚本。

  • ’self’ - 允许统一来源的脚本,例如 www/js/index.js

  • http://cdn.jsdelivr.net/vue/1.0.16/vue.js - 允许 Vue.js 库

  • ’unsafe-eval’ - 允许不安全的动态代码评估,因为 Vue.js 中有部分代码使用了字符串生成函数

CSP meta 标签看起来应该像这样

<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *; script-src 'self' http://cdn.jsdelivr.net/vue/1.0.16/vue.js 'unsafe-eval'">

获得有关 CSP 的更多内容, 查看 html5rocks 和 Cordova 文档.

使用 Vue.js 替换 www/index.html 中 body 部分代码显示随机单词并移除一些注释后,wwww/index.html 就会像这样

<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *; script-src 'self' http://cdn.jsdelivr.net/vue/1.0.16/vue.js 'unsafe-eval'">
        <meta name="format-detection" content="telephone=no">
        <meta name="msapplication-tap-highlight" content="no">
        <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width">
        <link rel="stylesheet" type="text/css" href="css/index.css">
        <title>Random Word</title>
    </head>
    <body>
        <div id="vue-instance" class="app">
            <h1>Random Word</h1>
            <button id="btn-get-random-word" @click="getRandomWord">Get Random Word</button>
            <p>{{ randomWord }}</p>
        </div>
        <script type="text/javascript" src="cordova.js"></script>
        <script src="http://cdn.jsdelivr.net/vue/1.0.16/vue.js"></script>
        <script type="text/javascript" src="js/index.js"></script>
    </body>
</html>

现在我们将添加一些 JavaScript 来生成随机单词进行展示。

当应用接收到 deviceready 事件时,www/js/index.js 即可生成改变标签背景色的代码。接收我们简单的随机单词生成器的 deviceready 事件后,我们无需做其他多余的事情,不过最好知道你可以用 bindEvents 方法在应用运行周期的不同阶段做不同的事情。查看 Cordova Events 获得更多信息。

我们将在 www/js/index.js 添加一个名叫 setupVue 方法,它可以创建一个新的 Vue 实例,并装载到随机单词 div 。新的 Vue 实例会使用getRandomWord 方法,单击 Get Random Word 按键即可从列表中随机提取单词。我么也需要从 initialize 方法中调用 setupVue

var app = {
    initialize: function() {
        this.bindEvents();
        this.setupVue();
    },
    ...
    setupVue: function() {
        var vm = new Vue({
            el: "#vue-instance",
            data: {
                randomWord: '',
                words: \[
                    'formidable',
                    'gracious',
                    'daft',
                    'mundane',
                    'onomatopoeia'
                \]
            },
            methods: {
                getRandomWord: function() {
                    var randomIndex = Math.floor(Math.random() * this.words.length);
                    this.randomWord = this.words\[randomIndex\];
                }
            }
        });
    }
};
app.initialize();

移除掉 receivedEvent 里改变标签背景色的代码和一些注释之后,www/js/index.js 看上去是这样的:

var app = {
    initialize: function() {
        this.bindEvents();
        this.setupVue();
    },
    bindEvents: function() {
        document.addEventListener('deviceready', this.onDeviceReady, false);
    },
    onDeviceReady: function() {
        app.receivedEvent('deviceready');
    },
    receivedEvent: function(id) {
        console.log('Received Event: ' + id);
    },
    setupVue: function() {
        var vm = new Vue({
            el: "#vue-instance",
            data: {
                randomWord: '',
                words: \[
                    'formidable',
                    'gracious',
                    'daft',
                    'mundane',
                    'onomatopoeia'
                \]
            },
            methods: {
                getRandomWord: function() {
                    var randomIndex = Math.floor(Math.random() * this.words.length);
                    this.randomWord = this.words\[randomIndex\];
                }
            }
        });
    }
};
app.initialize();

创建,连接手机然后运行:

cordova build android
cordova run android

该应用看上去应该像下面这样:

Random Word App Cordova Vue.js

vue-resource 发起 HTTP 请求

该应用没有从硬编码的单词列表中提取随机单词,而是从可以生成随机单词的 API 中发起请求的,例如 Wordnik Random Word API 。

为了能够向随机单词 API 发起请求, 需要在 CSP 元标签最后添加下面代码。

; connect-src http://api.wordnik.com:80/v4/words.json/randomWord

The connect-src part of the CSP meta tag defines which origins the app can make http requests to. 
CSP 元标签的 connect-src 部分定义了应用发起 HTTP 请求的来源。

该应用可以使用vue-resource library 发起 HTTP 请求,那样我们就可以添加 vue 源到 CSP 元标签 script-src 部分以及添加 vue 源 CDN 。

index.html 将变成:

<!DOCTYPE html>
...
        <meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *; script-src 'self' http://cdn.jsdelivr.net/vue/1.0.16/vue.js https://cdn.jsdelivr.net/vue.resource/0.7.0/vue-resource.min.js 'unsafe-eval'; connect-src http://api.wordnik.com:80/v4/words.json/randomWord">
...
        <script src="http://cdn.jsdelivr.net/vue/1.0.16/vue.js"></script>
        <script src="https://cdn.jsdelivr.net/vue.resource/0.7.0/vue-resource.min.js"></script>
        <script type="text/javascript" src="js/index.js"></script>
    </body>
</html>

为了向随机单词 API 发起 http 请求,我们可使用 vue-resource 当中的 http service ,这是来自 www/js/index.js 里 Vue 实例中的 getRandomWord 方法。

... 
    setupVue: function() {
        var vm = new Vue({
            el: "#vue-instance",
            data: {
                randomWord: ''
            },
            methods: {
                getRandomWord: function() {
                    this.randomWord = '...';
                    this.$http.get(
                        'http://api.wordnik.com:80/v4/words.json/randomWord?api_key=a2a73e7b926c924fad7001ca3111acd55af2ffabf50eb4ae5'
                    ).then(function (response) {
                        this.randomWord = response.data.word;
                    }, function (error) {
                        alert(error.data);
                    });
                }
            }
        });
    }
};
app.initialize();

创建,连接手机并运行:

cordova build android
cordova run android

应用和之前看起来一样,但是现在它可以从 API 当中获取随机单词了。

使用 Vue 组件

Vueify 是一个 Vue.js 库,他可以帮你将 UI 变成独立的带有各自 HTML, JavaScript 和 CSS 的组件。这令你的应用更加的模块化,也方便你使用层级方式定义组件。

使用 Vue 组件需要在你的编译系统中添加额外的步骤以合并所有组件。Cordova 通过 hooks 来指定额外的脚本在编译系统的各个部分运行,从而让该过程变得相当简单 
这就是添加 Vue 组件之后目录的样子:

Cordova Vue.js Directory Structure

创建一个带有随机单词生成器所有代码的组件,命名为 www/js/random-word.vue :

<template>
  <div class="app">      
    <h1>Random Word</h1>
    <button id="btn-get-random-word" @click="getRandomWord">Get Random Word</button>
    <p>{{randomWord}}</p>
  </div>
</template>
<script>
export default {
  data () {
    return {
      randomWord: ''
    }
  },
  methods: {
    getRandomWord: function() {
        this.randomWord = '...';
        this.$http.get(
            'http://api.wordnik.com:80/v4/words.json/randomWord?api_key=a2a73e7b926c924fad7001ca3111acd55af2ffabf50eb4ae5'
        ).then(function (response) {
            this.randomWord = response.data.word;
        }, function (error) {
            alert(error.data);
        });
    }
  }
}
</script>

www/index.html的 HTML 放入 template 标签,而 JavaScript 放入random-word.vue的 script 标签

创建一个新的包含随机单词组件的 Vue 实例文件,命名 www/js/main.js:

var Vue = require('vue');
var VueResource = require('vue-resource');
var RandomWord = require('./random-word.vue');
Vue.use(VueResource);
var vm = new Vue({
  el: 'body',
  components: {
    'random-word': RandomWord
  }
});

为了合并组件,我们需要使用 browserify 和 vueify 来创建一个 名为 bundle.js 的文件。创建一个新的名为 scripts 的目录,新建 vueify-build.js文件,其中包含了需要合并的随机单词组件的代码。

以前的版本,vueify-build.js 这样的脚本是放在 hooks 目录里的,而 hooks 目录则从 cordova create 这个命令中创建,但是后来这种方式被废弃了。所以你可以删除了 hooks 目录并用 scipts 目录代替。

scripts/vueify-build.js 就会像这样:

var fs = require('fs');
var browserify = require('browserify');
var vueify = require('vueify');
browserify('www/js/main.js')
  .transform(vueify)
  .bundle()
  .pipe(fs.createWriteStream('www/js/bundle.js'))

从前,我们在 www/index.html 使用 CDN 来引用 Vue.js 库,但是现在www/js/main.js 用的是 JavaScript 来做。所以我们需要添加一个package.json 文件为 Vue.js 库来定义所有需要的依赖。

{
  "name": "random-word",
  "version": "1.0.0",
  "description": "A mobile app for generating a random word",
  "main": "index.js",
  "dependencies": {
    "browserify": "~13.0.1",
    "vue": "~1.0.24",
    "vue-resource": "~0.7.4",
    "vueify": "~8.5.4",
    "babel-core": "6.9.1",
    "babel-preset-es2015": "6.9.0",
    "babel-runtime": "6.9.2",
    "babel-plugin-transform-runtime": "6.9.0",
    "vue-hot-reload-api": "2.0.1"
  },
  "author": "Michael Viveros",
  "license": "Apache version 2.0"
}

所有的 label 相关模块,以及 browserify 和 vue-hot-reload-api 由 vueify 使用,参考 vueify 文档

获取定义在 package.json 里的所有 node 模块依赖:

npm install

开发应用其他部分之前,在 config.xml 底部添加一个 hook 来告知 Cordova 绑定随机单词组件:

...
    <hook type="before_compile" src="scripts/vueify-build.js" />
</widget>

调用 scripts/vueify-build.js 将产生合并的组件并放入 www/js/bundle.js 中。

通过向 random-word 和 script 标签添加指向合并组件的方式向www/index.html 主体添加随机单词组件。

...
        <link rel="stylesheet" type="text/css" href="css/index.css">
        <title>Random Word</title>
    </head>
    <body>
        <random-word></random-word>
        <script src="js/bundle.js"></script>
        <script type="text/javascript" src="js/index.js"></script>
        <script type="text/javascript" src="cordova.js"></script>
    </body>
</html>

注意到 www/index.html 中链接标签定义了应用的 CSS 和www/js/random-word.vue 中的 div 。在 CSS 中使用了 “app” 类定义。

由于随机单词组件包含生成随机单词的所有代码,我们可以从www/js/index.js 中删除 setupVue 方法,就会像这样:

var app = {
    initialize: function() {
        this.bindEvents();
    },
    bindEvents: function() {
        document.addEventListener('deviceready', this.onDeviceReady, false);
    },
    onDeviceReady: function() {
        app.receivedEvent('deviceready');
    },
    receivedEvent: function(id) {
        console.log('Received Event: ' + id);
    }
};
app.initialize();

创建,连接手机并运行:

cordova build android
cordova run android

应用外观和功能和先前一样,但是我们现在有使用 Vue 组件。

总结

全部完成了。

Cordova 令使用 web 技术开发移动应用变得超简单。 连接 Cordova 和 Vue.js 也很容易,而且让你充分利用手机应用上 Vue.js 相关的很酷的东西(2套数据绑定,组件……)现在你可以以一套代码使用 HTML, JavaScript 和 CSS 面向多个平台进行开发了。

本教程涵盖:

  • 开发一个 Cordova 工程

  • 链接 Cordova 和 Vue.js

  • Cordova app 通过更新内容安全策略来发出 HTTP 申请

  • 添加 Hooks 在 Cordova 应用中使用 Vue 组件

帮助

Android

安装好 Android SDK 之后,你可以运行下面的命来来打开 Android SDK 管理器。

/Users/your_username/Library/Android/sdk/tools/android sdk

我安装了下面这些包:

工具

  • Android SDK 工具

  • Android SDK 平台工具

  • Android SDK 开发工具

Android 6.0 (API 23)

  • SDK 平台

  • Intel x86 Atom_64 系统映象

额外

  • Intel x86 仿真器加速设备 (HAXM Installer)

iOS

通过 npm 安装 iOS 依赖的时候我犯了个错误,运行了 OS X El Capitan 10.11,可以运行下面代码来解决:

sudo npm install -g ios-deploy –unsafe-perm=true

见 StackOverflow

关于作者

我的名字叫 Michael Viveros 。今年是我学习软件工程的第五年。我是个充满热情的程序员,难得一见的没准的高尔夫球手和会挖苦人的机智的说笑话的家伙。我正在开发一个高尔夫球跟踪网站,还有个用到 Cordova 和 Vue.js 的移动应用。 你可以在下面的网站看到更多 michaelviveros.com 。