Vue.js と Flask を使用したシングルページ アプリの構築例

この記事では主にVue.jsとFlaskを使ってシングルページアプリを構築する例を紹介していますが、とても良いと思いますので、参考として共有させていただきます。ぜひご覧ください

このチュートリアルでは、vue.js のシングルページ アプリケーションを Flask バックエンドに接続する方法を説明します。

一般的に言えば、Flask テンプレートを通じて vue.js ライブラリを使用したいだけであれば、問題はありません。ただし、実際には、Jinja (テンプレート エンジン) も Vue.js と同様にレンダリングに二重中括弧を使用するという明らかな問題がありますが、それは無難な解決策にすぎません。

別の例が欲しかったです。 vue.js を使用して単一ページのアプリケーション (アプリケーションは単一ページ、HTML5 の履歴モードの vue-router とその他多くの便利な機能で構成されています) を構築する必要があり、Web サービスが Flask によって提供されている場合はどうなるでしょうか。 ?簡単に説明すると、次のようになります。

Flask は、私の vue.js アプリを含む index.html を提供します。 フロントエンド開発には Webpack を使用しており、すべての優れた機能を提供します。

Flask には SPA からアクセスできる API 側があります。

フロントエンド開発のために Node.js を実行しているときでも、API 側にアクセスできます。

面白そうじゃないですか？それでは、このようにしてみましょう。

クライアント

Vue CLI を使用して、基本的な vue.js アプリを生成します。まだインストールしていない場合は、次を実行します:

$ npm install -g vue-cli

クライアント コードとバックエンド コードは異なるフォルダーに分割されます。インストール ウィザードを使用して、フロントエンド パーツの実行追跡を初期化します:

$ mkdir flaskvue
$ cd flaskvue
$ vue init webpack frontend

。私の設定は次のとおりです:

Vue は実行時にのみビルドされます。

Vueルーターをインストールします。

ESLint を使用してコードを検査します。

ESLint 標準プリセットを選択します。

単体テストに Karma + Mocha を試していない。

Nightwatch を使用せずにエンドツーエンドのテストを構築します。

OK、次:

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

これで、

vue.js

アプリケーションのインストールを開始できます。まずはいくつかのページを追加してみましょう。

home.vue

とabout.vueをfrontend/src/componentsフォルダーに追加します。それらは次のように非常に単純です:

// Home.vue
<template>
<p>
<p>Home page</p>
</p>
</template>

と

// About.vue
<template>
<p>
<p>About</p>
</p>
</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'),

に変更して、/dist フォルダーの HTML、CSS、および JS が同じレベルのディレクトリ/フロントエンド。これで、

$ npm run build

を実行してパッケージを作成できるようになりました。

バックエンド

Flask サーバーの場合、Python バージョン 3.6 を使用します。

/flaskvue に新しいサブフォルダーを作成してバックエンド コードを保存し、仮想環境を初期化します:

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

仮想環境 (MacOS) で実行するには:

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

をアクティブ化する必要がありますこれは Windows ドキュメント (http://pymote.readthedocs.io/en/latest/install/windows_virtualenv.html) に記載されています。

仮想環境にインストールします:

$ source venv/bin/activate

次に、Flask サーバーのコードを書きましょう。ルート ファイル run.py を作成します:

(venv) pip install Flask

このファイルに次のコードを追加します:

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

このコードは、Flask の「Hello World」コードとは少し異なります。主な違いは、静的ファイルとテンプレートがフロントエンド フォルダーと区別されるように、フォルダー

/dist

に保存される場所を指定していることです。ルート フォルダーで Flask サーバーを実行します:

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

これにより、ローカル ホストで Web サーバーが起動します: FLASK_APP

localhost:5000

上のサーバー側起動ファイル、

flask_debug = 1

が実行されますデバッグモードで。すべてが正しければ、見慣れたホームページが表示され、Vue のセットアップは完了です。

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

@app.route('/', defaults={'path': ''})
@app.route(&#39;/<path:path>&#39;)
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>
<p>
<p>404 - Not Found</p>
</p>
</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(&#39;/<path:path>&#39;)
def catch_all(path):

return render_template("index.html")

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

{
"randomNumber": 36
}

你可以通过本地浏览测试这个路径： localhost:5000/api/random。

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

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

</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 再在 3f1c4e4b6b16bbbd69b2ee476dc4f83a 部分添加一些变化：

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(&#39;/<path:path>&#39;)
def catch_all(path):

if app.debug:

return requests.get(&#39;http://localhost:8080/{}&#39;.format(path)).text

return render_template("index.html")

很优雅的魔法:sparkles:！

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

 

 

后记

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

首先利用CORS，如果你想让你的API端访问外部的服务器。否则的话只需要使用代理服务器与前端开发技巧。

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

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

上面是我整理给大家的，希望今后会对大家有帮助。

相关文章：

解决微信返回上一页，页面中的AJAX的请求，对Get请求无效的问题

ajax实现异步文件或图片上传功能

AJAX用于判定用户是否注册

以上がVue.js と Flask を使用したシングルページ アプリの構築例の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。