Flask-Migrate

如果想深入學習Flask，可以觀看這套免費Flask教學視訊：零基礎：Flask入門到專案實戰

在實際的開發環境中，經常會發生資料庫修改的行為。一般我們修改資料庫不會直接手動的去修改，而是去修改ORM對應的模型，然後再把模型對映到資料庫中。這時候如果有一個工具能專門做這種事情，就顯得非常有用了，而flask-migrate就是做這個事情的。flask-migrate是基於Alembic進行的一個封裝，並整合到Flask中，而所有的遷移操作其實都是Alembic做的，他能跟蹤模型的變化，並將變化對映到資料庫中。

使用Flask-Migrate需要安裝，命令如下：

pip install flask-migrate

要讓Flask-Migrate能夠管理app中的資料庫，需要使用Migrate(app,db)來繫結app和資料庫。假如現在有以下app檔案：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from constants import DB_URI
from flask_migrate import Migrate

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = DB_URI
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'
 
] = True
db = SQLAlchemy(app)
# 繫結app和資料庫
migrate = Migrate(app,db)

class User(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    username = db.Column(db.String(20))

    addresses = db.relationship('Address',backref='user')

class Address(db.Model):
    id = db.Column(db.Integer,primary_key=True
 
)
    email_address = db.Column(db.String(50))
    user_id = db.Column(db.Integer,db.ForeignKey('user.id'))

db.create_all()

@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

之後，就可以在命令列中對映ORM了。要操作當前的flask app，首先需要將當前的app匯入到環境變數中：

# windows
$env:FLASK_APP='your_app.py'

#linux/unix
export FLASK_APP='your_app.py'

將當前的app匯入到環境變數中後，接下來就是需要初始化一個遷移資料夾：

flask db init

然後再把當前的模型新增到遷移檔案中：

flask db migrate

最後再把遷移檔案中對應的資料庫操作，真正的對映到資料庫中：

flask db upgrade

以上是通過載入當前的app到環境變數的做法，這種做法有點麻煩，每次都要設定環境變數。還有一種方法，可以直接通過flask-script的方式進行呼叫。現在重構之前的專案，設定為以下的目錄結構：
以下對各個檔案的作用進行解釋：

constants.py檔案：

常量檔案，用來存放資料庫配置。

# constants.py
HOSTNAME = '127.0.0.1'
PORT = '3306'
DATABASE = 'xt_flask_migrate'
USERNAME = 'root'
PASSWORD = 'root'
DB_URI = 'mysql+mysqldb://{}:{}@{}:{}/{}'.format(USERNAME,PASSWORD,HOSTNAME,PORT,DATABASE)

ext.py檔案：

把db變數放到一個單獨的檔案，而不是放在主app檔案。這樣做的目的是為了在大型專案中如果db被多個模型檔案引用的話，會造成from your_app import db這樣的方式，但是往往也在your_app.py中也會引入模型檔案定義的類，這就造成了迴圈引用。所以最好的辦法是把它放在不依賴其他模組的獨立檔案中。

# ext.py
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()

models.py檔案：模型檔案，用來存放所有的模型，並且注意，因為這裡使用的是flask-script的方式進行模型和表的對映，因此不需要使用db.create_all()的方式建立資料庫。

# models.py
from ext import db
class User(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    username = db.Column(db.String(50))
    addresses = db.relationship('Address',backref='user')

    def __init__(self,username):
        self.username = username

class Address(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    email_address = db.Column(db.String(50))
    user_id = db.Column(db.Integer,db.ForeignKey('user.id'))

    def __init__(self,email_address):
        self.email_address = email_address

manage.py檔案：

這個檔案用來存放對映資料庫的命令，MigrateCommand是flask-migrate整合的一個命令，因此想要新增到指令碼命令中，需要採用manager.add_command('db',MigrateCommand)的方式，以後執行python manage.py db xxx的命令，其實就是執行MigrateCommand。

# manage.py
from flask_migrate import Migrate,MigrateCommand
from ext import db
from flask_script import Manager
from flask import Flask
from constants import DB_URI
import models
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = DB_URI
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
db.init_app(app)
migrate = Migrate(app,db)
manager = Manager(app)
manager.add_command('db',MigrateCommand)

if __name__ == '__main__':
    manager.run()

flaskmigrate.py檔案：

這個是主app檔案，執行檔案。並且因為db被放到另外一個檔案中，所以使用db.init_app(app)的方式來繫結資料庫。

# flaskmigrate.py
from flask import Flask
from ext import db

app = Flask(__name__)
db.init_app(app)

@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

之後執行命令來初始化遷移檔案：

python manage.py db init

然後執行命令來將模型的對映新增到檔案中：

python manage.py db migrate

最後新增將對映檔案真正的對映到資料庫中：

python manage.py db upgrade

如果想深入學習Flask，可以觀看這套免費Flask教學視訊：零基礎：Flask入門到專案實戰