您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

iOS 模組化開發的實戰方案:路由、解耦與私有 Pods

編輯:iOS 開發基礎

本文為投稿文章,作者 wujunyang。

jiaModuleDemo 是為了回答「專案裡到底該怎麼做模組化」而寫的示範專案,涵蓋路由式跳轉、本地模組間互動的實作方式。目前抽離的粒度停在頁面層級,同時也把各模組共用的基礎能力抽出來,搭配私有 Pods 管理。

先談專案裡的痛點

問題一:頁面之間耦合太嚴重

上圖左側就是現況:頁面彼此直接相依,傳參方式也各不相同。由於開發者習慣不一,有人傳實體物件、有人傳基本型別,五花八門;加上專案原本不支援路由,導致「收到推播後要跳不同頁面」這種需求只能寫死,後續擴充非常痛苦。右側則是模組化之後的樣子:頁面之間不再互相認識,全部只依賴 JiaMediator 這個中介者,傳參統一用字典。雖然犧牲了一點自由度與便利性,卻換來了真正的解耦,同時也具備路由能力。

之所以自寫路由而不採用第三方路由套件,是因為它的彈性更高,而且省掉了第三方方案在啟動時必須註冊路由的負擔。

問題二:相同模組被反覆重造

當公司同時跑多個專案,甚至是不同的人各自負責不同專案時,就會出現上圖的狀況。其實每個 App 都有大量共通模組。複製貼上當然是一種做法,但那絕對不是好做法:日後迭代時,不同的人都會往裡面塞進帶有個人色彩的程式碼,最後同一個模組在不同專案裡各自生長,統一管理變成災難,交接給別人接手時更是無形中浪費大量時間。

所以這個示範更強調「求同存異」:把共通模組抽出來,用私有 Pods 管理。日誌、網路請求、網路狀態提示這類常見能力,只要開放幾個簡單的開關配置,就能在新專案裡直接啟用。

模組化解法:頁面互動解耦

呼叫方式如下:

NSDictionary *curParams = @{kDesignerModuleActionsDictionaryKeyName  : @"wujunyang",
                            kDesignerModuleActionsDictionaryKeyID   : @"1001",
                            kDesignerModuleActionsDictionaryKeyImage: @"designerImage"};

switch (indexPath.row) {
    case 0: {
        UIViewController *viewController =
            [[JiaMediator sharedInstance] JiaMediator_Designer_viewControllerForDetail:curParams];
        [self presentViewController:viewController animated:YES completion:nil];
        break;
    }
    case 1: {
        UIViewController *viewController =
            [[JiaMediator sharedInstance] JiaMediator_Designer_viewControllerForDetail:curParams];
        [self.navigationController pushViewController:viewController animated:YES];
        break;
    }
    case 2: {
        NSString *curRoue = @"jiaScheme://Designer/nativeFetchDetailViewController?name=wujunyang&ID=1001&image=designerImage";
        UIViewController *viewController =
            [[JiaMediator sharedInstance] performActionWithUrl:[NSURL URLWithString:curRoue]
                                                    completion:^(NSDictionary *info) {
        }];
        [self.navigationController pushViewController:viewController animated:YES];
        break;
    }
    default:
        break;
}

上面示範了本地模組呼叫與路由式呼叫兩種跳轉。幾個設計要點:

1. JiaMediator 是唯一的樞紐。所有模組間互動都經過它。每個模組以 Category 的方式對它擴充(例如 JiaMediator+模組A),主要用在不想走路由的本地呼叫;若要走路由,就得把 URL 的約定寫準確,因為它直接決定能否命中目標。

2. JiaMediator 屬於公共層。每個模組都要用它,所以放進 BaseModule;而各模組對它的擴充則由模組自己負責,只把對外要用的介面開放出來。

3. 傳參一律用字典。專案中所有頁面都繼承自 JiaBaseViewController,初始化解耦在基底類裡完成,子頁面只要讀 parameterDictionary 屬性就能取用參數。JiaBaseViewController 同樣被抽進公共層,順帶封裝了導覽列與網路狀態提示。

// 頁面接收參數
@property (nonatomic, strong) NSDictionary *parameterDictionary;

// 初始化參數
- (id)initWithRouterParams:(NSDictionary *)params {
    self = [super init];
    if (self) {
        _parameterDictionary = params;
        NSLog(@"當前參數:%@", params);
    }
    return self;
}

4. 中介者只回傳 viewController。拿到之後要 push 還是 present,由呼叫方自行決定,中介者不管呈現方式。

5. 用常量檔收斂 key。為了避免字典 key 打錯字,每個模組都有一份對應的常量配置檔。

#ifndef HeaderDesignerConfig_h
#define HeaderDesignerConfig_h

// 鍵值
static NSString * const kDesignerModuleActionsDictionaryKeyName  = @"name";
static NSString * const kDesignerModuleActionsDictionaryKeyID   = @"ID";
static NSString * const kDesignerModuleActionsDictionaryKeyImage = @"image";

#endif /* HeaderDesignerConfig_h */

JiaCore:基礎能力封裝

JiaCore 是整个 App 最底層的模組,所有模組化都依賴它,裡面放的是全域能力,例如 JiaBaseViewController、JiaAppDelegate,目前已整合網路狀態判斷與提示、日誌記錄等功能,並透過 JiaCoreConfigManager 統一開放設定給具體 App。

// JiaCore 基礎模組相關配置
JiaCoreConfigManager *jiaCoreConfig = [JiaCoreConfigManager sharedInstance];
jiaCoreConfig.recordlogger = YES;

接著在 App 的 PrefixHeader.pch 引入命名空間並設定日誌等級:

#import "JiaCocoaLumberjack.h"

// DDLog 等級
static const int ddLogLevel = DDLogLevelVerbose;

這樣就完成了日誌模組的接入。JiaCore 已經把相關配置都處理好,並以可讀性較佳的格式記錄到檔案,檔案的產生規則也都預先定義。若想在 Xcode 主控台看到不同等級的顏色,只要裝上 XcodeColors 外掛並稍作設定即可,配色已在 JiaCore 中完成。

JiaCore 也預設整合了熱更新能力,只要傳入模型陣列就會啟動。其中 JiaPathchModel 已定義好欄位:patchId 是唯一名稱、md5 是 JS 檔的雜湊值、url 是下載路徑、ver 表示作用的 App 版本。由於對外的 App 通常多版本並存,熱更新必須區分版本,只下載與當前版本對應的 JS;而 md5 則是為了安全,避免 JS 被竄改影響 App 運行——JiaCore 會對下載後的檔案重新計算雜湊並比對,未在 jSPatchMutableArray 中的舊 JS 檔會被刪除。

JiaPathchModel *sample = [[JiaPathchModel alloc] init];
sample.patchId = @"patchId_sample1";
sample.md5     = @"2cf1c6f6c5632dc21224bf42c698706b";
sample.url     = @"https://test.qshmall.net:9090/demo1.js";
sample.ver     = @"1";

JiaPathchModel *sample1 = [[JiaPathchModel alloc] init];
sample1.patchId = @"patchId_sample2";
sample1.md5     = @"e8a4eaeadce5a4598fb9a868e09c75fd";
sample1.url     = @"https://test.qshmall.net:9090/demo2.js";
sample1.ver     = @"1";

// JiaCore 基礎模組相關配置
JiaCoreConfigManager *jiaCoreConfig = [JiaCoreConfigManager sharedInstance];
jiaCoreConfig.jSPatchMutableArray = [@[sample, sample1] mutableCopy];

JiaNetWork:網路層封裝

網路請求以 YTKNetwork 為骨架,底層仍是 AFNetworking 負責通信。實作一個繼承自 YTKBaseRequest 的 JiaBaseRequest,刻意留出 Category 擴充空間,讓各 App 能自行調整逾時、請求標頭等差異化設定——這些每個 App 都不一樣。而模組內的請求前綴,則由模組自己的單例配置類決定,同樣開放給具體 App 定義。別忘了把這個 Category 引入 App 的全域標頭檔。

