作者(微信公众号)&＃xff1a;猿人学Python
SanicDB 是为 Python的异步 Web 框架 Sanic 方便操作MySQL而开发的工具&＃xff0c;是对 aiomysql.Pool 的轻量级封装。Sanic 是异步IO的Web框架&＃xff0c;同时用异步IO读写MySQL才能更大发挥它的效率。虽然这个模块叫做 SanicDB&＃xff0c;但是它可以用在任何异步IO操作MySQL的地方。
SanicDB的灵感来源于tornado里面的对MySQLdb&＃xff08;MySQL的C语言接口的Python封装&＃xff09;的操作&＃xff0c;后来tornado把它去除了&＃xff0c;就有人把这部分代码写成一个单独的模块叫做 torndb&＃xff0c;torndb是对python-mysql的封装&＃xff0c;不能进行异步操作。但是它很简洁&＃xff0c;用起来已经非常习惯了。
在用Sanic的时候&＃xff0c;发现有异步IO的aiomysql可以用&＃xff0c;但是用起来还有点麻烦&＃xff0c;于是就着手对aiomysql进行封装&＃xff0c;既然aiomysql支持连接池&＃xff0c;那就直接封装aiomysql.Pool吧。
代码仓库&＃xff1a; https://github.com/veelion/sanicdb
首先&＃xff0c;看看它的初始化
class SanicDB:
"""A lightweight wrapper around aiomysql.Pool for easy to use
"""
def __init__(self, host, database, user, password,loop&＃61;None, sanic&＃61;None,minsize&＃61;3, maxsize&＃61;5,return_dict&＃61;True,pool_recycle&＃61;7*3600,autocommit&＃61;True,charset &＃61; "utf8mb4", **kwargs):
&＃39;&＃39;&＃39;
前面4个参数是对应数据库的&＃xff1b;
loop 是你的应用程序中的事件循环&＃xff08;event_loop&＃xff09;&＃xff1b;
sanic 是你的Sanic 应用中的sanic 对象&＃xff1b;
loop 和 sanic 两者只需提供一个即可&＃xff0c;当同时存在时&＃xff0c;连接数据库其实用的是sanic里面的loop&＃xff0c;这在__init__()代码中可以看到。
minisize 和 maxsize 是连接池的个数限制&＃xff1b;
return_dict 是返回的数据一条记录为一个dict&＃xff0c;key是MySQL表的字段名&＃xff0c;value是字段的值&＃xff1b;
pool_recycle 是连接池重连的时间间隔&＃xff0c;MySQL默认的连接闲置时间是8小时&＃xff1b;
对MySQL的读写操作方法&＃xff1a;
async def query(self, query, *parameters, **kwparameters): async def execute(self, query, *parameters, **kwparameters):async def get(self, query, *parameters, **kwparameters):
从代码中可以看到&＃xff0c;以上三个函数都是调用的cursor的execute() 执行 SQL 命令&＃xff0c;但是query(), get() 用于读操作返回数据&＃xff0c;query返回全部数据&＃xff08;list&＃xff09;&＃xff0c;get只返回一条数据。
execute() 方法用来执行写操作&＃xff0c;返回受影响的行ID。
上面三个函数都是一样的&＃xff1a;
query 是要执行的SQL语句&＃xff0c; 后面两个参数是用来参数化执行sql语句的。参数化执行sql是为了防止SQL注入的&＃xff0c;那么参数化执行SQL是什么意思呢&＃xff0c;举个例子就目标了。
比如&＃xff0c;进行用户登录时&＃xff0c;我们要执行一条SQL&＃xff0c;Python拼接SQL如下&＃xff1a;
sql &＃61; "select * from user where name&＃61;&＃39;%s&＃39; and password&＃61;&＃39;%s&＃39;" % (input_name, input_password)
input_name 和 input_password 都是用户输入的&＃xff0c;如果用户想捣鬼&＃xff0c;他把input_name 输入成 “ ‘ or 1 &＃61; 1 –”&＃xff0c;拼接出来的sql就成了&＃xff1a;
select * from user where name&＃61;&＃39;&＃39; or 1 &＃61; 1 --&＃39; and password&＃61;&＃39;anything&＃39;
or 后面的 1&＃61;1 就是True&＃xff0c;而 — 后面都成了注释&＃xff0c;这条语句不管input_name, input_password 是什么都可以执行&＃xff0c;通过用户验证&＃xff0c;达到了注入目的。
参数化执行SQL就是把拼接SQL的任务交给SanicDB&＃xff08;实际上是它后的aiomysql后面的pymysql&＃xff09;&＃xff0c;我们只把要拼接的参数当做*parameters传给读写方法即可&＃xff1a;
mydb.query("select * from user where user&＃61;%s and password&＃61;%s", input_name, input_password)
更高级的封装&＃xff1a;
query(), get(), execute() 就是基本的操作&＃xff0c;在此基础上&＃xff0c;做了进一步封装&＃xff0c;让写应用更方便&＃xff1a;
# 检查一个table中是否含有某字段为某值的记录async def table_has(self, table_name, field, value):# 把一个item插入一个表&＃xff0c;item为dict&＃xff0c;key是字段名&＃xff0c;# ignore_duplicated为True时&＃xff0c;遇到唯一索引重复时不报错async def table_insert(self, table_name, item, ignore_duplicated&＃61;True):# 更新一个table的记录&＃xff0c;updates是dict&＃xff0c;key为字段名async def table_update(self, table_name, updates, field_where, value_where):
示例
代码仓库中有两个示例&＃xff1a;
test.py 是在普通asyncio程序中使用异步MySQL的例子
example.py 是在Sanic Web中使用的例子
特别说明一下&＃xff0c;Sanic 对象 app 中还没有生成 event_loop 对象&＃xff08;它是在app.run() 之后生成的&＃xff09;&＃xff0c;所以在Sanic中初始化SanicDB时&＃xff08;app.run()&＃xff09;之前&＃xff0c;运行sql语句会报错。如果需要创建连接后初始化运行一些SQL操作&＃xff0c;可以利用Sanic的Listner&＃xff1a;
&＃64;app.listener(&＃39;before_server_start&＃39;)
async def setup_db(app, loop):app.db &＃61; await db_setup()
文章首发于我的技术博客&＃xff1a;猿人学
我的微信公众号&＃xff1a;猿人学Python。写利用Python挣钱和Python知识拓展类文章。
京公网安备 11010802041100号