flask连接数据库——flask-SQLALchemy

mr. 刘liu 2023-06-21 原文

SQLALchemy介绍：

sqlalchemy是数据库的orm框架，让我们操作数据库的时候不要再用sql语句了，跟直接操作模型一样。

请求钩子：

在请求开始时，建立数据库连接；
在请求开始时，根据需求进行权限校验；
在请求结束时，指定数据的交互格式；

@app.before_first_request
#只有第一次请求之前调用，可以在此方法内部做一些初始化操作


@app.before_request
#每次请求之前都会触发
#在每一次请求之前调用，这时候已经有请求了，可能在这个方法里面做请求的校验
#如果请求的校验不成功，可以直接在此方法中进行响应，直接return之后那么就不会执行视图函数

@app.after_request
#在每次执行完视图函数之后会调用，要传入函数响应
#在执行完视图函数之后会调用，并且会把视图函数所生成的响应传入，可以在此方法中对应响应做最后一步统一的处理

@app.teardown_request
#每一次请求之后都会调用，会接受一个参数，参数是服务器出现的错误信息

sqlalchemy与Flask-sqlalchemy的区别：

sqlalchemy：是一个独立的ORM框架，可以独立于Flask存在，也可以在其他项目中使用，比如Django中。
Flask-sqlalchemy：对sqlalchemy的一个封装，能够更适合在flask中使用。

一、安装
1、安装连接数据库的库：pip install pymysql
2、安装： pip install flask-sqlalchemy

二、连接数据库：

基本的配置：
1: 首先先安装两个依赖的包。
2：配置数据库的连接：app.config[‘SQLALCHEMY_DATABASE_URI’] = “mysql://root:mysql@192.168.44.128:3306/test39”
3：关闭数据库的跟踪：app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS’] = False
4：开启输出sql语句：app.config[‘SQLALCHEMY_ECHO’] = True
5：两种处理python2和python3的名字不一致问题。

from flask import Flask
from flask_restful import Api, Resource
from flask_sqlalchemy import SQLAlchemy

#import pymysql
#pymysql.install_as_MySQLdb()

"""
python2中数据库客户端： MySqldb
python3中数据库客户端：pymysql
解决方案一：让python2和python3的包进行转换。
import pymysql
pymysql.install_as_MySQLdb()

方案二：表示只使用python3的包，不使用python2的包
app.config['SQLALCHEMY_DATABASE_URI'] = "mysql+pymysql://root:mysql@192.168.44.128:3306/test39"
"""

app = Flask(__name__)
db = SQLAlchemy(app) #创建一个对象，设置名为db

# app.config['SQLALCHEMY_DATABASE_URI'] = "mysql://账号:密码@数据库ip地址:端口号/数据库名"
app.config['SQLALCHEMY_DATABASE_URI'] = "mysql+pymysql://root:mysql@192.168.44.128:3306/test39"
# app.config['SQLALCHEMY_BINDS'] = {}

# 关闭数据库修改跟踪操作[提高性能]，可以设置为True，这样可以跟踪操作：
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

# 开启输出底层执行的sql语句
app.config['SQLALCHEMY_ECHO'] = True

# 开启数据库的自动提交功能[一般不使用]
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True

@app.route('/')
def hello_word():
    return "hello, word"

if __name__ == '__main__':
    print(app.url_map)
    app.run(host='0.0.0.0', port= 8000, debug=True)

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
db = SQLAlchemy(app) #创建一个对象，设置名为db


#建立数据库连接
#app.config['SQLALCHEMY_DATABASE_URI'] = "mysql://账号:密码@数据库ip地址:端口号/数据库名"
app.config['SQLALCHEMY_DATABASE_URI'] = "mysql+pymysql://root:mysql@192.168.44.128:3306/test39"



验证是否连接成功
@app.route('/')
def hello_word():

	engine = db.get_engine()
	conn = engine.connect()
	conn.close() #跟open函数一样，可以用with语句
	#with engine.connect() as conn:
	#	result = conn.execute('select 1')  #这两步打开数据库并且创建表
	#	print (result.fetchone()) #打印一条数据
    return "hello, word"



