img

前言

在模組化的過程中,業(yè)務(wù)模塊間的通信往往是處理最多的.與其應(yīng)運(yùn)而生的解決方案有以下幾種:

1. 提前注冊服務(wù)
2. Runtime 動(dòng)態(tài)發(fā)現(xiàn)服務(wù)

前輩們在借鑒 web 服務(wù)路由設(shè)計(jì)之后,將服務(wù)綁定至固定規(guī)則的 URL 上.

1. CTMediator: Target-Action 形式設(shè)計(jì)的路由組件.
2. 其他以統(tǒng)一注冊形式設(shè)計(jì)的路由.

前情提要

什么是 Target-Action?

ans: 目標(biāo)-行為模式,它貫穿于iOS開發(fā)始終, 最常見的便是:

UIButton().addTarget(target: target, action: action, for: event)    

什么是 Target-Action 形式的路由?

ans: 在觸發(fā)路由路徑時(shí), 通過 Runtime機(jī)制來發(fā)現(xiàn)具體服務(wù),并執(zhí)行.

相對(duì)于提前統(tǒng)一注冊的路由,相當(dāng)于懶加載.

Khala 路由組件使用

一. 編寫 服務(wù)類(路由類)

1. 繼承自NSObject: Runtime機(jī)制本身便是基于 NSObject.
2. 聲明@objc(ClassName): 由于Xcode 8.0之后在編譯時(shí)會(huì)移除未顯式使用的swift類與函數(shù),所以需要加此聲明.(服務(wù)類不建議在任何模塊實(shí)例化,會(huì)破壞設(shè)計(jì)邏輯)
3. 聲明@objcMembers: 在swift 4.0 中繼承 NSObject 的 swift class 不再默認(rèn)全部橋接到 objective-c,如果我們想要使用的話我們就需要在class前面加上 @objcMembers 這么一個(gè)關(guān)鍵字.
4. 示例如下如下:

@objc(AModule) @objcMembers
class AModule: NSObject { }

二. 編寫 服務(wù)函數(shù)(路由函數(shù))

1. 參數(shù)類型限制: 只能使用單個(gè)KhalaInfo(集合類型)與多個(gè) KhalaClosure(閉包類型)

2. 第一個(gè)參數(shù)需要匿名: 方便查找函數(shù), 非匿名swift函數(shù)橋接至 objective-c時(shí)會(huì)形成funNameWithParam結(jié)構(gòu).(Khala前期在此花費(fèi)時(shí)間較多, 最后還是采用該折中方案.)

