組件化開發(fā)是大家經(jīng)常討論的話題椒振,也是隨著項(xiàng)目的迭代、工程會(huì)變得越來越臃腫而想到的解決方案胀滚,其實(shí)目前網(wǎng)上組件化方案非常多,每一種都有自己的優(yōu)缺點(diǎn)乱投,我個(gè)人覺得沒有最好的方案咽笼,只有最適合自己項(xiàng)目的方案。
在這里給大家介紹下最近我在公司用的一套組件化解決方案:項(xiàng)目中組件通過protocol協(xié)議依賴戚炫,達(dá)到組件間的解耦合的效果剑刑,組件不需要知道其它組件具體實(shí)現(xiàn)類,即使其它組件不存在也可以正常編譯運(yùn)行双肤,業(yè)務(wù)組件可快速集成到其它項(xiàng)目中施掏,同時(shí)可通過配置文件解決多個(gè)項(xiàng)目中存在差異化的問題。
下圖是項(xiàng)目的架構(gòu)層級(jí)圖:
這里主要介紹下基礎(chǔ)組件層中三個(gè)組件的具體實(shí)現(xiàn):
YPLaunchManager 用于管理各個(gè)業(yè)務(wù)模塊在 UIApplicationDelegate 事件中的任務(wù)茅糜,隔離業(yè)務(wù)與App Delegate之間的耦合其监;
YPProtocolMediator Protocol-ClassName 組件化實(shí)現(xiàn)方案的中間件,用于各個(gè)業(yè)務(wù)模塊之間的通信限匣;
YPAppModuleConfigManager 管理各個(gè)業(yè)務(wù)module的配置,主要解決一個(gè)module用于不同項(xiàng)目中時(shí)且存在差異的問題毁菱。
1米死,YPLaunchManager 用于對(duì)AppDelegate與業(yè)務(wù)功能/模塊解耦
顧名思義是一個(gè)啟動(dòng)任務(wù)管理器,iOS 項(xiàng)目啟動(dòng)相關(guān)的事件都在AppDelegate.m 文件里面贮庞,因此YPLaunchManager是為了解決 AppDelegate 過于復(fù)雜且易耦合其它業(yè)務(wù)模塊的問題峦筒。
YPLaunchManager 用于管理YPLaunchTask任務(wù),每個(gè)業(yè)務(wù)功能/模塊需繼承自YPLaunchTask窗慎,并且實(shí)現(xiàn)相應(yīng)的協(xié)議方法物喷,通過 load 方案進(jìn)行自動(dòng)注冊(cè)卤材,還可以通過finishAfter 來控制業(yè)務(wù)功能/模塊的生命周期,
@interface YPXXXXXLaunchTask : YPLaunchTask
@end
......
// load 方法里面增加 YPLaunchTaskInitNotification 初始化注冊(cè)的通知峦失,在通知里面調(diào)用 +add 來注冊(cè)self
+ (void)load {
[[NSNotificationCenter defaultCenter] addObserverForName:YPLaunchTaskInitNotification object:nil queue:[NSOperationQueue mainQueue] usingBlock:^(NSNotification * _Nonnull note) {
[[self class] add];
}];
}
// 通過 priority 來控制每個(gè)任務(wù)的優(yōu)先級(jí)調(diào)用
- (NSUInteger)priority {
return YPCoreSessionPriority;
}
// 通過finishAfterRun控制Task的生命周期
- (BOOL)finishAfterRun {
return NO;
}
// 實(shí)現(xiàn) YPLaunchTaskDelegate扇丛,與 UIApplicationDelegate 代理方法一致
- (void)runAppDidFinishLauchingBeforeUI {
// 初始化網(wǎng)絡(luò)相關(guān)的數(shù)據(jù)
}
- (void)runAppDidFinishLauchingAfterUI {
}
最后AppDelegate 里面的代碼如下:
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 發(fā)送 YPLaunchTaskInitNotification 通知,注冊(cè)所有的LaunchTask
[[YPLaunchManager defautlManager] loadAllLaunchTask];
[[YPLaunchManager defautlManager] runAppDidFinishLauchingBeforeUI];
//這里需要 設(shè)置 self.window.rootViewController = xxx;
[[YPLaunchManager defautlManager] runAppDidFinishLauchingAfterUI];
return YES;
}
- (void)applicationDidEnterBackground:(UIApplication *)application {
[[YPLaunchManager defautlManager] runAppDidEnterBackground];
}
附Y(jié)PLaunchManager的時(shí)序圖:
2尉辑,YPProtocolMediator 是一種 Protocol-ClassName 組件化方案的中間件
YPProtocolMediator 通過Protocol與Modlue 的 ClassName匹配進(jìn)行查找到具體實(shí)現(xiàn)的組件類帆精,然后組件類實(shí)現(xiàn)的Protocol協(xié)議方法來實(shí)現(xiàn)通信的一種機(jī)制。
每個(gè)組件如果需要外界主動(dòng)調(diào)用則需要實(shí)現(xiàn)port協(xié)議隧魄,如果需要向外界傳遞數(shù)據(jù)則應(yīng)實(shí)現(xiàn)delegate協(xié)議卓练,以下是 YPProtocolMediator 的框架圖:
XXX_Port 定義其它模塊調(diào)用的接口協(xié)議
XXX_Delegate 定義其它模塊接收數(shù)據(jù)的接口協(xié)議;
以下是A與B模塊的通信的實(shí)例:
// ModuleA 從ModuleB 獲取數(shù)據(jù)
// 方式一购啄,通過 port_excuteSelector 方法通信襟企,即使@selector 為聲明編譯也不會(huì)報(bào)錯(cuò)
NSString *uid = [YPMediatorPort(YPUserCenterPort) port_excuteSelector:@selector(port_Uid)];
// selector 帶參數(shù)時(shí)用下面的方法,注意的是args 傳入的是可變參數(shù)狮含,參數(shù)不能為nil
[YPMediatorPort(YPUserCenterPort) port_excuteSelector:@selector(port_Login:password:) args:PhoneNumber, YPParamVaule(Value), nil];
// 方式二:通過獲取 ModuleB 的實(shí)例顽悼,直接調(diào)用方法
NSNumber *userId = [YPMediatorPort(YPUserCenterPort) port_Uid];
[YPMediatorPort(ModuleXXXB_Port) port_Login:@"phoneNumber" password:@"password"];
方式一 和 方式二的區(qū)別是,如果 ModuleXXXB_Port 更新且不兼容舊版辉川,刪除了某個(gè)方法表蝙。
方式一可以編譯通過,但是會(huì)報(bào)警告乓旗;
方式二編譯不通過府蛇,直接報(bào)錯(cuò);
所以當(dāng) ModuleA 強(qiáng)依賴 ModuleB 里面的某個(gè)方法時(shí)屿愚,則建議使用方式二通信汇跨,其它情況則建議方式一進(jìn)行通信。
ModuleA 接收 ModuleB 的數(shù)據(jù)傳遞:
// 方法一:通過 YPProtocolMediator 組件實(shí)現(xiàn)的給類對(duì)象動(dòng)態(tài)添加函數(shù)的方法(-addSelector:forProtocol:block:bindTarget:)進(jìn)行通信
// 向 ModuleA 類添加方法通過 block 回調(diào)來實(shí)現(xiàn)數(shù)據(jù)傳遞
[self yp_addDelegateSelector:@selector(userCenter:loginStatus:) paramBlock:^(YPParams *params) {
id targetB = params[0];
NSNumber *loginStatus = [params objectAtIndex:1];
NSLog(@"target %@ %@, status is %@",targetB, loginStatus);
} forProtocol:@protocol(YPUserCenterDelegate)];
// 方法二:可以像傳統(tǒng)的delegate來實(shí)現(xiàn)數(shù)據(jù)傳遞
// 1妆距,將self 與 ModuleXXXB_Delegate 代理綁定
YPMediatorBind(self, ModuleXXXB_Delegate);
// 2穷遂,ModuleA 實(shí)現(xiàn) ModuleXXXB_Delegate 的代理方法
- (void)userCenter:(id<ModuleXXXB_Port>)moduleXXXB loginStatus:(BOOL)loginStatus {
}
YPProtocolMediator 組件查找實(shí)現(xiàn):
誠(chéng)如上面說的 ,YPProtocolMediator 查找Module 是通過Protocol 與 ClassName 匹配進(jìn)行查找的娱据。
實(shí)現(xiàn)代碼如下:
/**根據(jù)傳入的組件協(xié)議返回實(shí)現(xiàn)該協(xié)議的類的對(duì)象*/
- (id)moduleInstanceFromProtocol:(Protocol *)protocol {
// 獲取協(xié)議名字
NSString *className = NSStringFromProtocol(protocol);
//......此處省略代碼
if ([className hasSuffix:self.portSuffix]) {
className = [className substringToIndex:className.length - self.portSuffix.length];
}
// 通過協(xié)議名字來查找對(duì)應(yīng)class
Class aClass = NSClassFromString(className);
//......此處省略代碼
// 沒有找到對(duì)應(yīng)的module蚪黑,是否設(shè)置了 defaultModule 來處理相關(guān)事件
if (!aClass && self.defaultModule) {
aClass = NSClassFromString(self.defaultModule);
}
// 生成 module 實(shí)例
module = [[aClass alloc] init];
if ([module conformsToProtocol:protocol]){
self.modulesDictionary[NSStringFromProtocol(protocol)] = module;
return module;
}
// 未找到實(shí)現(xiàn)該協(xié)議的組件
return nil;
}
3,YPAppModuleConfigManager 是各個(gè)業(yè)務(wù)組件的配置管理類中剩,主要解決業(yè)務(wù)組件用于不同項(xiàng)目中又存在差異的問題
YPAppModuleConfigManager 通過加載json配置文件數(shù)據(jù)忌穿,然后 Module 通過 YPAppModuleConfigManager 獲取自己模塊的ModuleConfig
設(shè)計(jì)框架圖如下:
實(shí)際使用:
// 可結(jié)合 YPLaunchManager 使用
- (void)runAppDidFinishLauchingBeforeUI {
// 加載 SystemConfig
NSString *systemConfigPath = [[NSBundle mainBundle] pathForResource:@"SystemConfig" ofType:@"json"];
[YPConfigManager loadModuleConfigWithPath:ModuleConfigPath];
// 加載 Module 的config
NSString *ModuleConfigPath = [[NSBundle mainBundle] pathForResource:@"ModuleAConfig" ofType:@"json"];
[YPConfigManager loadModuleConfigWithPath:systemConfigPath];
}
------ moduleA 獲取配置
YPModuleA_ModuleConfig *configModel = [[YPAppModuleConfigManager sharedManager] parseModuleConfigClass:[YPModuleA_ModuleConfig class]];
// 設(shè)置相應(yīng)的顏色和字體 等等
self.navigation.color = configModel.navigationBarTintColor
self.navigation.titleFont = configModel.navigationTitleFont
json 文件示例:
{
"YPBaseControllerModuleConfig" : {
"navigationBarTintColor":"#ffffff", // navigation 顏色
"navigationTitleFont":"Medium 18.0f", // navigation 字體
"backNavigationItemImageName" : "yp_navigation_back", // navigation 返回圖片
},
}
最后附項(xiàng)目Demo地址
參考資料:iOS組件化方案對(duì)比