網站搭建筆記精簡版-廖雪峰教程學習@[三川水祭]
僅作學習交流使用，將來的你會感謝現在拼命努力的自己！！！

Webapp中一旦決定使用非同步程式設計，之後系統的每一層都必須是非同步的。
首先介紹了連線池的概念，之後介紹了函式封裝的思想，最後對ORM程式碼進行了詳細解釋。

建立連線池

是什麼：連線池類似於一個池塘，裡面已經存放了多條鯉魚的資源，當我們想吃鯉魚的時候，直接到池塘裡抓就好，不用到外面買。即當我們需要獲取連線池中的資料庫連結的時候，直接從池子裡找，不必頻繁的開啟和關閉資料庫，以最大化資源複用。使用全域性物件__pool儲存資料庫連結資源，當有連結請求到達時候，複用池子中的資源。
注： 輸入引數**kw詳情請參考

# **kw表示輸入為字典物件，*kw表示輸入為元組物件
async def create_pool(loop, **kw):
    logging.info('create database connection pool...')
    # 連線池由全域性變數__pool儲存
    global __pool
    # 使用await實現非同步程式設計建立資料庫
    __pool = await aiomysql.create_pool(
    	# get()函式獲取字典kw中key為’host‘的value
    	# 當值不存在時預設返回值為localhost
        host=kw.get('host', 'localhost'), #主機地址
        port=kw.get('port', 3306), #埠號
        user=kw['user'], #使用者名稱
        password=kw['password'], #密碼
        db=kw['db'], #資料庫名稱
        charset=kw.get('charset', 'utf8'), #預設編碼
        autocommit=kw.get('autocommit', True), #是否自動提交事務
        maxsize=kw.get('maxsize', 10),
        minsize=kw.get('minsize', 1),
        loop=loop #輪詢機制的物件
    )
 

Select，Insert, Update, Delete封裝

訪問資料庫需要建立資料庫連結、執行sql語句、處理異常和關閉連結等，在Webapp的程式碼中，如果僅在需要訪問資料庫的地方完全嵌入上述資料庫連結的流程程式碼，會造成程式碼整體維護成本增加，且不利於程式碼的複用。因此我們在初始化非同步資料庫連線的執行緒池__pool後，對select、insert、updata和delete函式進行封裝，在需要的時候直接呼叫封裝函式即可，不用每次均寫資料庫連結的程式碼，提高程式碼整體的複用率。
首先是封裝select函式，程式碼如下：

async def select(sql, args, size=None):
    log(sql, args)
    global __pool
    # 根據網頁請求的連結在連線池中建立資料庫的連線
    with (yield from __pool) as conn:
        # 建立連結初始化，並將返回的結果設定為字典
        cur = yield from conn.cursor(aiomysql.DictCursor)
        # 執行sql語句，對於mysql，將佔位符？替換為%s，第二個引數為%s的內容
        yield from cur.execute(sql.replace('?', '%s'), args or ())
        if size:
            # 獲取數量為size的記錄
            rs = yield from cur.fetchmany(size)
        else:
            # 獲取所有記錄
            rs = yield from cur.fetchall()
        # 關閉cur連結，conn連結可繼續複用，不用關閉
        yield from cur.close()
        logging.info('rows returned: %s' % len(rs))
        return rs
 

由於insert、update和delete三種sql語句執行需要相同的引數，以及通過rowcount返回一個整數表示被影響的行數，因此將上述三個sql語句封裝到一個函式中，提高程式碼整體複用率。
封裝insert、update和delete的execute函式，程式碼如下：

async def execute(sql, args):
    # 記錄當前請求的日誌資訊，好習慣
    log(sql)
    with (await __pool) as conn:
        try:
            # 初始化連結cursor方法
            cur = yield from conn.cursor()
            # 執行相應程式碼
            yield from cur.execute(sql.replace('?', '%s'), args)
            # 統計改變行數
            affected = cur.rowcount
            # 關閉cursor方法的連結
            yield from cur.close()
        except BaseException as e:
            raise
        # 返回結果數
        return affected

ORM

是什麼

把關係資料庫的表結構對映到物件上，使得每個web請求連線被建立後均需要接入資料庫進行操作，更加安全人性化，要不然資料庫語句程式碼這裡一個，那裡一個，不美觀且不實用。

orm課程程式碼的解釋

參考這個和這個兩個網頁。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

'''
編寫orm模組
'''

import asyncio, logging

import aiomysql

def log(sql, args=()):
    logging.info('SQL: %s' % sql)

# 建立一個全域性的連線池，每個HTTP請求都從池子中獲得資料庫連線
# 連線池由全域性變數__pool儲存，預設狀況下將編碼設定為utf-8，自動提交事務
async def create_pool(loop, **kw):
    logging.info('create database connection pool...')
    global __pool
    __pool = await aiomysql.create_pool(
        host=kw.get('host', 'localhost'),
        port=kw.get('port', 3306),
        user=kw['user'],
        password=kw['password'],
        db=kw['db'],
        charset=kw.get('charset', 'utf8'),
        autocommit=kw.get('autocommit', True),
        maxsize=kw.get('maxsize', 10),
        minsize=kw.get('minsize', 1),
        loop=loop
    )

