我的第一個python web開發框架（27）——定製ORM（三）

在上一章中，我們已經創建好ORM的基類了，接下來要做的就是將基類的常用方法一一實現。首先我們來看看之前項目中，最常見的獲取指定主鍵的記錄實體從代碼中可以看到，我們需要執行select * from product where id = xx從數據表中查詢到我們想要的數據。要封裝成ORM的方法， ...

　　在上一章中，我們已經創建好ORM的基類了，接下來要做的就是將基類的常用方法一一實現。

　　首先我們來看看之前項目中，最常見的獲取指定主鍵的記錄實體

@get('/api/product/<id:int>/')
def callback(id):
    """
    獲取指定id的產品記錄實體
    """
    sql = """select * from product where id = %s""" % (id,)
    # 讀取記錄
    result = db_helper.read(sql)
    if result:
        return web_helper.return_msg(0, '成功', result[0])
    else:
        return web_helper.return_msg(-1, "查詢失敗")

　　從代碼中可以看到，我們需要執行select * from product where id = xx從數據表中查詢到我們想要的數據。

　　要封裝成ORM的方法，我需要需要註意下麵幾項事情：

　　1.方法名必須是簡單易懂的

　　2.方法需要接收指定的主鍵值

　　3.sql需要在方法中進行組裝

　　根據這些要求，我們可以很容易寫出這個方法

    def get_model_for_pk(self, pk):
        """通過主鍵值獲取資料庫記錄實體"""
        if not pk:
            return {}
        # 組裝查詢條件
        wheres = '%s = %s' % (self.__pk_name, str(pk))
        # 合成sql語句
        sql = "select %(column_name_list)s from %(table_name)s where %(wheres)s" % \
              {'column_name_list': self.__column_name_list, 'table_name': self.__table_name, 'wheres': wheres}
        # 初化化資料庫鏈接
        with db_helper.PgHelper(self.__db, self.__is_output_sql) as db:
            # 執行sql語句
            _result = db.execute(sql)
            # 對返回的內容進行處理
            if _result:
                result = _result[0]
            else:
                result = {}
        return result

　　我們通過方法名（get_model_for_pk）應當可以知道，我們是通過主鍵來獲取指定的記錄實體內容。

　　該方法需要傳入的參數值是主鍵值pk

　　在接收到主健值以後，我們需要對它進行簡單的判斷處理，如果它為空則直接返回空字典。

　　在組合sql前，我們需要選對查詢條件進行組裝，這裡我們直接使用self.__pk_name，在上一章初始化時定義好的預設項，在這裡不直接使用id做為條件欄位，是為了當出現主鍵名稱為其他字元時，可以靈活處理。比如訂單表使用code為主鍵時，就可以直接綁定code而不是自增id了。比如self.__pk_name初始值是id，主鍵pk值是1，那麼組裝後的查詢條件為 id=1

　　然後直接調用預設項查詢欄位名稱self.__column_name_list和表名稱self.__table_name來合成sql語句。例如self.__column_name_list初始值為*，self.__table_name初始值為product，那麼合成的sql語句為：select * from product where id=1

　　最後調用資料庫操作類db_helper來執行sql語句（這裡使用widh方法來初始化資料庫操作類），將執行後的結果返回主程式

　　針對上面這個讀取產品記錄實體的功能，我們像上一章一樣，先創建好一個產品管理的邏輯類，繼承ORM基類

#!/usr/bin/env python
# coding=utf-8

from logic import _logic_base
from config import db_config


class ProductLogic(_logic_base.LogicBase):
    """產品管理表邏輯類"""

    def __init__(self):
        # 表名稱
        __table_name = 'product'
        # 初始化
        _logic_base.LogicBase.__init__(self, db_config.DB, db_config.IS_OUTPUT_SQL, __table_name)

　　我們就可以直接改造前面的介面調用代碼了

@get('/api/product/<id:int>/')
def callback(id):
    """
    獲取指定記錄
    """
    # 實例化product表操作類ProductLogic
    _product_logic = product_logic.ProductLogic()
    # 執行get_model_for_pk()方法，獲取記錄實體
    model = _product_logic.get_model_for_pk(id)
    if model:
        return web_helper.return_msg(0, '查詢成功', model)
    else:
        return web_helper.return_msg(-1, "查詢失敗")

　　和前面的代碼比較，代碼看起來簡單多了

　　直接上單元測試看看執行效果

 1 #!/usr/bin/evn python
 2 # coding=utf-8
 3 
 4 import unittest
 5 from logic import product_logic
 6 
 7 class DbHelperTest(unittest.TestCase):
 8     """資料庫操作包測試類"""
 9 
10     def setUp(self):
11         """初始化測試環境"""
12         print('------ini------')
13 
14     def tearDown(self):
15         """清理測試環境"""
16         print('------clear------')
17 
18     def test(self):
19         ##############################################
20         # 只需要看這裡，其他代碼是測試用例的模板代碼 #
21         ##############################################
22         # 實例化product表操作類ProductLogic
23         _product_logic = product_logic.ProductLogic()
24         # 執行get_model_for_pk()方法，獲取記錄實體
25         model = _product_logic.get_model_for_pk(2)
26         print(model)
27 
28         ##############################################
29 
30 if __name__ == '__main__':
31     unittest.main()

　　輸出結果：

------ini------
{'product_class_id': 1, 'place_of_origin': '廣東廣州', 'name': '餅干', 'id': 2, 'standard': '500g', 'is_enable': 1, 'add_time': datetime.datetime(2018, 7, 25, 23, 10, 4), 'quality_guarantee_period': '2018年12月', 'code': '20180212321211', 'content': '產品描述', 'front_cover_img': 'http://xxx.com/xxx.jpg'}
------clear------

　　做到這一步，一個簡單的通過主鍵值讀取數據表記錄實體的ORM方法就完成了。

　　為了讓這個讀取記錄實體的功能能應用的更加廣泛，我們還需要對它進行改造與加工。

　　在開始之前，大家再繼續思考一下，我們獲取記錄實體，通過主鍵查詢只是眾多方法中的其中一個，我們還會經常使用各種條件的組合來進行查詢，讀取記錄實體，所以這裡我們可以實現自定義條件查詢的方法

    def get_model(self, wheres):
        """通過條件獲取一條記錄"""
        # 如果有條件，則自動添加where
        if wheres:
            wheres = ' where ' + wheres

        # 合成sql語句
        sql = "select %(column_name_list)s from %(table_name)s %(wheres)s" % \
              {'column_name_list': self.__column_name_list, 'table_name': self.__table_name, 'wheres': wheres}
        # 初化化資料庫鏈接
        with db_helper.PgHelper(self.__db, self.__is_output_sql) as db:
            # 執行sql語句
            _result = db.execute(sql)
            # 對返回的內容進行處理
            if _result:
                result = _result[0]
            else:
                result = {}
        return result

　　代碼看起來與前面的get_model_for_pk()方法差不多，只不過將pk參數改為條件參數wheres，不需要再組合主鍵查詢條件而已。由於兩個函數部分代碼一樣，所以我們需要對get_model_for_pk()方法進行重構，直接將組裝好的查詢條件提交給get_model()方法來執行就可以了，將它返回的內容直接返回給主程式。

    def get_model_for_pk(self, pk, wheres=''):
        """通過主鍵值獲取資料庫記錄實體"""
        if not pk:
            return {}
        # 組裝查詢條件
        wheres = '%s = %s' % (self.__pk_name, str(pk))

        return self.get_model(wheres)

　　改造完成後，使用前面的單元測試跑一下，可以看到返回結果一樣。增加了get_model()方法以後，我們就可以靈活的自定義任意的查詢條件來讀取記錄了。這裡要註意的是，使用get_model()方法查詢時，有可能在查詢時會返回多條記錄，這個方法它只返回第一條記錄。需要返回多條記錄時，可以使用我們後續封裝的其他ORM方法。

　　本文對應的源碼下載（為了方便大家理解，源碼包只放了這兩章所用到的一些代碼）

python開發QQ群：669058475（本群已滿）、733466321（可以加2群）作者博客：http://www.cnblogs.com/EmptyFS/

只有將自己置空，才能裝進更多的東西！我是陳煥，資深IT碼農，愛分享愛學習，一位奔跑在求知路上的踐行者。