创建模型并进行数据增删改查
#创建orm模型---
class mmm(db.Model):
	__tablename__ = 'mmm'  # 设置表名
	id = db.Column(db.Integer,primary_key,autoincreament)
	title = db.Column(db.string(200),nullable=Flase)
	content = db.Column(db.Text,nullable=Flase)

db.create_all()

    # 删除所有继承自db.Model的表
   	# db.drop_all()
    # 创建所有继承自db.Model的表
    #db.create_all()


数据操作——增删改查
1：给模型对象设置数据 可以通过 初始化参数 或者 赋值属性 两种方式
2：session.add(模型对象) 添加单条数据到会话中, session.add_all(列表) 添加多条数据到会话中
3：sqlalchemy 会 自动创建事务, 并将数据操作包含在事务中, 提交会话时就会提交事务，事务提交失败会自动回滚。

@app.route('/mmm")
def mmm_view():
	#1. 添加数据
	# sql语句为 insert table mmm value （xxx），这里不用
	#之前创建了mmm类对象，所以直接调用即可
	article = mmm（title= "",content=""）
	
	#数据添加
	db.session.add(article)  
	#数据提交
	db.session.commit()
	#最后进行返回操作
	return "数据操作成功"
	
	#2.查询数据
	# filter_by() 返回一个类列表的对象
	artice = mmm.query.filter_by(id=1)[0] #进行查询，根据谁进行查询,必须用 []将值取出来
	print（artice.title） #将id为1的title取出来
	return	"数据操作成功"


	#3.修改数据
	artice = mmm.query.filter_by(id=1)[0] 
	artice.content = "xxx"  #将id为一的content的数据改成xxx
	#修改数据的进行数据提交
	db.session.commit
	return "数据操作成功"


	#4.删除数据
	mmm.query.filter_by(id=1).delete()
	db.session.commit()
	return "数据操作成功"

表关系：

表之间的关系存在三种：
一对一，一对多，多对多，而SQLAlchemy中的ORM也可以模拟这三种关系，因为一对一其实在SQLAlchemy中底层是通过一对多的方式模拟的，所以先看一下一对多的关系：

外键：
在mysql中，外键可以让表之间的关系更加紧密，而SQLAlchemy同样也支持外键，通过foreignkey类来实现，并且可以指定表的外键约束。

class user(db.Model):
	__tablename__ = 'mmm'  # 设置表名
	id = db.Column(db.Integer,primary_key,autoincreament)
	username = db.Column(db.string(200),nullable=)



class Article(db.Model):
	__tablename__ = 'ggg'  # 设置表名
	id = db.Column(db.Integer,primary_key,autoincreament)
	title = db.Column(db.string(200),nullable=Flase)
	content = db.Column(db.Text,nullable=Flase)
	

	#外键
	#1.外键的数据类型一定要看所引用的字段类型，要一样
	#2. db.Foreignkey("表名. 字段名")
	#3.外键是属于数据库层面的，不推荐直接在ORM直接使用
	author_id = db.Column(db.Integer,db.Foreignkey("user.id"))


	#relationship
	#1.第一个参数是模型的名字，必须要和模型的名字一致
	#2.backref（bsck reference）：代表反向引用，代表对方访问我的时候的字段名称
	author = db.relationship("user",backref="articles")


	#一对一：
	# db.backref
	#1. 在反向引用的时候，如果需要传递一些其他的参数，那么就需要用到这个函数，否则不需要使用，只要在relationship的backref参数上，设置反向引用的名称就可以了。
	#2. uselist=Flase ：代表反向引用的名称就可以了
	user = db.relationship("User",backref=db.backref("extension",uselist=Flase))

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 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 db init

然后再把当前的模型添加到迁移文件中：

flask db migrate

最后再把迁移文件中对应的数据库操作，真正的映射到数据库中：

flask db upgrade

二、项目重构：
现在是所有代码都写在一个文件中，这样会导致文件会越来越乱。所以进行一下项目重构，设置为以下的目录结构：
以下对各个文件的作用进行解释。

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

app.py文件：
这个是主app文件，运行文件。并且因为db被放到另外一个文件中，所以使用db.init_app(app)的方式来绑定数据库。

# app.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()

三、迁移命令：
通过以上项目重构后，后续我们就只要通过以下三个命令即可完成迁移操作了。

在命令行中映射ORM了。首先需要初始化一个迁移文件夹：

flask db init