廖老师python教程实战Day3-编写ORM理解

在此之前，建议先看一下我之前写的一篇博客
当输入

u = User(name='Test', email='test@example.com', passwd='1234567890', image='about:blank')
u.save()

orm是如何做的？

u是实例

User是类，类的属性为name,email,passwd,image,id,admin,creted_at（后面三个类属性会自动计算属性值）

对于User类来说，User类的属性类型分别为StringField,StringField,StringField,StringField,StringField,BoleanField,FloatField

User类的属性值是创建实例u时所传进去的参数分别为Test,test@example,1234567890,about:blank,其它的属性值程序会自动计算并填上

User类继承于Model，而Model又是根据ModelMetaclass所定制的类，因此Model会获取ModelMetaclass所有的属性

for k, v in attrs.items():
            if isinstance(v, Field):
                logging.info('  found mapping: %s ==> %s' % (k, v))
                mappings[k] = v
                if v.primary_key:
                    # 找到主键:
                    if primaryKey:
                        raise StandardError('Duplicate primary key for field: %s' % k)
                    primaryKey = k
                else:
                    fields.append(k)
if not primaryKey:
            raise StandardError('Primary key not found.')

k是什么？

k是User类的属性name,email,passwd,image,id,admin,creted_at

v是什么？

v是User类的属性类型StringField,StringField,StringField,StringField,StringField,BoleanField,FloatField

v.primary_key代表什么？这就要看一下User类属性的id属性了：

id = StringField(primary_key=True, default=next_id, ddl='varchar(50)')

v.primary_key的值就是True

primaryKey = k意味着什么？

意味着primaryKey的值与属性id绑定了，在Model类中primaryKey的值就等于属性id的值

for k in mappings.keys():
            attrs.pop(k)

为什么要删除？

前面已经利用一个mappings字典来获取所有的属性以及属性类型，这样下面只需要用一个属性__mappings__就可以获得所有属性和数据库列的对应关系

attrs['__mappings__'] = mappings

为什么需要escaped_fields？

User表的列名： id，emial，passwd，admin，name，image，create_at

Mysql查询语句格式： SELECT column_name,column_name FROM table_name

显然escaped_fields是用来构造列名的

假设要查询的列名分别为id，email，passwd 则escaped_fields输出为 [‘`id`’, ‘`email`’, ‘`passwd`’]

在元类定义关于查询的类属性

attrs['__select__'] = 'select `%s`, %s from `%s`' % (primaryKey, ', '.join(escaped_fields), tableName)

输出为：

'select `primaryKey`, id,email,passwd from `User`'

为什么要构造成

select `primaryKey`, id,email,passwd from `User`

而不是

select primaryKey, id,email,passwd from User

答案是防止SQL注入

attrs['__select__'] = 'select `%s`, %s from `%s`' % (primaryKey, ', '.join(escaped_fields), tableName)
attrs['__insert__'] = 'insert into `%s` (%s, `%s`) values (%s)' % (tableName, ', '.join(escaped_fields), primaryKey, create_args_string(len(escaped_fields) + 1))
attrs['__update__'] = 'update `%s` set %s where `%s`=?' % (tableName, ', '.join(map(lambda f: '`%s`=?' % (mappings.get(f).name or f), fields)), primaryKey)
attrs['__delete__'] = 'delete from `%s` where `%s`=?' % (tableName, primaryKey)

这么长的四行用来干什么？

用来构造SQL语句

ModelMetaclass到此为止
下面看一下Model类

def getValueOrDefault(self, key):
        value = getattr(self, key, None)
        if value is None:
            field = self.__mappings__[key]
            if field.default is not None:
                value = field.default() if callable(field.default) else field.default
                logging.debug('using default value for %s: %s' % (key, str(value)))
                setattr(self, key, value)
        return value

getValueOrDefault函数看它的名字就知道它要用来获取User类的属性所对应的属性值，有的是默认值（用户不需要输入），如果说找不到默认值那就log一下

以save函数来做一个总结：

async def save(self):
        args = list(map(self.getValueOrDefault, self.__fields__))
        args.append(self.getValueOrDefault(self.__primary_key__))
        rows = await execute(self.__insert__, args)
        if rows != 1:
            logging.warn('failed to insert record: affected rows: %s' % rows)

self._fileds_是怎么来的？

Model类并没有编写，答案是从ModelMetaclass定制类后的来的

self._fields_存的是什么？

除主键外的所有属性名 即name,email,passwd,image,id,admin,creted_at 对于主键因为主键的值和id的值一样，因此单独拿出来在获取

args里面放的是什么？

['Test', 'test@example.com', '1234567890', 'about:blank', 'id是程序自己计算的', '0/1', 'creted_at程序自己计算', '与定义User相比多了一个primaryKey']

把args传入ModelMetaclass所构造的insert属性就可以保存了

rows = await execute(self.__insert__, args)
if rows != 1:
            logging.warn('failed to insert record: affected rows: %s' % rows)

用来验证是否插入，row返回的是所插入的数。

参考文档：
[1]aiomysql
[2]MySQL 查询数据
[3]MySQL 及 SQL 注入

如果理解不当，请指出来，我会改正的。