個人第一個python web開發框架（27）——定製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方法。

 

　　

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

 

 

版權聲明：本文原創發表於 博客園，做者爲 AllEmpty 本文歡迎轉載，但未經做者贊成必須保留此段聲明，且在文章頁面明顯位置給出原文鏈接，不然視爲侵權。

python開發QQ羣：669058475（本羣已滿）、733466321（能夠加2羣）    做者博客：http://www.cnblogs.com/EmptyFS/