#import "JiaBaseRequest+App.h"

@implementation JiaBaseRequest (App)

- (NSTimeInterval)requestTimeoutInterval {
    return 15;
}

// 公共標頭設定
- (NSDictionary *)requestHeaderFieldValueDictionary {
    return @{@"platform" : @"ios"};
}

@end

整體網路層結構如下:

JiaGT:個推封裝

推播對 App 的重要性不言而喻,實務上多半直接整合第三方 SDK。這類 SDK 的接入程式碼其實大同小異,因此這個示範只抽出差異化的部分。以個推為例:推播相關程式碼通常全塞在 AppDelegate 裡,造成一大團混亂。有些人會用 Category 把 AppDelegate 拆乾淨,這裡則採用另一種思路,達到完全解耦——具體 App 中不會再出現個推 SDK 的任何痕跡,只要設定與接收訊息即可。

// 設定個推模組的配置
jiaGTConfigManager *gtConfig = [jiaGTConfigManager sharedInstance];
gtConfig.jiaGTAppId     = @"0uuwznWonIANoK07JeRWgAs";
gtConfig.jiaGTAppKey    = @"26LeO4stbrA7TeyMUJdXlx3";
gtConfig.jiaGTAppSecret = @"2282vl0IwZd9KL3ZpDyoUL7";

#pragma mark 消息推送相關處理

/// 處理個推訊息
- (void)gtNotification:(NSDictionary *)NotificationMessage {
    NSLog(@"%@", NotificationMessage[@"payload"]);
    NSLog(@"收到個推通知");
}

/// 處理遠程 Apple 通知
- (void)receiveRemoteNotification:(NSDictionary *)RemoteNotificationMessage {
    NSLog(@"%@", RemoteNotificationMessage[@"message"]);
    NSLog(@"收到 Apple 通知");
}

/// 取得註冊成功後的 deviceToken,可在此做綁定
- (void)receiveDeviceToken:(NSString *)deviceToken {
    NSLog(@"當前 deviceToken:%@", deviceToken);
}

能把個推做到完全解耦,得歸功於第三方外掛 XAspect(可在 GitHub 搜尋)。它的作用如下圖,同樣的手法可以用來抽離其他第三方 SDK。

JiaAnalytics:友盟統計封裝

這個模組把友盟統計 SDK 與 AOP 切面結合:頁面的進入與離開統計改用切面方式處理,原本散落在各頁面生命週期裡的統計程式碼全部移除。App 只要設定友盟的相關資訊即可,還能自訂要統計的頁面過濾條件——目前提供三種:要統計的頁面前綴字串陣列、要統計的頁面名稱陣列、不統計的頁面名稱陣列,可混用,達到精準統計的目的。此外統計動線放在非同步執行緒,不會拖慢主執行緒的回應。

JiaShare:分享與第三方登入封裝

這個模組基於最新版友盟分享 SDK 封裝,並移除較不常用的部分,目前支援新浪微博、微信聊天、微信朋友圈、QQ、QQ 空間與騰訊微博;內容型別涵蓋純文字、圖文、URL、影片與音樂連結。模組內已用 JavaScriptCore.framework 封裝好 H5 頁面呼叫分享並傳參的能力,可直接在 UIWebView 中使用。

注意:友盟在 info.plist 的設定仍需手動完成,不清楚可直接查友盟官網,專案裡也附了一份可直接參考。另外 JiaPlatformHelper 類別提供「判斷手機是否安裝該平台 App」的方法,可用來隱藏對應功能,避免送審時被退。以下設定寫在 AppDelegate 中:

// 友盟分享
JiaShareConfigManager *jiaShareConfig = [JiaShareConfigManager sharedInstance];
jiaShareConfig.shareAppKey    = @"57e3f1cbe0f55a42080011ec";
jiaShareConfig.shareLogEnabled = YES;