3. 示例如下如下:

   @objc(AModule) @objcMembers
   class AModule: NSObject,UIApplicationDelegate {
    
     func vc() -> UIViewController {
       let vc = UIViewController()
       vc.view.backgroundColor = UIColor.red
       return vc
     }
       
    func action(_ info: KhalaInfo, success: KhalaClosure, failure: KhalaClosure) {
       success(["success": #function])
       failure(["failure": #function])
     }
       
   }
   

三. 調(diào)用

1. 通用型調(diào)用

    Khala(str: "kf://AModule/forClosures")?.call(blocks: { (item) in
      print("forClosures block3:", item)
    },{ (item) in
      print("forClosure block4:", item)
    })
   
   let value = Khala(str: "kl://AModule/doSomething")?.call()
   

2. UIKit特例化調(diào)用:

   guard let vc = Khala(str: "kl://BModule/vc?style=0")?.viewController else { return }
   self.navigationController?.pushViewController(vc, animated: true)
   

四. URL重寫 (KhalaRewrite)

該部分設(shè)計(jì)來源自nginx: 在某些場景下需要對(duì) URL 進(jìn)行轉(zhuǎn)化與攔截, 例如:

1. 服務(wù)類與服務(wù)函數(shù)存在前綴.

2. 接收非標(biāo)準(zhǔn) URL .

3. URL重定向: 頁面的動(dòng)態(tài)升降級(jí), 示例如下:

   let filter = KhalaRewriteFilter {
         if $0.url.host == "AModule" {
           var urlComponents = URLComponents(url: $0.url, resolvingAgainstBaseURL: true)!
           urlComponents.host = "BModule"
           $0.url = urlComponents.url!
         }
         return $0
       }
   
   Khala.rewrite.add(filter: filter)
   
   // "kl://AModule/doSomething" => "kl://BModule/doSomething"
   let value = Khala(str: "kl://AModule/doSomething")?.call()
   print(value ?? "nil")
   

五. UIApplicationDelegate 生命周期分發(fā)

部分組件往往依賴于主工程中的AppDelegate中部分函數(shù).

1. 在Khala中,需要顯式的在主工程中的AppDelegate調(diào)用與處理相關(guān)邏輯.
2. 服務(wù)類需要遵守UIApplicationDelegate協(xié)議.

主工程AppDelegate:

@UIApplicationMain
class AppDelegate: UIResponder,UIApplicationDelegate {

  var window: UIWindow?

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    let list = Khala.appDelegate.application(application, didFinishLaunchingWithOptions: launchOptions)
    return true
  }
    
}

組件中服務(wù)類:

@objc(AModule) @objcMembers
class AModule: NSObject,UIApplicationDelegate {
  
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    print("AModule.didFinishLaunchingWithOptions")
    return true
  }
  
}

六. 日志模塊: KhalaHistory

每一份url請求都將記錄至日志文件中, 可以在適當(dāng)?shù)臅r(shí)候提供開發(fā)者便利.

1. 開啟日志(默認(rèn)關(guān)閉)

   Khala.isEnabledLog = true
   // or 
   Khala.history.isEnabled = true
   

2. 文件路徑: /Documents/khala/logs/

3. 文件內(nèi)容: 日期 + 時(shí)間 + URL + 參數(shù)

2018-12-01 02:06:54  kl://SwiftClass/double?  {"test":"666"}
2018-12-01 02:06:54  kl://SwiftClass/double  {"test":"666"}

七. 擴(kuò)展機(jī)制: KhalaStore

khala 庫中提供了一個(gè)空置的類[KhalaStore]用于盛放路由函數(shù)對(duì)應(yīng)的本地函數(shù).來簡化本地調(diào)用復(fù)雜度的問題.

extension KhalaStore { 
 class func aModule_server(value: Int) -> Int {
    return Khala(str: "kf://AModule/server", params: ["value": value])!.call() as! Int
  }
}
  
@objc(AModule) @objcMembers
class AModule: NSObject {
 func server(_ info: [String: Any]) -> Int {
    return info["value"] as? Int ?? 0
  }
}

let value = KhalaStore.aModule_server(value: 46)

ps: KhalaStore 擴(kuò)展文件建議統(tǒng)一放置.

八. 斷言機(jī)制

為方便開發(fā)者使用,添加了部分場景下斷言機(jī)制,示例:

khala.iOS Fatal error: [Khala] 未在[AModule]中匹配到函數(shù)[server], 請查看函數(shù)列表:
0: init
1: doSomething:
2: vc

關(guān)閉斷言(默認(rèn)開啟):

Khala.isEnabledAssert = false

九. 緩存機(jī)制: KhalaClass.cache

• 當(dāng)路由第一次調(diào)用/注冊路由類時(shí),該路由類將被緩存至 KhalaClass.cache 中, 以提高二次查找性能.

• 當(dāng)路由類實(shí)例化時(shí),該路由類中的函數(shù)列表將被緩存至 KhalaClass().methodLists中, 以提高查找性能.

十. 本司基于路由實(shí)現(xiàn)的業(yè)務(wù)架構(gòu)

僅供參考, 合適才是最好的.

image

相關(guān)鏈接

Marmot-iOS: 基于 Khala 設(shè)計(jì)的 hybird(WKWebview <=> Native ) 通信組件.

參考

蘋果核 - 解耦神器 —— 統(tǒng)跳協(xié)議和Rewrite引擎.

蘑菇街路由組件: MGJRouter / 阿里開源組件化方案: BeeHive

casa: iOS應(yīng)用架構(gòu)談 組件化方案

bang: iOS 組件化方案探索

linhey: iOS 模組化設(shè)計(jì)方案