# 單獨封裝select，其他insert，update，delete一併封裝，理由如下：
# 使用Cursor物件執行insert、update、delete語句時候，執行結果由rowcount返回影響的行數，就可以拿到執行結果
# 使用Cursor物件執行select語句時，通過fetchall()可以拿到結果集。結果集是一個list，每個元素都是一個tuple，對應一行記錄
async def select(sql, args, size=None):
    log(sql, args)
    global __pool
    async with __pool.get() as conn:
		# 建立遊標，aiomysql.DictCursor使得生成結果為dict
        async with conn.cursor(aiomysql.DictCursor) as cur:
			# 執行sql語句，sql語句的佔位符為'?'，而mysql的佔位符為'%s'
            await cur.execute(sql.replace('?', '%s'), args or ())
            if size:
                rs = await cur.fetchmany(size)
            else:
                rs = await cur.fetchall()
        logging.info('rows returned: %s' % len(rs))
        return rs
# 封裝insert、update、delete
async def execute(sql, args, autocommit=True):
    log(sql)
    async with __pool.get() as conn:
        if not autocommit:
            await conn.begin()
        try:
            async with conn.cursor(aiomysql.DictCursor) as cur:
                await cur.execute(sql.replace('?', '%s'), args)
                affected = cur.rowcount
            if not autocommit:
                await conn.commit()
        except BaseException as e:
            if not autocommit:
                await conn.rollback()
            raise
        return affected

# 用於輸出元類中建立sql_insert語句中的佔位符
def create_args_string(num):
    L = []
    for n in range(num):
        L.append('?')
    return ', '.join(L)

# 定義Field類，負責儲存(資料庫)表的欄位名和欄位型別
class Field(object):

    def __init__(self, name, column_type, primary_key, default):
        self.name = name
        self.column_type = column_type
        self.primary_key = primary_key
        self.default = default

    def __str__(self):
		# 返回表名字 欄位名 和欄位型別
        return '<%s, %s:%s>' % (self.__class__.__name__, self.column_type, self.name)

# 定義資料庫中五個儲存型別
class StringField(Field):

    def __init__(self, name=None, primary_key=False, default=None, ddl='varchar(100)'):
        super().__init__(name, ddl, primary_key, default)

# 布林型別不可以作為主鍵
class BooleanField(Field):

    def __init__(self, name=None, default=False):
        super().__init__(name, 'boolean', False, default)

class IntegerField(Field):

    def __init__(self, name=None, primary_key=False, default=0):
        super().__init__(name, 'bigint', primary_key, default)

class FloatField(Field):

    def __init__(self, name=None, primary_key=False, default=0.0):
        super().__init__(name, 'real', primary_key, default)

class TextField(Field):

    def __init__(self, name=None, default=None):
        super().__init__(name, 'text', False, default)

# 定義model的元類
# 所有的元類都繼承自type
# ModelMetaclass元類定義了所有Model基類（繼承ModelMetaclass）的子類實現操作

# -*-ModelMetaclass的工作主要是為一個數據庫表對映成一個封裝的類作準備：
# 讀取具體子類(user)的對映資訊
# 創造類的時候，排除對model類的修改
# 在當前類中查詢所有的類屬行(attrs)，如果找到Field屬性，就將其儲存到__mappings__的dict中，同時從類屬性中刪除Field(放置例項屬性遮住類的同名屬性)
# 將資料庫表明儲存到__table__中。

