使用Vue.js和Flask來構(gòu)建一個單頁的App的示例

在這個教程中，我們將講解如何將vue.js單頁應(yīng)用與Flask后端進行連接。

一般來說，如果你只是想通過Flask模板使用vue.js庫也是沒有問題的。但是，實際上是一個很明顯的問題那就是，Jinja（模板引擎）也和Vue.js一樣采用雙大括號用于渲染，但只是一個還算過的去的解決方案。

我想要一個不同的例子。如果我需要建立一個單頁應(yīng)用程序（應(yīng)用程序使用單頁組成， vue-router 在HTML5的History-mode以及其他更多好用的功能）用vue.js，由Flask提供Web服務(wù)？簡單地說應(yīng)該這樣，如下所示：

Flask為 index.html 服務(wù)， index.html 包含我的vue.js App。

在前端開發(fā)中我使用Webpack，它提供了所有很酷的功能。

Flask有API端，我可以從我的SPA訪問。

我可以訪問API端，甚至當我為了前端開發(fā)而運行Node.js的時候。

聽起來是不是很有趣？那讓我們這樣動手做做吧。

完整的源代碼，你可以在這里找到：https://github.com/oleg-agapov/flask-vue-spa

客戶端

我將使用Vue CLI產(chǎn)生基本vue.js App。如果你還沒有安裝它，請運行：

$ npm install -g vue-cli

客戶端和后端代碼將被拆分到不同的文件夾。初始化前端部分運行跟蹤：

$ mkdir flaskvue
$ cd flaskvue
$ vue init webpack frontend

通過安裝向?qū)?。我的設(shè)置是：

Vue 只在運行時構(gòu)建。

安裝Vue-router。

使用ESLint檢查代碼。

選擇一個ESLint 標準預(yù)設(shè) 。

不試用Karma + Mocha進行單位測試。

不使用Nightwatch建立端到端的測試。

ok，接著來：

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

這就可以開始安裝 vue.js 應(yīng)用程序。讓我們從添加一些頁面開始吧。

添加 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>

我們將使用它們正確地識別我們當前的位置（根據(jù)地址欄）?，F(xiàn)在我們需要改變 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 ，你應(yīng)該看到相應(yīng)的頁面。

我們幾乎已經(jīng)準備好構(gòu)建一個項目，并且能夠創(chuàng)建一個靜態(tài)資源文件包。在此之前，讓我們?yōu)樗鼈冎匦露x一下輸出目錄。在 frontend/config/index.js 找到下一個設(shè)置：

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 ?，F(xiàn)在你可以運行 $ npm run build 創(chuàng)建一個包。

后端

對于Flask服務(wù)器，我將使用Python版本3.6。在 /flaskvue 創(chuàng)建新的子文件夾存放后端代碼并初始化虛擬環(huán)境：

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

為了使虛擬環(huán)境中運行（MacOS）：

$ source venv/bin/activate

在Windows中需要激活此文檔（http://pymote.readthedocs.io/en/latest/install/windows_virtualenv.html）。

在虛擬環(huán)境下安裝：

(venv) pip install Flask

現(xiàn)在讓我們?yōu)镕lask服務(wù)端編寫代碼。創(chuàng)建根目錄文件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”**代碼略有不同。主要的區(qū)別是，我們指定存儲靜態(tài)文件和模板位置在文件夾 /dist ，以便和我們的前端文件夾區(qū)別開。在根文件夾中運行Flask服務(wù)端：

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

這將啟動本地主機上的Web服務(wù)器： localhost:5000 上的 FLASK_APP 服務(wù)器端的啟動文件， flask_debug = 1 將運行在調(diào)試模式。如果一切正確，你會看到熟悉的主頁，你已經(jīng)完成了對Vue的設(shè)置。

同時，如果您嘗試輸入/about頁面，您將面臨一個錯誤。Flask拋出一個錯誤，說找不到請求的URL。事實上，因為我們使用了HTML5的History-Mode在Vue-router需要配置Web服務(wù)器的重定向，將所有路徑指向index.html。用Flask做起來很容易。將現(xiàn)有路由修改為以下：

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

現(xiàn)在輸入網(wǎng)址localhost:5000/about 將重新定向到index.html和vue-router將處理路由。

添加404頁

因為我們有一個包羅萬象的路徑，我們的Web服務(wù)器在現(xiàn)在已經(jīng)很難趕上404錯誤，F(xiàn)lask將所有請求指向index.html（甚至不存在的頁面）。所以我們需要處理未知的路徑在vue.js應(yīng)用。當然，所有的工作都可以在我們的路由文件中完成。

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

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