// 設定平台
[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Tencent
                     appKey:@"100424468"
                  appSecret:@"c7394704798a158208a74ab60104f0ba"
                redirectURL:@"https://www.umeng.com/social"];

[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Wechat
                     appKey:@"wxdc1e388c3822c80b"
                  appSecret:@"3baf1193c85774b3fd9d18447d76cab0"
                redirectURL:@"https://www.umeng.com/social"];

[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Sina
                     appKey:@"3921700954"
                  appSecret:@"04b48b094faeb16683c32669824ebdad"
                redirectURL:@"https://sns.whalecloud.com/sina2/callback"];

接著就能分享,在 ViewController 中呼叫即可。JiaSocialPlatformType 是平台列舉,shareUrlDataWithPlatform: 為 URL 分享方式,其他型別可直接參考 JiaShareHelper 類別:

[JiaShareHelper shareUrlDataWithPlatform:JiaSocialPlatformType_WechatSession
                           withShareUrl:@"https://www.sina.com.cn"
                              withTitle:@"新浪"
                             withDescr:@"新浪網頁"
                          withThumImage:@"https://dev.umeng.com/images/tab2_1.png"
                        withCompletion:^(id result, NSError *error) {
    if (error) {
        NSLog(@"分享失敗");
    }
}];

若頁面載入了 H5 且也需要分享,可以用 JiaWebShareHelper。因為底層是 JavaScriptCore,只能用在 UIWebView;若使用 WKWebView 則需自行再封裝一層。以下是 webViewDidFinishLoad 中的接入方式:

- (void)webViewDidFinishLoad:(UIWebView *)webView {
    self.jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

    // 以模型物件註冊,比直接綁函式更好維護
    JiaWebShareHelper *shareHelper = [[JiaWebShareHelper alloc] init];
    self.jsContext[@"jia"] = shareHelper;
    shareHelper.jsContext  = self.jsContext;
    shareHelper.webView    = webView;

    self.jsContext.exceptionHandler = ^(JSContext *context, JSValue *exceptionValue) {
        context.exception = exceptionValue;
        NSLog(@"異常資訊:%@", exceptionValue);
    };
}

H5 端就能直接呼叫:

最後簡單介紹第三方登入與取得使用者資料。相關程式碼都在 JiaPlatformHelper 裡,授權成功與取得資料都有對應回呼:

if (![JiaPlatformHelper installPlatAppWithType:JiaSocialPlatformType_QQ]) {
    [weakSelf showResult:@"未安裝 QQ,隱藏此功能"];
    return;
}

[JiaPlatformHelper authWithPlatform:JiaSocialPlatformType_QQ
                     withCompletion:^(NSString *uid, NSString *openid, NSString *accessToken, NSError *error) {
    if (error) {
        NSLog(@"授權失敗");
        return;
    }
    NSString *result = [NSString stringWithFormat:@"uid:%@ -- token:%@ -- openid:%@", uid, accessToken, openid];
    [weakSelf showResult:result];
}];

取得使用者資料:

[JiaPlatformHelper getUserInfoWithPlatform:JiaSocialPlatformType_QQ
                           withCompletion:^(NSString *name, NSString *iconUrl, NSString *gender, NSError *error) {
    if (error) {
        NSLog(@"取得失敗");
        return;
    }
    NSString *result = [NSString stringWithFormat:@"name:%@ -- 性別:%@", name, gender];
    [weakSelf showResult:result];
}];

取消授權也有對應方法:

[JiaPlatformHelper cancelAuthWithPlatform:JiaSocialPlatformType_QQ
                           withCompletion:^(id result, NSError *error) {
    if (error) {
        NSLog(@"取消失敗");
        return;
    }
    [weakSelf showResult:@"取消成功"];
}];

落地:結合私有 Pods

