使用 Vue.js 和 Flask 来构建一个单页的App

在这个教程中，咱们将讲解如何将vue.js单页应用与Flask后端进行链接。

通常来讲，若是你只是想经过Flask模板使用vue.js库也是没有问题的。可是，其实是一个很明显的问题那就是，Jinja（模板引擎）也和Vue.js同样采用双大括号用于渲染，但只是一个还算过的去的解决方案。

我想要一个不一样的例子。若是我须要创建一个单页应用程序（应用程序使用单页组成，vue-router在HTML5的History-mode以及其余更多好用的功能）用vue.js，由Flask提供Web服务？简单地说应该这样，以下所示：

Flask为index.html服务，index.html包含个人vue.js App。

在前端开发中我使用Webpack，它提供了全部很酷的功能。

Flask有API端，我能够从个人SPA访问。

我能够访问API端，甚至当我为了前端开发而运行Node.js的时候。

听起来是否是颇有趣？那让咱们这样动手作作吧。

完整的源代码，你能够在这里找到：

https://github.com/oleg-agapo...

客户端

我将使用Vue CLI产生基本vue.js App。若是你尚未安装它，请运行：

$ npm install -g vue-cli

客户端和后端代码将被拆分到不一样的文件夹。初始化前端部分运行跟踪：

$ mkdir flaskvue
$ cd flaskvue
$ vue init webpack frontend

经过安装向导。个人设置是：

1. Vue 只在运行时构建。 
2. 安装Vue-router。
3. 使用ESLint检查代码。
4. 选择一个ESLint 标准预设 。
5. 不试用Karma + Mocha进行单位测试。
6. 不使用Nightwatch创建端到端的测试。

ok，接着来：

$ cd frontend
$ npm install
# after installation
$ npm run dev

这就能够开始安装vue.js应用程序。让咱们从添加一些页面开始吧。

添加home.vue和about.vue到frontend/src/components文件夹。它们很是简单，像这样：

// Home.vue

<template>
<div>
<p>Home page</p>
</div>
</template>

and

// About.vue

<template>
<div>
<p>About</p>
</div>
</template>

咱们将使用它们正确地识别咱们当前的位置（根据地址栏）。如今咱们须要改变frontend/src/router/index.js文件以便使用咱们的新组件：

import Vue from 'vue'
import Router from 'vue-router'
const routerOptions = [
{ path: '/', component: 'Home' },
{ path: '/about', component: 'About' }
]

const routes = routerOptions.map(route => {
return {
...route,
component: () => import(`@/components/${route.component}.vue`)
}

})

Vue.use(Router)
export default new Router({
routes,
mode: 'history'
})

若是你试着输入localhost:8080 和 localhost:8080/about，你应该看到相应的页面。

咱们几乎已经准备好构建一个项目，而且可以建立一个静态资源文件包。在此以前，让咱们为它们从新定义一下输出目录。在frontend/config/index.js找到下一个设置：

index: path.resolve(__dirname, '../dist/index.html'),
assetsRoot: path.resolve(__dirname, '../dist'),

把它们改成

index: path.resolve(__dirname, '../../dist/index.html'),
assetsRoot: path.resolve(__dirname, '../../dist'),

因此/dist文件夹的HTML、CSS、JS会在同一级目录/frontend 。如今你能够运行 $ npm run build 建立一个包。

后端

对于Flask服务器，我将使用Python版本3.6。在 /flaskvue建立新的子文件夹存放后端代码并初始化虚拟环境：

$ mkdir backend
$ cd backend
$ virtualenv -p python3 venv

为了使虚拟环境中运行（MacOS）：

$ source venv/bin/activate

在Windows中须要激活此文档（http://pymote.readthedocs.io/...）。

在虚拟环境下安装：

(venv) pip install Flask

如今让咱们为Flask服务端编写代码。建立根目录文件run.py：

(venv) cd ..
(venv) touch run.py

向这个文件添加下一个代码：

