跳至主要内容

共用函式庫

本目錄用於存放與業務邏輯無關之共用組件,如記錄伺服器運作狀態的logger,經過重新封裝以利於使用/抽換的json庫等。考慮到本目錄底下的元件具有高度重用的性質,未來應被封裝過後的工具庫所替代。在現階段的開發過程中,若有重新封裝第三方套件的需求,請嘗試放置於此目錄下,並遵守幾個原則:

  1. 請勿在此 實作/耦合 業務邏輯: 共用元件應保持通用性,不得依賴特定模組或流程。
  2. 附上基本的使用說明: 看你是要寫README還是註解裡交代怎麼使用,限制條件等。
  3. 保留可替換性的底層實作: 以json庫為例,有些庫性能很好但只能運行在x86下,但是開發的時候手邊可能只有arm的機器。透過將不同的庫封裝成同一介面,以利開發測試營運時抽換。

若你在開發的過程中為了解決某些問題做了一些工具,若該工具能夠獨立於業務邏輯,且未來有可能會在其他地方用到,亦可以考慮將它放在這裡。