上面的示範把模組都放在同一個工程裡呈現,最終仍要落實到 Pods 管理:每個模組獨立維護,不同 App 只要幾行 Podfile 就能引用;共通模組還能跨 App 重複使用,降低重複開發成本。

本專案已用 Pod 管理目前開發的幾個模組,並把 spec 收在自己 GitHub 的 WjySpecs 庫統一管理。首先建立 jiaModule.podspec:

Pod::Spec.new do |s|
  s.name     = "jiaModule"
  s.version  = "0.0.6"
  s.summary  = "iOS 模組化功能的引用"
  s.homepage = "https://github.com/wujunyang/jiaModuleDemo"
  s.license  = { :type => "MIT", :file => "FILE_LICENSE" }
  s.author   = { "wujunyang" => "wujunyang@126.com" }
  s.platform = :ios, "7.0"
  s.source   = { :git => "https://github.com/wujunyang/jiaModuleDemo.git", :tag => "0.0.6" }
  s.requires_arc = true

  s.subspec 'JiaCore' do |jiaCore|
    jiaCore.source_files = 'jiaModuleDemo/BaseModule/JiaCore/**/*.{h,m}'
    jiaCore.dependency 'XAspect'
    jiaCore.dependency 'YYCache'
    jiaCore.dependency 'JSPatch'
    jiaCore.dependency 'RealReachability'
    jiaCore.dependency 'FLEX', '~> 2.0'
    jiaCore.dependency 'CocoaLumberjack', '~> 2.0.0-rc'
    jiaCore.dependency 'AFNetworking', '~> 2.6.0'
  end

  s.subspec 'JiaGT' do |jiaGT|
    jiaGT.source_files = 'jiaModuleDemo/BaseModule/JiaGT/**/*'
    jiaGT.dependency 'jiaModule/JiaCore'
    jiaGT.dependency 'XAspect'
    jiaGT.dependency 'GTSDK', '~> 1.5.0'
  end

  s.subspec 'JiaAnalytics' do |jiaAnalytics|
    jiaAnalytics.source_files = 'jiaModuleDemo/BaseModule/JiaAnalytics/**/*'
    jiaAnalytics.dependency 'jiaModule/JiaCore'
    jiaAnalytics.dependency 'XAspect'
    jiaAnalytics.dependency 'Aspects'
    jiaAnalytics.dependency 'UMengAnalytics-NO-IDFA', '~> 4.1.1'
  end

  s.frameworks = 'UIKit'
end

透過 subspec 切分,各模組既能一起引入,也能單獨引入。全部引入:

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/wujunyang/WjySpecs.git'
platform :ios, "7.0"

pod 'jiaModule'

只引入其中幾個模組:

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/wujunyang/WjySpecs.git'
platform :ios, "7.0"

pod 'jiaModule/JiaCore'
pod 'jiaModule/JiaGT'

最後是驗證與推送 podspec 的兩條指令,都要先進入 podspec 所在的根目錄:

# 驗證是否正確
pod lib lint jiaModule.podspec --allow-warnings --use-libraries --sources=

# 推送到私有庫(specs 為私有庫名稱)
pod repo push specs jiaModule.podspec --allow-warnings --use-libraries \
  --sources=https://github.com/CocoaPods/Specs.git,https://github.com/wujunyang/WjySpecs.git

如果推送時出現:

[!] Unable to find the `specs` repo. If it has not yet been cloned, add it via `pod repo add`.

代表私有庫還沒被 clone 到本地,執行:

pod repo add specs https://github.com/wujunyang/WjySpecs.git

接著在 ~/.cocoapods/repos 底下(隱藏目錄,需用指令顯示)就會看到 specs 資料夾,以及 CocoaPods 官方的那一個。最後輸入 GitHub 帳號密碼,就能成功推送:

Username for 'https://github.com': wujunyang@126.com
Password for 'https://wujunyang@126.com@github.com':
To https://github.com/wujunyang/WjySpecs.git
   80ca876..d4f7446  master -> master
  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved