python 中Mixin混入類的使用方法詳解

前言

最近在看sanic的源碼,發現有很多Mixin的類,大概長成這個樣子

class BaseSanic(
    RouteMixin,
    MiddlewareMixin,
    ListenerMixin,
    ExceptionMixin,
    SignalMixin,
    metaclass=SanicMeta,
):

於是對於這種 Mixin 研究瞭一下,其實也沒什麼新的東西,Mixin 又稱混入,隻是一種編程思想的體現,但是在使用過程中還是有一些需要註意的地方。 大傢都知道,python 是一種允許多繼承的語言,一個類可以繼承多個類,這和java不太一樣,java類隻能有一個父類, 但是java 中有接口的概念,一個類可以實現多個接口,但是java的接口隻是定義的函數的簽名,並沒有具體的實現,具體的實現需要相應的類來完成。 python 就不一樣瞭,一個類可以有多個父類,而混入類就是這種允許多繼承語言中才有的一種編程模式。 為瞭更好的理解混入,我們舉一個生活中的例子—手機, 手機有很多功能,由不同的硬件組合而成,手機有接打電話,收發短信,上網,聽歌等功能,組裝一臺手機就需要將各種硬件進行拼接。 如果我們把這些功能抽象成類,那麼我們可以有以下寫法,為瞭簡單一點,隻列接打電話,收發短信功能。

class Tel:
    def telfunc(self):
        print("我可以接打電話")
        class SMS:
    def smsfunc(self):
        print("我可以發短信")
        class Phone:
    def __init__(self, sn):
        self.sn = sn

上面的代碼中, 有三個類,Tel 類,它有一個 telfunc 方法用於表示有接打電話的能力(或者說是功能), SMS 類有smsfunc表示SMS類有發短信的能力。 而 Phone 這個類才是一個手機類,它應該具有接打電話和發送短信的能力,但是如果我們用上面的方式定義Phone 這個類,則這個類並沒有接打電話和收發短信的能力。 我們可以怎樣做讓Phone這個類可以具有打電話和發短信的能力? 我們可以在Phone 這個類裡再重新定義二個方法 telfunc和 smsfunc,也就是將Tel類和SMS類裡的方法再寫一遍,這種其實不符合 don't repeate youself的理念。 正常情況下我們是讓Phone這個類繼承Tel類和SMS類,這樣Phone這個類就自動擁有瞭接打電話和發短信的能力瞭。

class Tel:
    def telfunc(self):
        print("我可以接打電話")
​class SMS:
    def smsfunc(self):
        print("我可以發短信")
​
​class Phone(Tel, SMS):
    def __init__(self, sn):
        self.sn = sn
​    def welcome(self):
        print("welcome {}".format(self.sn))
​p = Phone("xiaomi")
p.telfunc()
p.smsfunc()
p.welcome()
​
'''
我可以接打電話
我可以發短信
welcome xiaomi
'''

像這種類的定義就是我們所說的混入,將通話功能與短信功能加入到手機中,讓手機擁有接打電話和發送短信的功能,這種混入的編碼思想有時可以減少很多代碼量。很方便的根據一個類需要哪些功能就將哪個類“混入”到該類中。 通常情況下,我們會將混入類的命名以Mixin結尾,像上面的代碼我們會寫成下面這樣

class TelMixin:
    def telfunc(self):
        print("我可以接打電話")
​class SMSMixin:
    def smsfunc(self):
        print("我可以發短信")
​class Phone(TelMixin, SMSMixin):
    def __init__(self, sn):
        self.sn = sn
​    def welcome(self):
        print("welcome {}".format(self.sn))

以 Mixin 結尾的類,一般是那種功能比較單一,且一般都是某一類型的功能, 如最開始介紹的sanic混入類 RouteMixin 與路由相關的功能類,MiddlewareMixin 是與中間件相關的類,ListenerMixin 是監聽器相關的類,這些類裡的方法專註於自己相關的功能,如果有哪個類需要這些功能,那定義的時候就繼承自這些類。

有人會問瞭,我不想多繼承,管理MRO 太麻煩瞭,我隻想單繼承,我定義一個統一的父類,它即有接打電話,也有收發短信的功能,還可以聽歌,然後讓手機來繼承這個類不好嗎?

如下面的代碼:

class Tel:
    def telfunc(self):
        print("我可以接打電話")
    def smsfunc(self):
        print("我可以發短信")
    def songfunc(self):
        print("我可以放音樂")
​
​class Phone(Tel):
    def __init__(self, sn):
        self.sn = sn
​    def welcome(self):
        print("welcome {}".format(self.sn))

首先這種寫法當然是可以的,語法上沒有任何問題,也很好的實現瞭相應的功能,代碼量也減少瞭,但是這裡大傢想一個邏輯問題,如果我想造一個ipod類,ipod 這個類沒有接打電話收發短信的功能,隻有聽歌的功能,那麼我此時要寫這個類該如何定義? 是不是要定義一個ipod類,然後再寫它的聽歌方法songfunc,如果此時使用混入的編程思想,那麼我們就完全可以定義ipod類的時候 不加入 接打電話和收發短信的類就可以瞭。

class TelMixin:
    def telfunc(self):
        print("我可以接打電話")
​class SMSMixin:
    def smsfunc(self):
        print("我可以發短信")
        class SongMixin:
    def songfunc(self):
        print("我可以放音樂")
​class Phone(TelMixin, SMSMixin, SongMixin):
    def __init__(self, sn):
        self.sn = sn
​class Ipod(SongMixin):
    def __init__(self, sn):
        self.sn = sn

如果還有別的什麼類,比如對講機,它隻有接打電話的功能,那麼我們就隻需要把接打電話的功能混入到對講機類即可, class Intercom(TelMixin):

但是有人又會問瞭,這樣的混入,雖說少寫瞭一些代碼,但是如果子類相應實現並不完全和父類一致該如何處理? 如對講機雖然可以通話,但是它是單向通話,並不能雙向通話的。 這時對於子類實現與父類不一致的情況,那麼就需要子類重寫父類方法瞭,也就是OOP中的繼承與多態,嚴格意義上來說, python 並沒有多態,或者說它天然的就是多態。

class TelMixin:
    def telfunc(self):
        print("我可以接打電話")
​class SMSMixin:
    def smsfunc(self):
        print("我可以發短信")
​class SongMixin:
    def songfunc(self):
        print("我可以放音樂")
​class Intercom(TelMixin):
    def __init__(self, sn):
        self.sn = sn
​    def telfunc(self):
        print("對講機{} 的通話".format(self.sn))
​class Phone(TelMixin, SMSMixin, SongMixin):
    def __init__(self, sn):
        self.sn = sn
​class Ipod(SongMixin):
    def __init__(self, sn):
        self.sn = sn
​def testTelfunc(o):
    o.telfunc()
d = Intercom("moto")
p = Phone("huawei")
ipod = Ipod("apple")
testTelfunc(d)
testTelfunc(p)
testTelfunc(ipod)

以上代碼,我們重寫瞭對講機類的telfunc 方法,但是並沒有對Ipod類實現通話功能, 然後寫瞭一個testTelfunc(o) 方法來調用傳入參數的通話功能,

得到以下輸出:

#對講機moto 的通話
#我可以接打電話
Traceback (most recent call last):
  File "/Users/yyx/test/test.py", line 54, in <module>
    testTelfunc(ipod)
  File "/Users/yyx/test/test.py", line 46, in testTelfunc
    o.telfunc()
AttributeError: 'Ipod' object has no attribute 'telfunc'

當給testTelfunc 傳入的是對講機Intercom 對象時,由於該類重寫瞭telfunc方法,所以這裡調用的是該子類的telfunc方法,當傳入的是Phone類對象時,由於該類繼承瞭TelMixin類,且沒有重寫telfunc方法,所以這裡會調用TelMixin類中的telfunc 方法,但是當傳入的是Ipod類時,這個類既沒有繼承TelMixin,也沒有自己的telfunc方法,所以就崩潰瞭。這也是一種另類的多態體現吧,隻是它沒有像java中的那麼嚴格。

Mixin 與繼承的區別

說瞭那麼多的Mixin混入,其實它本質上就是繼承,隻是這種繼承是存在於允許多繼承的編程語言中,如果說區別,本質上也沒有什麼區別,如果硬是要說些區別,其實也是有一點點。

  • 首先,Mixin 類最好不要有初始化方法,也就是 __init__ 方法,因為如果Mixin類定義瞭初始化方法,那麼在子類中也最好調用一下父類也就是混入類的初始方法super().__init__(),當然不調用也沒關系,IDE 隻會給你一個提示,語法上並沒有什麼錯誤。
  • Mixin 類最好不要單獨的實例化,因為混入類的設計初衷就是要讓子類來繼承的,然後子類可以豐富混入類的功能,混入類隻是為瞭讓子類擁有某些功能而來的。
  • Mixin 類最好是某一類功能的合集,比如上面sanic 源碼中的 RouteMixin 混入類,它隻定義與路由相關的功能方法,這樣的好處是,不會有同名的方法,如果混入類中有同名的方法,那麼就給自己找麻煩瞭,排查問題也不太好排查,其實這個也是比單繼承自一個類方便的地方。

說瞭那麼多Mixin 的好處,它有什麼不好的地方嗎? 其實在我看來,有一個問題,也說不上是不好,隻是習慣問題,以前寫代碼還是寫單繼承多一些,並不太習慣這種多繼承的方式,不過如果一切都按照相應的規則來操作也不是什麼大問題。 還有一個問題就是功能的拆分,這個很是考驗編程人員在設計代碼之初整體把握能力,就像單體應用想要拆分成微服務,邊界問題可能是開始時最頭疼的,拆細瞭吧,會寫出很多類,拆粗瞭吧,就又回到單繼承的思維模式瞭,所以這個也是個經驗問題吧。

總結

Mixin 混入也可以說是編程模式,並不是什麼新的語法,用好混入類可以使自己的代碼結構清晰,功能明瞭,所以以後在設計類時要多考慮使用Mixin混入類的實現方式。

到此這篇關於python 中Mixin混入類的使用方法詳解的文章就介紹到這瞭,更多相關python Mixin混入類內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: