淺析Python中接口與抽象基類的使用

更新時間：2024年12月15日 08:24:39 作者：databook

這篇文章主要為大家詳細(xì)介紹了Python中兩個為面向?qū)ο缶幊烫峁┑膹?qiáng)大工具接口和抽象基類的使用,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

1. 接口（Protocols）

Python3.8開始在類型模塊中引入的接口Protocols的概念，它提供了一種無需顯式繼承即可定義接口的方法。

接口Protocols定義了一組方法或?qū)傩?，只要一個對象實現(xiàn)了這些方法或?qū)傩裕捅灰暈闈M足該接口。

下面通過一個示例來幫助理解Protocols的使用，如果有面向?qū)ο缶幊痰慕?jīng)驗，很容易就能理解這個概念。

這個示例來自最近用的一個量化交易系統(tǒng)的一部分，這個功能需要從不同的來源獲取數(shù)據(jù)，然后進(jìn)行分析，最后將分析結(jié)果以不同的方式輸出。

這三個步驟（獲取數(shù)據(jù)，分析和輸出）中，

假設(shè)獲取數(shù)據(jù)的來源有網(wǎng)絡(luò)(API)，文件(CSV)和數(shù)據(jù)庫3種；

分析的步驟是統(tǒng)一的；輸出的方式假設(shè)也有多種，比如郵件，短信等等。

根據(jù)這個描述，使用Protocols構(gòu)建的獲取數(shù)據(jù)和分析部分的代碼如下：

（輸出的部分暫時不管）

from typing import Protocol


# 輸入數(shù)據(jù)的接口
class InputData(Protocol):
    def get_data(self) -> str:
        pass


class APIHandler:
    def get_data(self) -> str:
        print("get_data from API")
        return "get data from API"


class CSVHandler:
    def get_data(self) -> str:
        print("get_data from CSV")
        return "get data from CSV"


class SqliteHandler:
    def get_data(self) -> str:
        print("get_data from SQLITE DATABASE")
        return "get data from SQLITE DATABASE"


# 分析數(shù)據(jù)
def analysis(i: InputData):
    data = i.get_data()

    print("開始處理數(shù)據(jù)...")

InputData繼承了Protocol，其中定義了接口的函數(shù)get_data。

只要實現(xiàn)了get_data的class，比如APIHandler，CSVHandler和SqliteHandler，都可以當(dāng)做InputData類型。

從代碼可以看出，我們不需要用APIHandler去繼承InputData，只要實現(xiàn)InputData中的所有方法就可以了。

這種靈活性確保了系統(tǒng)的可擴(kuò)展性，我們可以添加新的數(shù)據(jù)源類型，而無需修改現(xiàn)有代碼。

接下來我們測試上面的代碼是否可以正常使用：

if __name__ == "__main__":
    i = APIHandler()
    analysis(i)
    print("\n")

    i = CSVHandler()
    analysis(i)
    print("\n")

    i = SqliteHandler()
    analysis(i)
    print("\n")

運行結(jié)果：

$ python.exe .\protocol_abc.py
get_data from API
開始處理數(shù)據(jù)...

get_data from CSV
開始處理數(shù)據(jù)...

get_data from SQLITE DATABASE
開始處理數(shù)據(jù)...

2. 抽象基類（ABC）

Protocol非常具有靈活性，但有時我們需要更結(jié)構(gòu)化的方法，這就是抽象基類 (ABC) 的用武之地。

ABC 是一種通過定義子類必須實現(xiàn)的嚴(yán)格接口來強(qiáng)制執(zhí)行一致行為的工具。

與Protocol不同，ABC 需要顯式繼承，因此當(dāng)我們希望在代碼中明確定義層次結(jié)構(gòu)時，ABC是更好的選擇。

接著實現(xiàn)上一節(jié)示例中的輸出部分，每種不同的輸出需要不同的配置，

比如輸出到郵件需要先配置郵箱的賬號信息，輸出到短信需要配置手機(jī)信息等等。

在這里，我們使用 ABC 來實現(xiàn)輸出的基類。

# 輸出的抽象基類
class OutputResult(ABC):
    def __init__(self):
        self.settings: dict = {}

    @abstractmethod
    def send(self, data: str):
        pass

    @abstractmethod
    def config(self, settings: dict):
        pass


class OutputMail(ABC):
    def send(self, data: str):
        print(f"send {data} to {self.settings['name']}")

    def config(self, settings: dict):
        self.settings = settings


class OutputMessage(ABC):
    def send(self, data: str):
        print(f"send {data} to {self.settings['name']}")

    def config(self, settings: dict):
        self.settings = settings

這里使用抽象基類的原因是輸出時，并不是簡單的調(diào)用send方法就可以的，還需要配置輸出的參數(shù)，

所以用帶有結(jié)構(gòu)的抽象基類更好。

加上輸出之后，上一節(jié)中的分析函數(shù)也改為：

# 分析數(shù)據(jù)
def analysis(i: InputData, o: OutputResult):
    data = i.get_data()

    print("開始處理數(shù)據(jù)...")
    data = data.replace("get data from ", "")

    o.send(data)

測試的代碼如下：

if __name__ == "__main__":
    i = APIHandler()
    o = OutputMail()
    o.config({"name": "aaa@bbb.com"})
    analysis(i, o)
    print("\n")

    i = CSVHandler()
    o = OutputMessage()
    o.config({"name": "13911123456"})
    analysis(i, o)
    print("\n")

    i = SqliteHandler()
    o = OutputMail()
    o.config({"name": "xyz@www.com"})
    analysis(i, o)
    print("\n")

運行結(jié)果：

$ python.exe .\protocol_abc.py
get_data from API
開始處理數(shù)據(jù)...
send API to aaa@bbb.com

get_data from CSV
開始處理數(shù)據(jù)...
send CSV to 13911123456

get_data from SQLITE DATABASE
開始處理數(shù)據(jù)...
send SQLITE DATABASE to xyz@www.com