Flask 教程 第一章：Hello, World!

本文翻譯自The Flask Mega-Tutorial Part I: Hello, World!

一趟愉快的學習之旅即將開始，跟隨它你將學會用Python和Flask來建立Web應用。上面的視頻包含了整個教程的內容預覽（譯者注：視頻見原文）。經過學習本章內容，你將學會如何建立一個Flask項目，並在本身的電腦上運行一個簡單的Flask Web應用。

教程中全部的代碼示例都託管在GitHub上。雖然直接從GitHub下載代碼能夠節省寫代碼的步驟，可是我強烈建議你至少在前幾章本身動手書寫這些代碼。一旦你熟悉了Flask和示例應用，一些繁瑣重複的代碼就能夠直接從GitHub複製了。

在每章的開頭，我都將提供三個GitHub的連接來幫助你順暢地學習本章的內容。點擊Browse連接會打開GitHub上Microblog項目在本章的對應代碼庫頁面，不會包含以後章節的任何新增代碼。而Zip連接則提供了這份代碼庫的zip打包文件的下載地址。若是點擊Diff連接，打開的將會是本章節的代碼變動信息。

本章的GitHub連接爲: Browse, Zip, Diff.

安裝Python

你說你尚未安裝Python？那還等什麼！立馬安裝吧。若是操做系統默認沒有提供Python安裝包，能夠從Python官方網站下載。若是你使用Microsoft Windows操做系統而且打算使用WSL或者Cygwin，須要注意，不要在上面使用Windows版本的Python，而要使用類Unix版本，好比從Ubuntu獲取（對應WSL）或從Cygwin上獲取。

爲了驗證Python是否正確安裝，你能夠打開一個終端窗口並輸入python3（若是不存在這個命令，那就輸入python）。預期的輸出以下：

1 $ python3 2 Python 3.5.2 (default, Nov 17 2016, 17:05:23) 3 [GCC 5.4.0 20160609] on linux 4 Type "help", "copyright", "credits" or "license" for more information. 5 >>> _

 

Python解釋器中，光標不斷閃爍，等待着你輸入Python語句。在將來的章節中，你能夠充分體會到交互式解釋器的魅力。至少如今它可以幫你確認Python已經成功安裝的事實。能夠輸入exit()並回車來退出交互式解釋器。在Linux和Mac OS X操做系統上，按下快捷鍵Ctrl-D也能夠快速退出交互式解釋器。在Windows操做系統上，則是經過按下Ctrl-Z後跟上Enter快捷鍵來快速退出。

安裝Flask

下一步開始安裝Flask，在這以前我要告訴你安裝Python三方包的最佳實踐。

Python將全部三方包託管到一個公共倉庫，任何人都能從這個公共倉庫下載並安裝全部的三方包。Python將三方包公共倉庫命名爲PyPI以表示Python Package Index的縮寫(被一些人戲稱爲」cheese shop」)。從PyPI上安裝三方包很是簡單，Python專門提供了一個名爲pip的工具來解決這個問題（Python2.7中不含pip工具，須要單獨安裝）。

安裝三方包時，使用pip命令以下：

1 $ pip install <package-name>

 

有趣的是，這個方法在大多數狀況下不適用。假如Python解釋器是全局安裝的，全部用戶都能使用，那麼普通用戶則沒有權限來修改它，所以只能用管理員帳戶來執行安裝操做。即便忽略操做的複雜性，使用這種全局安裝的方式會發生什麼？pip工具從PyPI上下載三方包並安裝到全局Python目錄下，即刻起，全部Python腳本均可以訪問到這個三方包。想象這樣一個場景，你以前用當時的最新版本Flask——0.11版本的Flask開發了一個Web應用，如今Flask已經更新到了0.12版本，你想要使用0.12版本的Flask開發第二個Web應用。可是，若是將Flask從0.11版本升級到0.12版本可能會致使第一個Web應用出現故障。解決這個問題的方法最好不過爲舊Web應用安裝和使用Flask0.11版本，爲新Web應用安裝和使用Flask0.12版本。

爲了解決維護不一樣應用程序對應不一樣版本的問題，Python使用了虛擬環境的概念。 虛擬環境是Python解釋器的完整副本。在虛擬環境中安裝三方包時只會做用到虛擬環境，全局Python解釋器不受影響。 那麼，就爲每一個應用程序安裝各自的虛擬環境吧。 虛擬環境還有一個好處，即它們由建立它們的用戶所擁有，因此不須要管理員賬戶。

