跳至內容

模組化架構（TMA）

TMA 是一種架構方法，用於規劃應用程式結構以提升可擴展性、最佳化建置與測試週期，並確保團隊遵循良好實踐。其核心理念是透過建置獨立的功能模組，並使用清晰簡潔的 API 將它們相互連接，從而建構你的應用程式。

這些指南介紹了該架構的原則，協助你識別並將應用程式功能組織到不同的層級中。如果你決定採用此架構，這裡也提供了相關提示、工具與建議。

µFeatures

此架構先前稱為 µFeatures。我們將其更名為「模組化架構（TMA）」，以更準確地反映其目的與背後的原則。

核心原則#

開發人員應能快速建置、測試並試用其功能，且無需依賴主應用程式，同時確保 Xcode 功能（如 UI 預覽、程式碼自動完成與偵錯）能可靠運作。

什麼是模組#

模組代表一個應用程式功能，由以下五個 Target（此處指 Xcode Target）組合而成：

  • Source： 包含功能的原始碼（Swift、Objective-C、C++、JavaScript 等）及其資源（圖片、字型、Storyboard、XIB）。
  • Interface： 這是一個配套 Target，包含功能的公開介面與模型。
  • Tests： 包含功能的單元測試與整合測試。
  • Testing： 提供可用於測試與範例應用程式的測試資料。它還提供模組類別與協定的模擬物件（mocks），供其他功能後續使用。
  • Example： 包含一個範例應用程式，開發人員可用於在特定條件下（不同語言、螢幕尺寸、設定）試用該功能。

我們建議為 Target 遵循命名規範，藉助 Tuist 的 DSL，你可以在專案中強制執行此規範。

Target相依性內容
FeatureFeatureInterface原始碼與資源
FeatureInterface-公開介面與模型
FeatureTestsFeature, FeatureTesting單元與整合測試
FeatureTestingFeatureInterface測試資料與模擬物件
FeatureExampleFeatureTesting, Feature範例應用程式
UI 預覽

Feature可以將FeatureTesting用作開發資源，以啟用 UI 預覽

使用編譯器指示詞取代測試 Target

或者，你可以在為Debug編譯時，使用編譯器指示詞將測試資料與模擬物件包含在Feature或FeatureInterfaceTarget 中。這會簡化相依圖，但最終你會編譯一些執行應用程式時不需要的程式碼。

為什麼需要模組#

清晰簡潔的 API#

當所有應用程式原始碼都位於同一個 Target 時，很容易在程式碼中建立隱含相依性，最終導致眾所周知的義大利麵式程式碼。所有內容緊密耦合，狀態有時難以預測，引入新變更更成為噩夢。當我們在獨立 Target 中定義功能時，必須將公開 API 的設計作為功能實作的一部分。我們需要決定哪些內容應公開、功能應如何被使用，以及哪些內容應保持私有。我們可以更有效控制功能客戶如何使用該功能，並透過設計安全的 API 來強制推行良好實踐。

小型模組#

分而治之。在小型模組中工作能让你更專注，並隔離測試與試用功能。此外，開發週期會大幅加快，因為我們進行更具選擇性的編譯，僅編譯讓功能運作所需的元件。只有在工作的最後階段，當需要將功能整合到應用程式中時，才需要編譯整個應用程式。

可重用性#

鼓勵使用 Framework 或函式庫在應用程式與其他產品（如擴充功能）之間重用程式碼。透過建置模組，重用變得相當直接。我們可以僅透過組合現有模組並 （必要時） 加入平台專屬的 UI 層，來建置 iMessage 擴充功能、Today Extension 或 watchOS 應用程式。

相依性#

當一個模組相依於另一個模組時，它會針對該模組的 Interface Target 宣告相依性。這樣做有兩大好處。它能防止一個模組的實作與另一個模組的實作緊密耦合，並加速乾淨建置，因為只需編譯我們功能的實作，以及直接與間接相依性的介面。此方法靈感來自 SwiftRock 提出的使用 Interface Modules 減少 iOS 建置時間概念。

依賴介面要求應用程式在執行時期建置實作圖，並將其依賴注入到需要的模組中。雖然 TMA 對如何實現這一點沒有特定立場，但我們建議使用不會增加建置時間間接性或使用非為此目的設計的平台 API 的依賴注入解決方案或模式。

產品類型#

在建置模組時，你可以為 Target 選擇函式庫與 Framework，以及靜態與動態連結。若沒有 Tuist，做出此決定會較為複雜，因為你需要手動設定相依圖。不過，得益於 Tuist Projects，這已不再是問題。

我們建議在開發期間使用動態函式庫或 Framework，並透過bundle accessors將 bundle 存取邏輯與 Target 的函式庫或 Framework 性質解耦。這對於加快編譯速度並確保SwiftUI Previews可靠運作至關重要。而在發布建置中使用靜態函式庫或 Framework，以確保應用程式快速啟動。你可以利用dynamic configuration在建置產生時期變更產品類型：

bash
# You'll have to read the value of the variable from the manifest {#youll-have-to-read-the-value-of-the-variable-from-the-manifest}
# and use it to change the linking type {#and-use-it-to-change-the-linking-type}
TUIST_PRODUCT_TYPE=static-library tuist generate
swift
// You can place this in your manifest files or helpers
// and use the returned value when instantiating targets.
func productType() -> Product {
if case let .string(productType) = Environment.productType {
return productType == "static-library" ? .staticLibrary : .framework
} else {
return .framework
}
}
可合併函式庫

Apple 嘗試透過引入可合併函式庫來減輕在靜態與動態函式庫之間切換的繁瑣。然而，這會引入建置時期的非確定性，導致你的建置無法重現且更難最佳化，因此我們不建議使用。

程式碼#

TMA 對模組的程式碼架構與模式沒有特定立場。不過，我們希望根據經驗分享一些建議：

  • 善用編譯器是很好的。 過度依賴編譯器可能會降低生產力，並導致某些 Xcode 功能（如預覽）運作不穩定。我們建議利用編譯器來強制落實良好實踐並及早捕捉錯誤，但不要過度到讓程式碼更難閱讀與維護的程度。
  • 謹慎使用 Swift Macros。 它們雖然強大，但也可能讓程式碼更難閱讀與維護。
  • 擁抱平台與語言，不要將其抽象化。 試圖設計複雜的抽象層可能會適得其反。平台與語言本身已足夠強大，無需額外抽象層就能建置出色的應用程式。參考良好的程式設計與設計模式來建置你的功能。

資源#