ORM
ORM 全拼 Object-Relation Mapping，中文意为 对象-关系映射。主要实现模型对象到关系数据库数据的映射
优点 :
-
只需要面向对象编程, 不需要面向数据库编写代码.
-
对数据库的操作都转化成对类属性和方法的操作.
-
不用编写各种数据库的
sql语句.
-
-
实现了数据模型与数据库的解耦, 屏蔽了不同数据库操作上的差异.
-
不再需要关注当前项目使用的是哪种数据库。
-
通过简单的配置就可以轻松更换数据库, 而不需要修改代码.
-
缺点 :
-
相比较直接使用SQL语句操作数据库,有性能损失.
-
根据对象的操作转换成SQL语句,根据查询的结果转化成对象, 在映射过程中有性能损失.
Flask-SQLAlchemy
flask默认提供模型操作，但是并没有提供ORM，所以一般开发的时候我们会采用flask-SQLAlchemy模块来实现ORM操作。
SQLAlchemy是一个关系型数据库框架，它提供了高层的 ORM 和底层的原生数据库的操作。flask-sqlalchemy 是一个简化了 SQLAlchemy 操作的flask扩展。
SQLAlchemy: https://www.sqlalchemy.org/
安装 flask-sqlalchemy
pip install flask-sqlalchemy
如果连接的是 mysql 数据库，需要安装 mysqldb 驱动
pip install flask-mysqldb
数据库连接设置
-
在 Flask-SQLAlchemy 中，数据库使用URL指定，而且程序使用的数据库必须保存到Flask配置对象的 SQLALCHEMY_DATABASE_URI 键中
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:mysql@127.0.0.1:3306/test'
-
其他设置
# 动态追踪修改设置，如未设置只会提示警告 app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True #查询时会显示原始SQL语句 app.config['SQLALCHEMY_ECHO'] = True
-
配置完成需要去 MySQL 中创建项目所使用的数据库
$ mysql -uroot -p123456
$ create database flaskdemo charset=utf8;
常用的SQLAlchemy字段类型
| 类型名 | python中类型 | 说明 |
|---|---|---|
| Integer | int | 普通整数，一般是32位 |
| SmallInteger | int | 取值范围小的整数，一般是16位 |
| BigInteger | int或long | 不限制精度的整数 |
| Float | float | 浮点数 |
| Numeric | decimal.Decimal | 普通整数，一般是32位 |
| String | str | 变长字符串 |
| Text | str | 变长字符串，对较长或不限长度的字符串做了优化 |
| Unicode | unicode | 变长Unicode字符串 |
| UnicodeText | unicode | 变长Unicode字符串，对较长或不限长度的字符串做了优化 |
| Boolean | bool | 布尔值 |
| Date | datetime.date | 时间 |
| Time | datetime.datetime | 日期和时间 |
| LargeBinary | str | 二进制文件 |
常用的SQLAlchemy列选项
| 选项名 | 说明 |
|---|---|
| primary_key | 如果为True，代表表的主键 |
| unique | 如果为True，代表这列不允许出现重复的值 |
| index | 如果为True，为这列创建索引，提高查询效率 |
| nullable | 如果为True，允许有空值，如果为False，不允许有空值 |
| default | 为这列定义默认值 |
常用的SQLAlchemy关系选项
| 选项名 | 说明 |
|---|---|
| backref | 在关系的另一模型中添加反向引用,用于设置外键名称,在1查多的 |
| primary join | 明确指定两个模型之间使用的联结条件 |
| uselist | 如果为False，不使用列表，而使用标量值 |
| order_by | 指定关系中记录的排序方式 |
| secondary | 指定多对多关系中关系表的名字 |
| secondary join | 在SQLAlchemy中无法自行决定时，指定多对多关系中的二级联结条件 |
数据库基本操作
-
在Flask-SQLAlchemy中，插入、修改、删除操作，均由数据库会话管理。
-
会话用 db.session 表示。在准备把数据写入数据库前，要先将数据添加到会话中然后调用 commit() 方法提交会话。
-
-
在 Flask-SQLAlchemy 中，查询操作是通过 query 对象操作数据。
-
最基本的查询是返回表中所有数据，可以通过过滤器进行更精确的数据库查询。
-
在视图函数中定义模型类
from flask import Flask from flask_sqlalchemy import SQLAlchemy app = Flask(__name__) #设置连接数据库的URL app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:mysql@127.0.0.1:3306/test' app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True #查询时会显示原始SQL语句 app.config['SQLALCHEMY_ECHO'] = True db = SQLAlchemy(app) class Role(db.Model): # 定义表名 __tablename__ = 'roles' # 定义列对象 id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(64), unique=True) us = db.relationship('User', backref='role') # repr()方法类似于django的__str__，用于打印模型对象时显示的字符串信息 def __repr__(self): return 'Role:%s'% self.name class User(db.Model): __tablename__ = 'users' id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(64), unique=True) email = db.Column(db.String(64),unique=True) password = db.Column(db.String(64)) role_id = db.Column(db.Integer, db.ForeignKey('roles.id')) def __repr__(self): return 'User:%s'%self.name if __name__ == '__main__': app.run(debug=True)
模型之前的关联
一对多
class Role(db.Model): ... #关键代码 us = db.relationship('User', backref='role', lazy='dynamic') ... class User(db.Model): ... role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
-
其中realtionship描述了Role和User的关系。在此文中，第一个参数为对应参照的类"User"
-
第二个参数backref为类User申明新属性的方法
-
第三个参数lazy决定了什么时候SQLALchemy从数据库中加载数据
-
如果设置为子查询方式(subquery)，则会在加载完Role对象后，就立即加载与其关联的对象，这样会让总查询数量减少，但如果返回的条目数量很多，就会比较慢
-
设置为 subquery 的话，role.users 返回所有数据列表
-
-
另外,也可以设置为动态方式(dynamic)，这样关联对象会在被使用的时候再进行加载，并且在返回前进行过滤，如果返回的对象数很多，或者未来会变得很多，那最好采用这种方式
-
设置为 dynamic 的话，role.users 返回查询对象，并没有做真正的查询，可以利用查询对象做其他逻辑，比如：先排序再返回结果
-
-
多对多
registrations = db.Table('registrations', db.Column('student_id', db.Integer, db.ForeignKey('students.id')), db.Column('course_id', db.Integer, db.ForeignKey('courses.id')) ) class Course(db.Model): ... class Student(db.Model): ... courses = db.relationship('Course',secondary=registrations, backref='students', lazy='dynamic')
常用的SQLAlchemy查询过滤器
| 过滤器 | 说明 |
|---|---|
| filter() | 把过滤器添加到原查询上，返回一个新查询 |
| filter_by() | 把等值过滤器添加到原查询上，返回一个新查询 |
| limit() | 使用指定的值限定原查询返回的结果 |
| offset() | 偏移原查询返回的结果，返回一个新查询 |
| order_by() | 根据指定条件对原查询结果进行排序，返回一个新查询 |
| group_by() | 根据指定条件对原查询结果进行分组，返回一个新查询 |
常用的SQLAlchemy查询结果的方法
| 方法 | 说明 |
|---|---|
| all() | 以列表形式返回查询的所有结果 |
| first() | 返回查询的第一个结果，如果未查到，返回None |
| first_or_404() | 返回查询的第一个结果，如果未查到，返回404 |
| get() | 返回指定主键对应的行，如不存在，返回None |
| get_or_404() | 返回指定主键对应的行，如不存在，返回404 |
| count() | 返回查询结果的数量 |
| paginate() | 返回一个Paginate对象，它包含指定范围内的结果 |
创建表：
db.create_all() # 注意，create_all()方法执行的时候，需要放在模型的后面
删除表
db.drop_all()
插入一条数据
ro1 = Role(name='admin') db.session.add(ro1) db.session.commit() #再次插入一条数据 ro2 = Role(name='user') db.session.add(ro2) db.session.commit()
一次插入多条数据
us1 = User(name='wang',email='wang@163.com',password='123456',role_id=ro1.id) us2 = User(name='zhang',email='zhang@189.com',password='201512',role_id=ro2.id) us3 = User(name='chen',email='chen@126.com',password='987654',role_id=ro2.id) us4 = User(name='zhou',email='zhou@163.com',password='456789',role_id=ro1.id) us5 = User(name='tang',email='tang@163.com',password='158104',role_id=ro2.id) us6 = User(name='wu',email='wu@gmail.com',password='5623514',role_id=ro2.id) us7 = User(name='qian',email='qian@gmail.com',password='1543567',role_id=ro1.id) us8 = User(name='liu',email='liu@163.com',password='867322',role_id=ro1.id) us9 = User(name='li',email='li@163.com',password='4526342',role_id=ro2.id) us10 = User(name='sun',email='sun@163.com',password='235523',role_id=ro2.id) db.session.add_all([us1,us2,us3,us4,us5,us6,us7,us8,us9,us10]) db.session.commit()
练习:
查询所有用户数据 查询有多少个用户 查询第1个用户 查询id为4的用户[3种方式] 查询名字结尾字符为g的所有数据[开始/包含] 查询名字不等于wang的所有数据[2种方式] 查询名字和邮箱都以 li 开头的所有数据[2种方式] 查询password是 `123456` 或者 `email` 以 `163.com` 结尾的所有数据 查询id为 [1, 3, 5, 7, 9] 的用户列表 查询name为liu的角色数据 查询所有用户数据，并以邮箱排序 每页3个，查询第2页的数据
filter_by精确查询
返回名字等于wang的所有人
User.query.filter_by(name='wang').all()
first()返回查询到的第一个对象
User.query.first()
all()返回查询到的所有对象
User.query.all()
filter模糊查询，返回名字结尾字符为g的所有数据。
User.query.filter(User.name.endswith('g')).all()
get():参数为主键，如果主键不存在没有返回内容
User.query.get()
逻辑非，返回名字不等于wang的所有数据
not_ 相当于取反 from sqlalchemy import not_ User.query.filter(not_(User.name=='chen')).all()
逻辑与，需要导入and，返回and()条件满足的所有数据
from sqlalchemy import and_ User.query.filter(and_(User.name!='wang',User.email.endswith('163.com'))).all()
逻辑或，需要导入or_
from sqlalchemy import or_ User.query.filter(or_(User.name!='wang',User.email.endswith('163.com'))).all()
查询数据后删除
user = User.query.first()
db.session.delete(user)
db.session.commit()
User.query.all()
更新数据
user = User.query.first() user.name = 'dong' db.session.commit() User.query.first()
关联查询示例：
角色和用户的关系是一对多的关系，一个角色可以有多个用户，一个用户只能属于一个角色。
-
查询角色的所有用户
#查询roles表id为1的角色
ro1 = Role.query.get(1)
#查询该角色的所有用户
ro1.us.all()
-
查询用户所属角色
#查询users表id为3的用户
us1 = User.query.get(3)
#查询用户属于什么角色
us1.role
查询示例代码:
1 from flask import Flask 2 from flask.json import jsonify 3 4 from settings.dev import DevConfig 5 from flask_sqlalchemy import SQLAlchemy 6 import json 7 from sqlalchemy import or_,and_,not_ 8 9 app = Flask(__name__,template_folder="templates",static_folder='static') 10 app.config.from_object(DevConfig) 11 12 # 初始化SQLAlchemy 13 db = SQLAlchemy(app) 14 15 16 class Role(db.Model): 17 # 定义表名 18 __tablename__ = 'roles' # 定义表名 19 # 定义列对象 20 id = db.Column(db.Integer,primary_key=True) 21 name = db.Column(db.String(64),) 22 us = db.relationship('User',backref='role', lazy='dynamic') 23 def __repr__(self): 24 return 'Role:%s'%self.name 25 class User(db.Model): 26 __tablename__ = "users" 27 id = db.Column(db.Integer, primary_key=True) 28 name = db.Column(db.String(64), ) 29 born = db.Column(db.Date, index=True) 30 email = db.Column(db.String(64), unique=True) 31 password = db.Column(db.String(64)) 32 role_id = db.Column(db.Integer,db.ForeignKey("roles.id")) 33 def __repr__(self): 34 return 'User:%s' % self.name 35 36 @app.route("/all") 37 def all(): 38 """all""" 39 # 获取所有数据 40 user_list = User.query.all() 41 user_list_dict = [] 42 for user in user_list: 43 user_list_dict.append({ 44 "id":user.id, 45 "name": user.name, 46 "email":user.email 47 }) 48 return jsonify(user_list_dict) 49 50 51 @app.route("/filter_by") 52 def filter_by(): 53 # first获取一条数据 54 user = User.query.filter_by(name="xiaoming").first() 55 print(user) 56 return "ok" 57 58 @app.route("/get") 59 def get(): 60 """get 根据主键查询对应数据""" 61 user = User.query.get(10) 62 print(user) 63 return "ok" 64 65 @app.route("/mycount") 66 def mycount(): 67 mycount = User.query.count() 68 print(mycount) 69 return "ok" 70 71 @app.route("/like") 72 def like(): 73 # 查询name以字母"l"开头的 74 # 模型类名.query.filter(模型类名.字段.startswith("字符串")).all() 75 # endswith() 结尾 76 77 user_list = User.query.filter(User.name.startswith("l")).all() 78 print(user_list) 79 return "ok" 80 81 @app.route("/logic1") 82 def logic1(): 83 # 取反 84 user_list = User.query.filter(User.name!="xiaoming").all() 85 print(user_list) 86 return "ok" 87 88 @app.route("/logic2") 89 def logic2(): 90 # 或者,多条件 91 user_list = User.query.filter( or_(User.name=="xiaoming",User.name=="li") ).all() 92 print(user_list) 93 return "ok" 94 95 @app.route("/logic3") 96 def logic3(): 97 # 并且,多条件 98 user_list = User.query.filter( and_(User.role_id==1,User.id>5) ).all() 99 print(user_list) 100 return "ok" 101 102 @app.route("/rel") 103 def rel(): 104 # 外键查询 105 106 # 查询roles表id为1的角色,并 查询该角色的所有用户 107 all_user = Role.query.get(1).us.all() 108 109 # 查询users表id为3的用户,并查询用户属于什么角色 110 us1 = User.query.get(3).role 111 112 print("us1", us1) 113 114 print("all_user",all_user) 115 return "ok" 116 117 118 if __name__ == '__main__': 119 120 app.run(host="0.0.0.0", port=80)