# 完成上述工作就可以在model中定義各種資料庫的操作方法
# metaclass是類的模板，必須從’type‘型別派生
class ModelMetaclass(type):
	# __new__控制__init__的執行，所以在其執行之前，
	# cls代表__init__的類，此引數在例項化時候有python直譯器自動提供，例如下文的User和model
	# bases: 代表繼承父類的集合
	# attrs: 類的方法集合
    def __new__(cls, name, bases, attrs):
		# 排除model，是因為要排除對model類的修改
        if name=='Model':
            return type.__new__(cls, name, bases, attrs)
		# 獲取table名稱，如果存在表名，則返回表名，否則返回name
        tableName = attrs.get('__table__', None) or name
        logging.info('found model: %s (table: %s)' % (name, tableName))
        # 獲取Field所有主鍵名和Field
		mappings = dict() # 儲存對映關係
        fields = [] # 儲存除主鍵外的屬性名字
        primaryKey = None
		# k表示欄位名
        for k, v in attrs.items():
            if isinstance(v, Field):
                logging.info('  found mapping: %s ==> %s' % (k, v))
				# 注意mapping的用法
                mappings[k] = v
                if v.primary_key:
                    # 找到主鍵，當第一次主鍵存在primarykey被賦值，如果後來再出現主鍵的話就會發生錯誤
                    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.')
		# w下面位欄位從屬性中刪除Field屬性
        for k in mappings.keys():
            attrs.pop(k) # 從類屬性中刪除Field屬性否則，容易造成執行是發生錯誤（例項的屬性會覆蓋類的同名屬性）
        # 儲存除主鍵外的屬性為''列表的形式
		# 除主鍵外的其他屬性變成'id'，'name'這種形式
		escaped_fields = list(map(lambda f: '`%s`' % f, fields))# 轉換為sql語法
		# 建立共Model類使用的屬性
        attrs['__mappings__'] = mappings # 儲存屬性和列的對映關係
        attrs['__table__'] = tableName # 表的名字
        attrs['__primary_key__'] = primaryKey # 主鍵屬性名
        attrs['__fields__'] = fields # 除主鍵外的屬性名
        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# 查詢列的名字，也看一下在Field定義上有沒有定義名字，預設None
        attrs['__delete__'] = 'delete from `%s` where `%s`=?' % (tableName, primaryKey)
        return type.__new__(cls, name, bases, attrs)

# 定義ORM所有對映的基類：Model
# Model類的任意子類可以對映一個數據庫表
# Model類可以看做是對所有資料庫表操作的基本定義的對映

# 基於字典查詢形式
# Model從dict繼承，擁有字典的所有功能，同時實現特殊方法__getattr__和__setattr__,能夠實現屬性操作
# 實現資料庫操作的所有方法，定義為class方法，所有繼承自model都具有資料庫操作方法
class Model(dict, metaclass=ModelMetaclass):

    def __init__(self, **kw):
        super(Model, self).__init__(**kw)

    def __getattr__(self, key):
        try:
            return self[key]
        except KeyError:
            raise AttributeError(r"'Model' object has no attribute '%s'" % key)

    def __setattr__(self, key, value):
        self[key] = value
	# 直接調回內建函式，注意這裡沒有下劃符
    def getValue(self, key):
		# 預設內建函式實現，注意這裡None的用處,是為了當user沒有賦值資料時，返回None，調用於update
        return getattr(self, key, None)

    def getValueOrDefault(self, key):
		# 第三個引數None，可以在沒有返回數值時，返回None，調用於save
        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

    @classmethod
	# 當前類方法有cls傳入，從而可以用cls做一些相關處理，並且有子類繼承時候，呼叫該類方法
    async def findAll(cls, where=None, args=None, **kw):
        ' find objects by where clause. '
        sql = [cls.__select__]
        if where:
            sql.append('where')
            sql.append(where)
        if args is None:
            args = []
        orderBy = kw.get('orderBy', None)
        if orderBy:
            sql.append('order by')
            sql.append(orderBy)
        limit = kw.get('limit', None)
        if limit is not None:
            sql.append('limit')
            if isinstance(limit, int):
                sql.append('?')
                args.append(limit)
            elif isinstance(limit, tuple) and len(limit) == 2:
                sql.append('?, ?')
                args.extend(limit)
            else:
                raise ValueError('Invalid limit value: %s' % str(limit))
		# 返回的rs是一個元素是tuple的list
        rs = await select(' '.join(sql), args)
        return [cls(**r) for r in rs] # 每條記錄對應的類例項，**r是關鍵字引數，構成了一個cls類的列表

    @classmethod
    async def findNumber(cls, selectField, where=None, args=None):
        ' find number by select and where. '
        sql = ['select %s _num_ from `%s`' % (selectField, cls.__table__)]
        if where:
            sql.append('where')
            sql.append(where)
        rs = await select(' '.join(sql), args, 1)
        if len(rs) == 0:
            return None
        return rs[0]['_num_']

    @classmethod
    async def find(cls, pk):
        ' find object by primary key. '
        rs = await select('%s where `%s`=?' % (cls.__select__, cls.__primary_key__), [pk], 1)
        if len(rs) == 0:
            return None
		# 返回一條記錄，以dict的形式返回，因為cls的夫類繼承了dict類
        return cls(**rs[0])

    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)

    async def update(self):
        args = list(map(self.getValue, self.__fields__))
        args.append(self.getValue(self.__primary_key__))
        rows = await execute(self.__update__, args)
        if rows != 1:
            logging.warn('failed to update by primary key: affected rows: %s' % rows)

    async def remove(self):
        args = [self.getValue(self.__primary_key__)]
        rows = await execute(self.__delete__, args)
        if rows != 1:
			logging.warn('failed to remove by primary key: affected rows: %s' % rows)

參考部落格
廖雪峰的官方網站
MySQL-python的DictCursor沒有用？
python之cursor() — 資料庫連線操作
Python廖雪峰實戰web開發（Day3-編寫ORM）
python3 ORM重難點