咱們先建立項目目錄，我將這個應用命名爲microblog：

1 $ mkdir microblog 2 $ cd microblog

若是你正在使用Python3，虛擬環境已經成爲內置模塊，能夠直接經過以下命令來建立它：

1 $ python3 -m venv venv

 

譯者注：這個命令不必定可以執行成功，好比譯者在Ubuntu16.04環境下執行，提示須要先安裝對應的依賴。sudo apt-get install python3-venv

使用這個命令來讓Python運行venv包，它會建立一個名爲venv的虛擬環境。 命令中的第一個「venv」是Python虛擬環境包的名稱，第二個是要用於這個特定環境的虛擬環境名稱。 若是你以爲這樣很混亂，能夠用你自定義的虛擬環境名字替換第二個venv。我習慣在項目目錄中建立了名爲venv的虛擬環境，因此不管什麼時候cd到一個項目中，都會找到相應的虛擬環境。

請注意，在一些操做系統中，你可能須要在上面的命令中使用python而不是python3。 一些安裝規範對Python 2.x版本使用python，對3.x版本使用python3，而另外一些則將python映射到3.x版本。

命令執行完成後，當前目錄下就會新增一個名爲venv的目錄來存儲這個虛擬環境的相關文件。

若是你使用的Python版本低於3.4（包括2.7版本），則不會默認支持虛擬環境。 對於這些版本的Python，在建立虛擬環境以前，須要下載並安裝稱爲virtualenv的第三方工具。 一旦安裝了virtualenv，你可使用如下命令建立一個虛擬環境：

1 $ virtualenv venv

無論你用什麼方法建立虛擬環境，建立完畢以後還須要激活纔可以進入這個虛擬環境。 要激活你的全新虛擬環境，需使用如下命令：

1 $ source venv/bin/activate 2 (venv) $ _

若是你使用的是Microsoft Windows命令提示符窗口，則激活命令稍有不一樣：

1 $ venv\Scripts\activate 2 (venv) $ _

激活一個虛擬環境，終端會話的環境配置就會被修改，以後你鍵入python的時候，其實是調用的虛擬環境中的Python解釋器。 此外，終端提示符也被修改爲包含被激活的虛擬環境的名稱的格式。這種激活是臨時的和私有的，所以在關閉終端窗口時它們將不會保留，也不會影響其餘的會話。 那麼，當你須要同時打開多個終端窗口來調試不一樣的應用時，每一個終端窗口均可以激活不一樣的虛擬環境而不會相互影響。

成功建立和激活了虛擬環境以後，你能夠安裝Flask了，命令以下：

1 (venv) $ pip install flask

想要驗證安裝是否成功，能夠打開Python解釋器，並用import語句來導入它：

1 >>> import flask 2 >>> _

 

若是語句沒有報錯，那麼恭喜你，Flask安裝成功了！

「Hello, World」 Flask應用

Flask網站展現了一個僅有五行代碼的簡單示例應用程序。 而我會告訴你一個稍微更復雜的例子，它將爲你編寫更大的應用程序提供一個很好的基礎結構。

應用程序是存在於包中的。 在Python中，包含__init__.py文件的子目錄被視爲一個可導入的包。 當你導入一個包時，__init__.py會執行並定義這個包暴露給外界的屬性。

那就建立一個名爲app的包來存放整個應用吧。記得切換到microblog目錄下，並執行以下命令：

1 (venv) $ mkdir app

 

並在其下建立文件__init__.py，輸入以下的代碼：

1 from flask import Flask 2 app = Flask(__name__) 3 from app import routes

 

上面的腳本僅僅是從flask中導入的類Flask，並以此類建立了一個應用程序對象。 傳遞給Flask類的__name__變量是一個Python預約義的變量，它表示當前調用它的模塊的名字。當須要加載相關的資源，如我將在第二章講到的模板文件，Flask就使用這個位置做爲起點來計算絕對路徑。 代碼的最後，應用程序導入還沒有存在的routes模塊。

這段代碼，乍一看可能會讓人迷惑。

