初探 Flask

前言

Flask 是一個使用 Python 語言開發的輕量級 Web 應用框架，程式碼直觀、結構清晰，非常適合新手作為網頁開發的入門。以下我將就簡單的幾個範例說明，方便快速入門**。**

更詳細可參看: https://flask.palletsprojects.com/en/stable/

安裝所需套件

pip3 install flask

一個簡單版的 Flask 專案 範例

app.py

from flask import Flask
from flask import request

app = Flask(__name__)

@app.route("/")
def hello_world():
    return "<p>Hello, World!</p>"

if __name__ == "__main__":
    app.run(debug=True)

@app.route("/"): 路由（Routing）。這行程式碼告訴 Flask，當使用者瀏覽網站的首頁（/）時，就去執行下面的 hello_world() 函數，並把結果回傳給使用者的瀏覽器。

debug=True: 修改程式後自動重啟，發生錯誤時顯示詳細資訊

有關 Flask 基本流程

啟動

啟動網站有幾種方法

%flask --app app run

如果檔案名稱是 app.py 或 wsgi.py，則無需使用 --app 參數。

%flask run

%python3 app.py

執行結果

http://127.0.0.1:5000

接收網址參數

略 ...

# 接收網址參數
@app.route("/user/<name>")
def user(name):
    return f"<h1>Hello {name}</h1>"

# 啟動 Server
if __name__ == "__main__":
    app.run(debug=True)

執行結果

HTTP 方法

在存取 URL 時會使用不同的 HTTP 方法(GET, POST . . .)

略 ...

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        # 當使用者填完表單按下送出 POST
        return do_the_login()
    else:
        # 當使用者第一次瀏覽網頁 GET
        return show_the_login_form()
    
    
def do_the_login():
    # 從前端 POST 提交的表單中獲取資料
    username = request.form.get('username')
    password = request.form.get('password')
    
    # 簡單的帳密驗證範例
    if username == "admin" and password == "123456":
        return f"<h1>登入成功！</h1><p>歡迎回來，{username}!</p>"
    else:
        return "<h1>登入失敗！</h1><p>帳號或密碼錯誤，請回上一頁重試。</p>"

# ===== 1. 顯示登入表單的頁面 =====
def show_the_login_form():
    # 回傳一個簡單的 HTML 表單,action 指向同一個路由，方法為 POST
    return '''
        <form method="post" style="margin: 50px; line-height: 2;">
            <h2>登入範例</h2>
            <label>帳號: </label>
            <input type="text" name="username" placeholder="請輸入 admin"><br>
            <label>密碼: </label>
            <input type="password" name="password" placeholder="請輸入 123456"><br>
            <button type="submit">登入</button>
        </form>
    '''
# 啟動 Server
if __name__ == "__main__":
    app.run(debug=True)

執行結果

渲染模板

使用Jinja2渲染 HTML 模板。我們可以使用 render_template() 函數動態地提供 HTML 文件，而不是在路由中傳回純字串。

login.html

<!doctype html>
<title>登入範例</title>
<form method="post" style="margin: 50px; line-height: 2">
  <h2>登入範例</h2>
  <label>帳號: </label>
  <input type="text" name="username" placeholder="請輸入 admin" /><br />
  <label>密碼: </label>
  <input type="password" name="password" placeholder="請輸入 123456" /><br />
  <button type="submit">登入</button>
</form>

app.py

from flask import Flask, render_template

略 ...

def show_the_login_form():
    # 回傳一個簡單的 HTML 表單,action 指向同一個路由，方法為 POST
    return render_template("login.html")

執行結果

Flask 與 REST API

略 . . .

@app.route("/api/hello")
def hello():
    return {
        "message": "Hello API"
    }
    
@app.route("/api/users")
def users():
    data = [
        {
            "id": 1,
            "name": "Danny"
        },
        {
            "id": 2,
            "name": "Alice"
        }
    ]

    return data
    
# 啟動 Server
if __name__ == "__main__":
    app.run(debug=True)

執行結果