from flask import Flask, render_template
app = Flask(__name__,
static_folder = "./dist/static",
template_folder = "./dist")

@app.route('/')
def index():
return render_template("index.html")

这段代码与Flask的 “Hello World”代码略有不一样。主要的区别是，咱们指定存储静态文件和模板位置在文件夹 /dist，以便和咱们的前端文件夹区别开。在根文件夹中运行Flask服务端：

(venv) FLASK_APP=run.py FLASK_DEBUG=1 flask run

这将启动本地主机上的Web服务器：localhost:5000 上的FLASK_APP服务器端的启动文件，flask_debug = 1将运行在调试模式。若是一切正确，你会看到熟悉的主页，你已经完成了对Vue的设置。

同时，若是您尝试输入/about页面，您将面临一个错误。Flask抛出一个错误，说找不到请求的URL。事实上，由于咱们使用了HTML5的History-Mode在Vue-router须要配置Web服务器的重定向，将全部路径指向index.html。用Flask作起来很容易。将现有路由修改成如下：

@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def catch_all(path):
return render_template("index.html")

如今输入网址localhost:5000/about 将从新定向到index.html和vue-router将处理路由。

添加404页

由于咱们有一个一应俱全的路径，咱们的Web服务器在如今已经很难遇上404错误，Flask将全部请求指向index.html（甚至不存在的页面）。因此咱们须要处理未知的路径在vue.js应用。固然，全部的工做均可以在咱们的路由文件中完成。

在frontend/src/router/index.js添加下一行：

const routerOptions = [
{ path: '/', component: 'Home' },
{ path: '/about', component: 'About' },
{ path: '*', component: 'NotFound' }
]

这里的路径'*'是一个通配符，
Vue-router就知道除了咱们上面定义的全部其余任何路径。如今咱们须要更多的创造NotFound.vue文件在/components目录。试一下很简单：

// NotFound.vue

<template>
<div>
<p>404 - Not Found</p>
</div>
</template>

如今运行的前端服务器再次npm run dev，尝试进入一些毫无心义的地址例如：localhost:8080/gljhewrgoh。您应该看到咱们的“未找到”消息。

添加API端

咱们的vue.js/flask教程的最后一个例子将是服务器端API建立和调度客户端。咱们将建立一个简单的Api，它将从1到100返回一个随机数。

打开run.py并添加：

from flask import Flask, render_template, jsonify
from random import *

app = Flask(__name__,
static_folder = "./dist/static",
template_folder = "./dist")

@app.route('/api/random')

def random_number():
response = {
'randomNumber': randint(1, 100)
}
return jsonify(response)

@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def catch_all(path):

return render_template("index.html")

首先我导入random库和jsonify函数从Flask库中。而后我添加了新的路由 /api/random来返回像这样的JSON：

{
"randomNumber": 36
}

你能够经过本地浏览测试这个路径：localhost:5000/api/random。

此时服务器端工做已经完成。是时候在客户端显示了。咱们来改变home.vue组件显示随机数：

<template>
<div>
<p>Home page</p>
<p>Random number from backend: {{ randomNumber }}</p>
<button @click="getRandom">New random number</button>
</div>

</template>
<script>
export default {
data () {
return {
randomNumber: 0
}
},

methods: {
getRandomInt (min, max) {
min = Math.ceil(min)
max = Math.floor(max)
return Math.floor(Math.random() * (max - min + 1)) + min
},

getRandom () {
this.randomNumber = this.getRandomInt(1, 100)
}
},

created () {
this.getRandom()
}

}

</script>

在这个阶段，咱们只是模仿客户端的随机数生成过程。因此，这个组件就是这样工做的：

1. 在初始化变量 randomNumber等于0。
2. 在methods部分咱们经过getRandomInt(min, max)功能来从指定的范围内返回一个随机数，getrandom函数将生成随机数并将赋值给randomNumber
3. 组件方法getrandom建立后将会被调用来初始化随机数
4. 在按钮的单击事件咱们将用getrandom方法获得新的随机数

