Flask系列教程（8）——Flask-Migrate，flaskflask-migrate

Flask系列教程（8）——Flask-Migrate，flaskflask-migrate
Flask-Migrate

在實際的開發環境中，經常會發生資料庫修改的行為。一般我們修改資料庫不會直接手動的去修改，而是去修改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 Flaskfrom flask_sqlalchemy import SQLAlchemyfrom constants import DB_URIfrom flask_migrate import Migrateapp = Flask(__name__)app.config['SQLALCHEMY_DATABASE_URI'] = DB_URIapp.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = Truedb = 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/unixexport FLASK_APP='your_app.py'

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

flask db init

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

flask db migrate

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

flask db upgrade

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

constants.py檔案：常量檔案，用來存放資料庫配置。

# constants.pyHOSTNAME = '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.pyfrom flask_sqlalchemy import SQLAlchemydb = SQLAlchemy()

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

# models.pyfrom ext import dbclass 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 = usernameclass 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.pyfrom flask_migrate import Migrate,MigrateCommandfrom ext import dbfrom flask_script import Managerfrom flask import Flaskfrom constants import DB_URIimport modelsapp = Flask(__name__)app.config['SQLALCHEMY_DATABASE_URI'] = DB_URIapp.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = Truedb.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.pyfrom flask import Flaskfrom ext import dbapp = 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入門到項目實戰