iT邦幫忙

2021 iThome 鐵人賽

DAY 12
0
Software Development

都是 P 開頭的程式語言,你是在 py 啥啦系列 第 12

[12] [燒瓶裡的部落格] 02. 定義和使用資料庫 - 使用 SQLite

什麼是 SQLite

SQLite 是遵守ACID的關聯式資料庫管理系統,基於單一文件所組成且格式定義明確
因為不需要單獨設定一個資料庫服務,所以很適合開發階段
但因為寫入是按順序執行的,當併發請求同時要寫入時會比較慢一點
小型應用程式沒有問題,大型應用程式就不太適合

Python 內建了對 SQLite 的支援,對應的模組是 sqlite3

連接資料庫

當要使用 SQLite 資料庫,或是其他多數的資料庫時,第一件事情就是建立一個資料庫連線
所有查詢和操作都要透過該連線來執行,並且執行完之後要關閉連線

建立檔案 flaskr/db.py

import sqlite3

import click
from flask import current_app, g
from flask.cli import with_appcontext


def get_db():
    if 'db' not in g:
        g.db = sqlite3.connect(
            current_app.config['DATABASE'],
            detect_types=sqlite3.PARSE_DECLTYPES
        )
        g.db.row_factory = sqlite3.Row

    return g.db


def close_db(e=None):
    db = g.pop('db', None)

    if db is not None:
        db.close()

g

g 是一個特殊物件,獨立於每一個請求
在處理請求過程中用於儲存可能多個函數都會用到的資料
把連線儲存於其中,就可以重複使用
而不用在同一個請求中每次呼叫 get_db 時都建立一個新的連線,實現單例模式

sqlite3.connect()

建立一個資料庫連線,連線會指向設定中的DATABASE指定的檔案
這個檔案現在還沒有建立,後面會在初始化資料庫的時候建立

current_app

這是另一個特殊物件,該物件指向正在處理請求的 Flask 應用
使用工廠模式之後,在專案的程式中就不會直接呼叫應用程式物件
建立應用程式後,處理請求時會呼叫get_db,這時候就可以使用 current_app

sqlite3.Row

告訴連線回傳類似於字典(dict)的 row,這樣可以通過 columns 名稱來存取資料

close_db

通過檢查 g.db 來確定連線是否已經建立,如果連接已建立就關閉連線
之後會在應用工廠中告訴應用程式close_db函數
這樣每次請求結束後就會呼叫它來關閉連線

建立資料表

在 SQLite 中,資料儲存在 tablescolumns 中,在儲存和讀取資料之前需要先建立它們
Flaskr 會把使用者資料儲存在user表中,把部落格內容儲存post表中
底下我們建立一個文件儲存用於創建空 table 的 SQL 指令

flaskr/schema.sql

DROP TABLE IF EXISTS user;
DROP TABLE IF EXISTS post;

CREATE TABLE user (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  username TEXT UNIQUE NOT NULL,
  password TEXT NOT NULL
);

CREATE TABLE post (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  author_id INTEGER NOT NULL,
  created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
  title TEXT NOT NULL,
  body TEXT NOT NULL,
  FOREIGN KEY (author_id) REFERENCES user (id)
);

接著在db.py中添加 Python 函數,用來執行這個 SQL 指令

flaskr/db.py

def init_db():
    db = get_db()

    with current_app.open_resource('schema.sql') as f:
        db.executescript(f.read().decode('utf8'))


@click.command('init-db')
@with_appcontext
def init_db_command():
    """Clear the existing data and create new tables."""
    init_db()
    click.echo('Initialized the database.')

open_resource()

打開一個檔案,檔名是相對於flaskr的,這樣就不需要考慮以後應用具體部署在哪個路徑
get_db 回傳一個資料庫連線,用於執行檔案中的指令

click.command()

定義一個名為init-db指令,它呼叫init_db函數,並為使用者顯示一個成功的訊息
更多關於指令的寫法可以參考:Command Line Interface

在應用程式中註冊

close_dbinit_db_command函數需要在應用的實體中註冊,否則無法使用
因為我們使用了工廠函數,所以光是寫好函數是無法直接使用的
我們需要寫一個函數,把應用作為參數,在函數中進行注冊

flaskr/db.py

def init_app(app):
    app.teardown_appcontext(close_db)
    app.cli.add_command(init_db_command)

app.teardown_appcontext()

告訴 Flask 在回傳 response 後呼叫這個函數來斷開連線

app.cli.add_command()

添加一個新的、可以被flask指令呼叫的指令方法

下一步是在工廠中導入並呼叫這個函數
在工廠函數中把新的程式放到create_app函數的最後,return app之前

flaskr/init.py

def create_app():
    app = ...
    # existing code omitted

    from . import db
    db.init_app(app)

    return app

初始化資料庫檔案

現在init-db已經在應用中註冊好了,可以和flask指令一起使用
使用方式和之前的flask run類似

停止之前執行中的 flask 服務,或是另外開一個終端機視窗
如果是開新的終端機執行,那必須重新設定FLASK_APPFLASK_ENV

執行完之後會有一個flaskr.sqlite檔案出現在專案資料夾的instance資料夾中!
一般來說會把 instance 資料夾加入.gitignore


上一篇
[11] [燒瓶裡的部落格] 01. 初始化一個 Flask 專案 - 使用工廠模式
下一篇
[13] [燒瓶裡的部落格] 03. Blueprints 和 View function
系列文
都是 P 開頭的程式語言,你是在 py 啥啦30

尚未有邦友留言

立即登入留言