重写django的mysql驱动实现原生sql语句查询返回字典类型数据

在使用django的时候，有些需求需要特别高的查询效率，所以需要使用原生的sql语句查询，但是查询结果一般是一个元组嵌套元组。为了处理方便，需要从数据库查询后直接返回字典类型的数据。

这里使用的方法是继承django.db.backends.mysql驱动

首先在django项目下创建一个mysql文件夹，然后在这个文件夹下创建base.py。

base.py

from django.db.backends.mysql import base
from django.db.backends.mysql import features
from django.utils.functional import cached_property


class DatabaseFeatures(features.DatabaseFeatures):
    @cached_property
    def is_sql_auto_is_null_enabled(self):
        with self.connection.cursor() as cursor:
            cursor.execute('SELECT @@SQL_AUTO_IS_NULL')
            result = cursor.fetchone()
            return result and result['@@SQL_AUTO_IS_NULL'] == 1


class DatabaseWrapper(base.DatabaseWrapper):
    features_class = DatabaseFeatures

    def create_cursor(self, name=None):
        cursor = self.connection.cursor(self.Database.cursors.DictCursor)
        return base.CursorWrapper(cursor)

    @cached_property
    def mysql_server_info(self):
        with self.temporary_connection() as cursor:
            cursor.execute('SELECT VERSION()')
            return cursor.fetchone()['VERSION()']

 

最后在django项目的settings.py文件里修改数据库配置的数据库引擎

DATABASES = {
    'default': {
        'ENGINE': 'Test.mysql',  # 指定数据库驱动为刚刚创建的mysql文件夹
        'NAME': 'test',  # 指定的数据库名
        'USER': 'root',  # 数据库登录的用户名
        'PASSWORD': '123456',  # 登录数据库的密码
        'HOST': '127.0.0.1',
        'PORT': '3306',  # 数据库服务器端口，mysql默认为3306
        'DATABASE_OPTIONS': {
            'connect_timeout': 60,
            'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            'charset': 'utf8mb4',
        },
    }
}

测试

from django.db import connections

def f():
    search_sql = "SELECT propertyphotoid,propertyid,alykey FROM lansi_architecture_data.propertyphoto limit 0,5"
    cursor = connections['default'].cursor()
    try:
        cursor.execute(search_sql)
        rows = cursor.fetchall()
    except Exception as e:
        print(e)
        rows = 1

    print(rows)

输出结果

[{'propertyphotoid': 27, 'propertyid': 0, 'alykey': '123456'}, {'propertyphotoid': 28, 'propertyid': 10837, 'alykey': 'Property/6113/207504A1-AC65-4E3B-BE86-538B3807D364'}, {'propertyphotoid': 29, 'propertyid': 6113, 'alykey': 'Property/6113/357A4EAE-750A-4F59-AF01-271B4225CFBD'}, {'propertyphotoid': 31, 'propertyid': 6113, 'alykey': 'Property/6113/6DF1A2C1-F54C-4462-8363-619806A2F085'}, {'propertyphotoid': 36, 'propertyid': 6113, 'alykey': 'Property/6113/572CB245-ABC0-4FD6-8353-729EBD5E5D46'}]

源码解析：

django.db.utils.ConnectionHandler的__getitem__方法

获取连接对象的游标是由DatabaseWrapper类的create_cursor返回的。所以只需要重写create_cursor方法，就可以更改游标返回的数据类型了。

django.db.backends.mysql.base.DatabaseWrapper类中的create_cursor方法如下：

    def create_cursor(self, name=None):
        cursor = self.connection.cursor()
        return CursorWrapper(cursor)

到这里，理论上已经完成了重写目标，但是在测试的时候出错了，在django.db.backends.mysql.features.DatabaseFeatures里的is_sql_auto_is_null_enabled方法报出KeyError的错误。

    @cached_property
    def is_sql_auto_is_null_enabled(self):
        with self.connection.cursor() as cursor:
            cursor.execute('SELECT @@SQL_AUTO_IS_NULL')
            result = cursor.fetchone()
            return result and result[0] == 1

原因是is_sql_auto_is_null_enabled方法使用了重写后的游标，cursor.execute('SELECT @@SQL_AUTO_IS_NULL')返回的结果不是元组，而是一个字典。所以result[0]会报出KeyError的错误。重写is_sql_auto_is_null_enabled方法把result[0]改成result['@@SQL_AUTO_IS_NULL']就可以了.

最后还需要把DatabaseWrapper类里的features_class赋值为重写后的DatabaseFeatures类。