其一，這裏有兩個實體名爲app。 app包由app目錄和__init__.py腳原本定義構成，並在from app import routes語句中被引用。 app變量被定義爲__init__.py腳本中的Flask類的一個實例，以致於它成爲app包的屬性。

其二，routes模塊是在底部導入的，而不是在腳本的頂部。 最下面的導入是解決循環導入的問題，這是Flask應用程序的常見問題。 你將會看到routes模塊須要導入在這個腳本中定義的app變量，所以將routes的導入放在底部能夠避免因爲這兩個文件之間的相互引用而致使的錯誤。

那麼在routes模塊中有些什麼？ 路由是應用程序實現的不一樣URL。 在Flask中，應用程序路由的處理邏輯被編寫爲Python函數，稱爲視圖函數。 視圖函數被映射到一個或多個路由URL，以便Flask知道當客戶端請求給定的URL時執行什麼邏輯。

這是須要寫入到app/routes.py中的第一個視圖函數的代碼：

1 from app import app 2 
3 @app.route('/') 4 @app.route('/index') 5 def index(): 6     return "Hello, World!"

 

這個視圖函數簡單到只返回一個字符串做爲問候用語。 函數上面的兩個奇怪的＠app.route行是裝飾器，這是Python語言的一個獨特功能。 裝飾器會修改跟在其後的函數。 裝飾器的常見模式是使用它們將函數註冊爲某些事件的回調函數。 在這種狀況下，＠app.route修飾器在做爲參數給出的URL和函數之間建立一個關聯。 在這個例子中，有兩個裝飾器，它們將URL /和/index索引關聯到這個函數。 這意味着，當Web瀏覽器請求這兩個URL中的任何一個時，Flask將調用該函數並將其返回值做爲響應傳遞迴瀏覽器。這樣作是爲了在運行這個應用程序的時候會稍微有一點點意義。

要完成應用程序，你須要在定義Flask應用程序實例的頂層（譯者注：也就是microblog目錄下）建立一個命名爲microblog.py的Python腳本。 它僅擁有一個導入應用程序實例的行：

1 from app import app

 

還記得兩個app實體嗎？ 在這裏，你能夠在同一句話中看到二者。 Flask應用程序實例被稱爲app，是app包的成員。from app import app語句從app包導入其成員app變量。 若是你以爲這很混亂，你能夠重命名包或者變量。

只要確保所作的操做徹底正確，那麼你就能夠看到以下面的項目結構圖：

1 microblog/
2   venv/
3   app/
4     __init__.py 5  routes.py 6   microblog.py

 

無論你信不信，這個應用的第一個版本如今完成了！ 可是在運行以前，須要經過設置FLASK_APP環境變量告訴Flask如何導入它：

1 (venv) $ export FLASK_APP=microblog.py

 

若是你使用Microsoft Windows操做系統，在上面的命令中使用set替換export。

萬事俱備，只欠東風！運行以下命令來運行你的第一個Web應用吧：

1 (venv) $ flask run 2  * Serving Flask app "microblog" 3  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

 

服務啓動後將處於阻塞監聽狀態，將等待客戶端鏈接。 flask run的輸出代表服務器正在運行在IP地址127.0.0.1上，這是本機的迴環IP地址。 這個地址很常見，並有一個更簡單的名字，你可能已經看過：localhost。 網絡服務器監聽在指定端口號等待鏈接。 部署在生產Web服務器上的應用程序一般會在端口443上進行監聽，若是不執行加密，則有時會監聽80，但啓用這些端口須要root權限。 因爲此應用程序在開發環境中運行，所以Flask使用自由端口5000。 如今打開您的網絡瀏覽器並在地址欄中輸入如下URL：

http://localhost:5000/

 

或者，你也可使用另外一個URL：

http://localhost:5000/index

 

應用程序路由映射執行了嗎？ 第一個URL映射到/，而第二個映射到/ index。 這兩個路由都與應用程序中惟一的視圖函數相關聯，因此它們產生相同的輸出，即函數返回的字符串。 若是你輸入任何其餘網址，則會出現錯誤，由於只有這兩個URL被應用程序識別。

完成演示以後，你能夠按下Ctrl-C來中止Web服務。

真是可喜可賀！你已經成功地向成爲一名Web開發者的道路上邁出了重要的第一步！