如今在主页上，你应该看到前端显示咱们产生的随机数。让咱们把它链接到后端。

为此目的，我将用axios库。它容许咱们用响应HTTP请求并用Json返回JavaScript Promise。咱们安装下它：

(venv) cd frontend
(venv) npm install --save axios

打开 home.vue 再在 <script> 部分添加一些变化：

import axios from 'axios'
methods: {
getRandom () {
// this.randomNumber = this.getRandomInt(1, 100)
this.randomNumber = this.getRandomFromBackend()
},

getRandomFromBackend () {
const path = `http://localhost:5000/api/random`
axios.get(path)
.then(response => {
this.randomNumber = response.data.randomNumber
})
.catch(error => {
console.log(error)
})

}

}

在顶部，咱们须要引用Axios库。而后有一个新的方法getrandomfrombackend将使用Axios异步调用API和检索结果。最后，getrandom方法如今应该使用getrandomfrombackend函数获得一个随机值。

保存文件，到浏览器，运行一个开发服务器再次刷新 localhost:8080。你应该看到控制台错误没有随机值。但别担忧，一切都正常。咱们获得了CORS的错误意味着Flask服务器API默认会关闭其余Web服务器（在咱们这里，vue.js App是在 Node.js服务器上运行的应用程序）。若是你npm run build 项目，那在localhost:5000（如Flask服务器）你会看到App在工做的。可是，每次对客户端应用程序进行一些更改时，都建立一个包并不十分方便。

让咱们用打包了CORS插件的Flask，将使咱们可以建立一个API访问规则。插件叫作FlaskCORS，让咱们安装它：

(venv) pip install -U flask-cors

你能够阅读文档，更好的解释你要使你的服务器怎么样使用CORS。我将使用特定的方法，并将{“origins”: “”}应用于全部/api/路由（这样每一个人均可以使用个人API端）。在run.py加上：

from flask_cors import CORS
app = Flask(__name__,
static_folder = "./dist/static",
template_folder = "./dist")
cors = CORS(app, resources={r"/api/*": {"origins": "*"}})

有了这种改变，您就能够从前端调用服务端。

更新:

事实上，若是你想经过Flask提供静态文件不须要CORS。感谢Carson Gee的下面的这一招。

这个主意是这样的。若是应用程序在调试模式下，它只会代理咱们的前端服务器。不然（在生产中）只为静态文件服务。因此咱们这样作：

import requests
@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def catch_all(path):

if app.debug:

return requests.get('http://localhost:8080/{}'.format(path)).text

return render_template("index.html")

很优雅的魔法✨！

如今有了一个完整的全栈（full-stack）应用程序，用您最喜好Vue.js和Flask技术构建。

后记

最后，我想就如何改进这个解决方案谈几句话。

首先利用CORS，若是你想让你的API端访问外部的服务器。不然的话只须要使用代理服务器与前端开发技巧。

另外一个改进是避免客户端硬编码API路由。也许你须要考虑一些API端点的字典。所以，当您更改API路由时，只需刷新一个字典便可。前端仍然有一个有效的端点。

一般在开发过程当中，你将至少有2个终端窗口：一个是Flask和另外一个是vue.js。在生产中能够摆脱Vue而只单独运行Node.js服务器。

源代码：https://github.com/oleg-agapo...

谢谢你的阅读！

分享一个Vue.js 2 的入门级全家桶系列教程：

1. vue.js 2 入门与提升: http://xc.hubwiz.com/course/vue.js
2. vuex 2 入门与提升: http://xc.hubwiz.com/course/vuex
3. vue-router 2 入门与提升: http://xc.hubwiz.com/course/vuerouter
4. vue.js 2 工程化实践: http://xc.hubwiz.com/course/vuegch

另外推荐一个flask的入门教程：

深刻浅出 flask http://xc.hubwiz.com/course/562427361bc20c980538e26f