這里的路徑'*'是一個通配符， Vue-router 就知道除了我們上面定義的所有其他任何路徑?，F(xiàn)在我們需要更多的創(chuàng)造 NotFound.vue 文件在**/components**目錄。試一下很簡單：

// NotFound.vue
<template>
<div>
<p>404 - Not Found</p>
</div>
</template>

現(xiàn)在運行的前端服務(wù)器再次 npm run dev ，嘗試進入一些毫無意義的地址例如： localhost:8080/gljhewrgoh 。您應(yīng)該看到我們的“未找到”消息。

添加API端

我們的 vue.js/flask 教程的最后一個例子將是服務(wù)器端API創(chuàng)建和調(diào)度客戶端。我們將創(chuàng)建一個簡單的Api，它將從1到100返回一個隨機數(shù)。

打開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")

首先我導(dǎo)入random庫和jsonify函數(shù)從Flask庫中。然后我添加了新的路由 /api/random 來返回像這樣的JSON：

{
"randomNumber": 36
}

你可以通過本地瀏覽測試這個路徑： localhost:5000/api/random。

此時服務(wù)器端工作已經(jīng)完成。是時候在客戶端顯示了。我們來改變home.vue組件顯示隨機數(shù)：

<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>

在這個階段，我們只是模仿客戶端的隨機數(shù)生成過程。所以，這個組件就是這樣工作的：

1. 在初始化變量 randomNumber 等于0。
2. 在methods部分我們通過 getRandomInt(min, max) 功能來從指定的范圍內(nèi)返回一個隨機數(shù)， getrandom 函數(shù)將生成隨機數(shù)并將賦值給 randomNumber
3. 組件方法 getrandom 創(chuàng)建后將會被調(diào)用來初始化隨機數(shù)
4. 在按鈕的單擊事件我們將用 getrandom 方法得到新的隨機數(shù)

現(xiàn)在在主頁上，你應(yīng)該看到前端顯示我們產(chǎn)生的隨機數(shù)。讓我們把它連接到后端。

為此目的，我將用 axios 庫。它允許我們用響應(yīng)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異步調(diào)用API和檢索結(jié)果。最后， getrandom 方法現(xiàn)在應(yīng)該使用 getrandomfrombackend 函數(shù)得到一個隨機值。

保存文件，到瀏覽器，運行一個開發(fā)服務(wù)器再次刷新 localhost:8080 。你應(yīng)該看到控制臺錯誤沒有隨機值。但別擔心，一切都正常。我們得到了 CORS 的錯誤意味著Flask服務(wù)器API默認會關(guān)閉其他Web服務(wù)器（在我們這里，vue.js App是在 Node.js服務(wù)器上運行的應(yīng)用程序）。如果你 npm run build 項目，那在 localhost:5000 （如Flask服務(wù)器）你會看到App在工作的。但是，每次對客戶端應(yīng)用程序進行一些更改時，都創(chuàng)建一個包并不十分方便。

讓我們用打包了CORS插件的Flask，將使我們能夠創(chuàng)建一個API訪問規(guī)則。插件叫做FlaskCORS，讓我們安裝它：

(venv) pip install -U flask-cors

你可以閱讀文檔，更好的解釋你要使你的服務(wù)器怎么樣使用CORS。我將使用特定的方法，并將**{“origins”: “*”}**應(yīng)用于所有/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": "*"}})

有了這種改變，您就可以從前端調(diào)用服務(wù)端。

更新:

事實上，如果你想通過Flask提供靜態(tài)文件不需要CORS。感謝Carson Gee的下面的這一招。

這個主意是這樣的。如果應(yīng)用程序在調(diào)試模式下，它只會代理我們的前端服務(wù)器。否則（在生產(chǎn)中）只為靜態(tài)文件服務(wù)。所以我們這樣做：

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")

很優(yōu)雅的魔法:sparkles:！

現(xiàn)在有了一個完整的全棧**（full-stack） 應(yīng)用程序，用您最喜愛 Vue.js 和 Flask**技術(shù)構(gòu)建。

后記

最后，我想就如何改進這個解決方案談幾句話。

首先利用CORS，如果你想讓你的API端訪問外部的服務(wù)器。否則的話只需要使用代理服務(wù)器與前端開發(fā)技巧。

另一個改進是避免客戶端硬編碼API路由。也許你需要考慮一些API端點的字典。因此，當您更改API路由時，只需刷新一個字典即可。前端仍然有一個有效的端點。

通常在開發(fā)過程中，你將至少有2個終端窗口：一個是Flask和另一個是vue.js。在生產(chǎn)中可以擺脫Vue而只單獨運行Node.js服務(wù)器。

源代碼：https://github.com/oleg-agapov/flask-vue-spa

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持億速云。