本文將詳細探討Python Flask Web服務。我將首先簡單介紹Flask,然後將逐步進入Flask中的路由、模板、表單處理以及資料庫整合等高階概念,目標是能夠讓大家瞭解並掌握使用Flask來建立動態Web應用的技巧。
Flask是一個輕量級的Web伺服器閘道器介面(WSGI)web應用框架。它被設計為易於使用,同時也提供了擴充套件性,使用者可以自由地選擇將其與哪些第三方庫整合。Flask是"微"框架,這意味著其核心功能非常有限,但可以通過一系列的擴充套件來增強功能。
讓我們來看一下如何建立一個簡單的Flask應用。
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
if __name__ == '__main__':
app.run()
在這段程式碼中,我們首先匯入Flask模組,並建立一個Flask web伺服器範例。然後,我們定義了一個路由(route),即/
。這個路由對映到一個函數hello_world
,當用戶存取這個URL時,它會返回'Hello, World!'字串。
Flask通過提供裝飾器app.route
,使得定義路由變得簡單易行。但你知道我們也可以通過app.add_url_rule
方法直接新增路由嗎?這種方式提供了更多的靈活性,例如,可以為路由新增不同的HTTP方法。
def hello():
return "Hello, World!"
app.add_url_rule('/', 'hello', hello)
在上述程式碼中,app.add_url_rule
的第一個引數是URL規則,第二個引數是函數的別名,第三個引數是要對映的函數。
Flask使用jinja2模板庫。這個庫非常強大,可以讓你在HTML中嵌入Python程式碼。下面的例子展示瞭如何在Flask應用中使用模板:
from flask import render_template
@app.route('/hello/<name>')
def hello(name):
return render_template('hello.html', name=name)
render_template
函數用於渲染一個模板。它接收模板的名稱和一些模板變數作為引數,返回生成的HTML內容。在模板中,你可以使用{{ name }}
來顯示變數的值。
Flask-WTF是Flask中用於處理Web表單的擴充套件庫。它基於WTF Python,一個處理表單資料的Python庫。Flask-WTF還具有CSRF(跨站請求偽造)保護的功能。
讓我們
看一個簡單的例子:
from flask import request
from flask_wtf import FlaskForm
from wtforms import StringField
class MyForm(FlaskForm):
name = StringField('name')
@app.route('/submit', methods=('GET', 'POST'))
def submit():
form = MyForm()
if form.validate_on_submit():
return 'Hello, %s' % form.name.data
return render_template('submit.html', form=form)
在這個例子中,我們定義了一個表單類MyForm
,包含一個name
欄位。然後,我們在submit
路由中建立了一個該類的範例,並檢查表單是否通過驗證。如果表單有效,我們就返回一條歡迎資訊;否則,我們就渲染一個表單模板。
Flask-SQLAlchemy是一個為Flask應用提供SQLAlchemy支援的擴充套件庫。SQLAlchemy是Python中的一種ORM(物件關係對映)工具,可以將類對映到資料庫表。
from flask_sqlalchemy import SQLAlchemy
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
db = SQLAlchemy(app)
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
def __repr__(self):
return '<User %r>' % self.username
在這個例子中,我們首先設定資料庫的URL,然後建立一個SQLAlchemy
範例。接著,我們定義一個User
類,這個類繼承自db.Model
,並具有兩個屬性:id
和username
。這兩個屬性都是資料庫表的列。
當構建Web API時,Flask-RESTful是一個值得了解的擴充套件。它為快速建立REST API提供了簡單的方法。你可以通過定義Python類來實現API資源,並將HTTP方法(如GET、POST)對映到類的方法。
from flask_restful import Resource, Api
api = Api(app)
class HelloWorld(Resource):
def get(self):
return {'hello': 'world'}
api.add_resource(HelloWorld, '/')
在上述程式碼中,我們首先建立了一個Api物件,然後定義了一個資源類HelloWorld
,並在這個類中實現了一個get
方法。最後,我們使用api.add_resource
將HelloWorld
類繫結到/
URL。
Flask的藍圖功能讓我們能夠組織更大、更復雜的應用程式。你可以將藍圖視為Flask應用程式的一個子集,它可以擁有自己的路由、模板和靜態檔案。
下面是一個簡單的例子:
from flask import Blueprint
simple_page = Blueprint('simple_page', __name__)
@simple_page.route('/<page>')
def show(page):
return 'Page %s' % page
在這個例子中,我們首先建立了一個名為simple_page
的藍圖,然後為這個藍圖定義了一個路由show
。
Flask允許我們自定義錯誤處理常式,當特定的HTTP錯誤發生時,我們可以返回自定義的響應。以下是如何為404錯誤定義自定義處理常式的範例:
@app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
在這個例子中,我們使用app.errorhandler
裝飾器註冊一個新的錯誤處理常式。當404錯誤發生時,它將返回一個自定義的錯誤訊息。
Flask提供了幾個裝飾器,我們可以使用它們來註冊在處理請求的不同階段呼叫的函數。這些裝飾器包括before_first_request
、before_request
、after_request
和teardown_request
。
@app.before_request
def before_request():
print("This is executed BEFORE each request.")
在這個例子中,before_request
裝飾器的函數將在每個請求之前執行。
在Web開發中,我們常常需要儲存使用者的資訊,例如使用者的偏好設定或者登入狀態。Flask提供了Cookies和Sessions兩種方式來完成這個任務。
下面是如何在Flask中設定和讀取cookie的例子:
@app.route('/set')
def setcookie():
resp = make_response('Setting cookie!')
resp.set_cookie('username', 'the username')
return resp
@app.route('/get')
def getcookie():
username = request.cookies.get('username')
return 'The username is ' + username
在上述例子中,setcookie
路由設定了一個cookie,名為username
,getcookie
路由讀取並返回了這個cookie的值。
Flask的測試使用者端允許我們模擬向我們的應用傳送請求,並檢視響應。
def test_index():
client = app.test_client()
response = client.get('/')
assert response.status_code == 200
在上述程式碼中,我們首先建立了一個測試使用者端。然後,我們使用這個使用者端傳送一個GET請求到/
URL,最後,我們檢查響應的狀態碼是否為200。
這只是Flask強大功能的冰山一角,Flask的魅力遠不止於此,它還有許多豐富的擴充套件,比如Flask-Login用於處理使用者認證,Flask-Mail用於傳送郵件,Flask-Migrate用於處理資料庫遷移等等。
如有幫助,請多關注
個人微信公眾號:【Python全視角】
TeahLead_KrisChang,10+年的網際網路和人工智慧從業經驗,10年+技術和業務團隊管理經驗,同濟軟體工程本科,復旦工程管理碩士,阿里雲認證雲服務資深架構師,上億營收AI產品業務負責人。