python3异步编程，异步orm之 tortoise-orm

前言:

去年下半年为了做了个web服务，使用了基于python3.5+的一个异步框架 sanic。

其中需要一个异步的mysql引擎，我们常见的也就是 aiomysql，为了便于开发，我找了一个基于 aiomysql 的简单封装的异步引擎 SanicDB,事先说明这个不是orm, 然后到今年因为业务越来越多，使用 SanicDB 感觉也是很不方便，还导致代码不够清晰，然后我又发现了一个新的，真正的 异步orm 引擎  tortoise-orm,经过简单测试后感觉这个是真的很棒，所以我就弃 SanicDB 而选择 tortoise-orm。

先来简单说一下 SanicDB 吧，

源码很简单，一共140多行代码，提供6个对mysql操作的方法，如下图：

其中 query,get,execute 三个方法是需要传入原生的 mysql 语句和需要格式化的值，像下面这样:
|
嗯，还是比较不方便的，但是比直接用 aiomysql 要好一点，好了，我这样是不好的，用着人家的东西吐槽，嗯，我的错。
再详细的可以直接看人家的博客 和git仓库。

 

现在来详细介绍一下  tortoise-orm，这是一个真正的异步orm，需要python版本在 3.7 及以上，tortoise-orm支持 SQLite ,PostgreSQL ,MySQL 三种数据库，
在安装完  tortoise-orm 之后，你可以选择安装 asyncpg aiosqlite aiomysql 三个引擎。

其中 SQLite 对应 aiosqlite ，PostgreSQL  对应 asyncpg ，Mysql 对应 aiomysql。

实例化：

    from tortoise import Tortoise
    import asyncio
    async def init():
        user = 'root'
        password = '123456'
        db_name = 'test'
        await Tortoise.init(
            #指定mysql信息
            db_url=f'mysql://{user}:{password}@127.0.0.1:3306/{db_name}',
            #指定models
            modules={'models': ['sanic_bp.models']}
        )
        #按照模型生成表
        # await Tortoise.generate_schemas()
    asyncio.run(init())

 

在sanic中使用：

本来我是这样子做的,如下，在 sanic 提供的 after_server_start 监听器中进行连接，

from sanic import Sanic
from tortoise import Tortoise

app = Sanic(__name__)

@app.listener('after_server_start')
async def notify_server_started(app, loop):
    print('sanic sanic服务启动后建立mysql连接')
    #实例化mysql连接
    await Tortoise.init(
        db_url='mysql://root:[email protected]:3306/test?maxsize=50&minsize=3',
        modules={'models': ['sanic_bp.models']}
    )

然而，昨天晚上又把 tortoise-orm 的文档翻了一下，发现人家已经提供方法了，并且在服务退出的时候还会自动关闭 connections，如下，这是 tortoise-orm 提供的demo，我截取了部分，

from tortoise.contrib.sanic import register_tortoise

register_tortoise(
    app, db_url="sqlite://:memory:", modules={"models": ["models"]}, generate_schemas=True
)

还有在 fastapi 中的使用方法，都可以在文档中找到，文档链接我放到此文章最下面了，里面还有一些其它骚操作。

比如，如果在 Django 中想要在一个app项目中同时使用两个库的话很麻烦,要改很多很多操作，而在 sanic 和 fastapi中使用

tortoise-orm 连接多个库的话就很方便了，像这样，我又是截取了部分(文抄公)，

async def run():
    await Tortoise.init(
        {    
            #这里面指定两个不同的数据库，虽然它填写的都是一样的
            "connections": {
                "first": {
                    "engine": "tortoise.backends.sqlite",
                    "credentials": {"file_path": "example.sqlite3"},
                },
                "second": {
                    "engine": "tortoise.backends.sqlite",
                    "credentials": {"file_path": "example1.sqlite3"},
                },
            },
            #可以指定多个不同的models, 嗯，它指定的也是一样的
            "apps": {
                "tournaments": {"models": ["__main__"], "default_connection": "first"},
                "events": {"models": ["__main__"], "default_connection": "second"},
            },
        }
    )
    #await Tortoise.generate_schemas()
    #选取数据库
    client = Tortoise.get_connection("first")
    #选取 models
    second_client = Tortoise.get_connection("second")
    #然后这下面就可以进行orm操作了
    

另外：

models指定真实表名方法和django自带orm稍微有点区别：

django自带orm:

class Meta:
        db_table = "{table_name}"

tortoise-orm:

    class Meta:
        table = "{table_name}"

至于增删改查和正常orm操作区别很小，这里就不叙述了。

 

SanicDB github地址 ：https://github.com/veelion/sanicdb   ， 博客地址：https://msd.misuland.com/pd/3053059875815821102 
tortoise-orm github地址: https://github.com/tortoise/tortoise-orm ，

tortoise-orm 文档地址：https://tortoise-orm.readthedocs.io/en/latest/index.html