在Flask Web應用程序中使用原始SQL對數據庫執行CRUD操作可能很繁瑣。相反, SQLAlchemy ,Python工具包是一個強大的OR Mapper,它爲應用程序開發人員提供了SQL的全部功能和靈活性。Flask-SQLAlchemy是Flask擴展,它將對SQLAlchemy的支持添加到Flask應用程序中。
ORM(Object Relation Mapping,對象關係映射)
先說說定義, 大多數編程語言平台是面向對象的。另一方面,RDBMS服務器中的數據存儲爲表。
對象關係映射是將對象參數映射到底層RDBMS表結構的技術。
ORM API提供了執行CRUD操作的方法,而不必編寫原始SQL語句。
使用SQLAlchemy構建一個小型Web應用程序。
步驟1 - 安裝Flask-SQLAlchemy擴展。
pip install flask-sqlalchemy
步驟2 - 您需要從此模塊導入SQLAlchemy類。
from flask_sqlalchemy import SQLAlchemy
步驟3 - 現在創建一個Flask應用程序對象並爲要使用的數據庫設置URI。
app = Flask(__name__) app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///students.sqlite3'
步驟4 - 然後使用應用程序對象作爲參數創建SQLAlchemy類的對象。該對象包含用於ORM操作的輔助函數。它還提供了一個父Model類,使用它來聲明用戶定義的模型。
在下面的代碼段中,創建了students 模型。
db = SQLAlchemy(app) class Students(db.Model): id = db.Column('student_id', db.Integer, primary_key = True) name = db.Column(db.String(100)) city = db.Column(db.String(50)) addr = db.Column(db.String(200)) pin = db.Column(db.String(10)) def __init__(self, name, city, addr, pin): self.name = name self.city = city self.addr = addr self.pin = pin
步驟5 - 要創建/使用URI中提及的數據庫,請運行create_all()方法。
db.create_all()
SQLAlchemy的Session對象管理ORM對象的所有持久性操作。
以下session方法執行CRUD操作:
db.session.add (模型對象) - 將記錄插入到映射表中
db.session.delete (模型對象) - 從表中刪除記錄
model.query.all() - 從表中檢索所有記錄(對應於SELECT查詢)。
您可以通過使用filter屬性將過濾器應用於檢索到的記錄集。例如,要在學生表中檢索city ='Hyderabad'的記錄,請使用以下語句:
Students.query.filter_by(city = 'Hyderabad').all()
有了這麽多的背景,現在我們將爲我們的應用程序提供視圖函數來添加學生數據。
應用程序的入口點是綁定到'/' URL的show_all()函數。學生表的記錄集作爲參數發送到HTML模板。模板中的服務器耑代碼以HTML表格形式呈現記錄。
@app.route('/') def show_all(): return render_template('show_all.html', students = students.query.all())
模板('show_all.html')的HTML腳本如下:
<!DOCTYPE html> <html lang="en"> <head></head> <body> <h3> <a href="{{ url_for('show_all') }}">Comments - Flask SQLAlchemy 例子</a> </h3> <hr/> {%- for message in get_flashed_messages() %} {{ message }} {%- endfor %} <h3>Students (<a href="{{ url_for('new') }}">Add Student</a>)</h3> <table> <thead> <tr> <th>姓名</th> <th>城市</th> <th>詳細地址</th> <th>郵編</th> </tr> </thead> <tbody> {% for student in students %} <tr> <td>{{ student.name }}</td> <td>{{ student.city }}</td> <td>{{ student.addr }}</td> <td>{{ student.postcode }}</td> </tr> {% endfor %} </tbody> </table> </body> </html>
上述網頁包含指向'/new' URL映射new()函數的超鏈接。單擊時,將打開“學生信息”表單。 數據在 POST方法中發布到相同的URL。
new.html 源碼
<!DOCTYPE html> <html> <body> <h3>表單表單表單</h3> <hr/> {%- for category, message in get_flashed_messages(with_categories = true) %} <div class = "alert alert-danger"> {{ message }} </div> {%- endfor %} <form action="{{ request.path }}" method="POST"> <label for="name">Name</label> <br> <input type="text" name="name" placeholder="姓名"/> <br> <label for="city">城市</label><br> <input type="text" name="city" placeholder="城市"/> <br> <label for="addr">地址</label><br> <textarea name="addr" placeholder="詳細地址"></textarea> <br> <label for="postcode">郵編</label><br> <input type="text" name="postcode" placeholder="郵編"/> <br> <input type="submit" value="submit" /> </form> </body> </html>
當http方法被檢測爲POST時,表單數據被添加到學生表中,並且應用返回到顯示添加數據的主頁。
@app.route('/new', methods = ['GET', 'POST']) def new(): if request.method == 'POST': if not request.form['name'] or not request.form['city'] or not request.form['addr']: flash('Please enter all the fields', 'error') else: student = students(request.form['name'], request.form['city'], request.form['addr'], request.form['pin']) db.session.add(student) db.session.commit() flash('Record was successfully added') return redirect(url_for('show_all')) return render_template('new.html')
下面給出了應用程序(app.py)的完整代碼。
from flask import Flask, request, flash, url_for, redirect, render_templatefrom flask_sqlalchemy import SQLAlchemy from flask_sqlalchemy import SQLAlchemy app = Flask(__name__) app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///students.sqlite3' app.config['SECRET_KEY'] = "random string" db = SQLAlchemy(app) class students(db.Model): id = db.Column('student_id', db.Integer, primary_key = True) name = db.Column(db.String(100)) city = db.Column(db.String(50)) addr = db.Column(db.String(200)) pin = db.Column(db.String(10)) def __init__(self, name, city, addr,pin): self.name = name self.city = city self.addr = addr self.pin = pin@ app.route('/') def show_all(): return render_template('show_all.html', students = students.query.all() ) @app.route('/new', methods = ['GET', 'POST']) def new(): if request.method == 'POST': if not request.form['name'] or not request.form['city'] or not request.form['addr']: flash('Please enter all the fields', 'error') else: student = students(request.form['name'], request.form['city'], request.form['addr'], request.form['pin']) db.session.add(student) db.session.commit() flash('Record was successfully added') return redirect(url_for('show_all')) return render_template('new.html') if __name__ == '__main__': db.create_all() app.run(debug = True)
從shell運行上述腳本,並在瀏覽器中輸入http://localhost:5000/。如果你搞對了, 正常頁面上會看到一個信息表單, 點擊“添加學生”鏈接以打開學生信息表單。填寫表單並提交。頁面將重新顯示提交的數據。