
單例模式在 Cocoa 中被大量使用。寫 App 時,我們習慣把工具類、各類管理器設計成單例——通過一個類方法返回全進程唯一的實例,而不是像普通對象那樣反覆 alloc/init。
這給測試帶來了麻煩。如果我們想 stub 某個單例的實例方法,那麼它的初始化入口(例如 sharedManage())就必須返回一個 mock 對象,因為只有 mock 對象才能做 stub。問題是:怎麼讓這個替換在全局生效?下面用一個例子逐步拆解。
先看一個簡單的單例類 DemoStatusManage,它提供一個實例方法 currentStatus,返回 1 到 100 之間的隨機數:
@interface DemoStatusManage : NSObject
+ (instancetype)sharedManage;
- (int)currentStatus;
@end
@implementation DemoStatusManage {
NSInteger _status;
}
+ (instancetype)sharedManage {
static dispatch_once_t once;
static DemoStatusManage *manage;
dispatch_once(&once, ^{
manage = [[DemoStatusManage alloc] init];
});
return manage;
}
- (instancetype)init {
self = [super init];
if (self) {
_status = 0;
}
return self;
}
- (int)currentStatus {
return [self getRandomNumber:1 to:100];
}
- (int)getRandomNumber:(int)from to:(int)to {
return (int)(from + (arc4random() % (to - from + 1)));
}
@end
另一個類調用這個單例,把狀態值渲染到 label 上:
- (void)updateStatusNumber {
self.statusLabel.text = [NSString stringWithFormat:@"%ld",
(long)[[DemoStatusManage sharedManage] currentStatus]];
}
場景很簡單,但測試 updateStatusNumber 時就卡住了:它依賴外部的 currentStatus,而後者返回隨機值,無法構造確定性的斷言。我們必須把單例 mock 掉,再 stub currentStatus 返回一個約定的固定值。
OCMStrictClassMock(cls)?OCMClassMock(cls)?還是 OCMPartialMock(obj)?
遺憾的是,按常規方式 mock 這三種都用不上。原因很直白:我們 mock 出來的對象或類只活在測試用例的視野裡,而 updateStatusNumber 內部調用的永遠是 DemoStatusManage 的原生類。
那怎樣才能讓 sharedManage 無論在測試用例還是被測方法中都返回同一個 mock 對象?答案是用 category 重寫 sharedManage:
@interface DemoStatusManage (UnitTest)
@end
static DemoStatusManage *mock = nil;
@implementation DemoStatusManage (UnitTest)
+ (instancetype)sharedManage {
if (mock)
return mock;
static dispatch_once_t once;
static DemoStatusManage *manage;
dispatch_once(&once, ^{
manage = [[DemoStatusManage alloc] init];
});
return manage;
}
@end
這樣一來,只要在測試用例裡給 mock 賦值,任何位置調用 sharedManage 都會拿到我們想要的替身:
mock = OCMClassMock([DemoStatusManage class]);
當然也可以换成 partial mock:
mock = OCMPartialMock([[DemoStatusManage alloc] init]);
先去掉複製粘貼的代碼
仔細看會發現,上面那段 dispatch_once 是從原類裡抄過來的:
static dispatch_once_t once;
static DemoStatusManage *manage;
dispatch_once(&once, ^{
manage = [[DemoStatusManage alloc] init];
});
return manage;
這意味著我們維護著兩份相同邏輯。哪天 App 工程裡的 sharedManage 改了實現,這裡也得跟著改,遲早會不一致。
有沒有辦法直接找到原來的 IMP 實現?Matt 在他的文章裡給出了肯定答案:Supersequent implementation。借助他提供的 invokeSupersequentNoArgs() 宏,category 可以瘦身成這樣:
@interface DemoStatusManage (UnitTest)
@end
static DemoStatusManage *mock = nil;
@implementation DemoStatusManage (UnitTest)
+ (instancetype)sharedManage {
if (mock)
return mock;
return invokeSupersequentNoArgs()
}
@end
再把 mock 的創建與釋放封裝起來
實踐中我發現一個詭異現象:即使某個 BTest.m 既沒有寫 category 也沒有引用寫了 category 的 ATest.m,它執行時仍然會進入被重寫的 sharedManage。由於 mock 是 static 變量且從未釋放,DemoStatusManage 就永遠是一個 mock 對象了。具體成因不明,猜測與 XCTest 框架有關(所有 XCTestCase 都沒有 .h 文件)。
應對辦法很明確:用完必須釋放,並把創建與釋放都收斂成接口供用例調用,順便支持多種 mock 形態:
@interface DemoStatusManage (UnitTest)
+ (instancetype)JTKCreateClassMock;
+ (instancetype)JTKCreatePartialMock:(DemoStatusManage *)obj;
+ (void)JTKReleaseMock;
@end
static DemoStatusManage *mock = nil;
@implementation DemoStatusManage (UnitTest)
+ (instancetype)sharedManage {
if (mock)
return mock;
return invokeSupersequentNoArgs();
}
+ (instancetype)JTKCreateClassMock {
mock = OCMClassMock([DemoStatusManage class]);
return mock;
}
+ (instancetype)JTKCreatePartialMock:(DemoStatusManage *)obj {
mock = OCMPartialMock(obj);
return mock;
}
+ (void)JTKReleaseMock {
mock = nil;
}
@end
此後,用例裡按需調用 JTKCreateClassMock 或 JTKCreatePartialMock: 生成替身,結束後調用 JTKReleaseMock 釋放,測試需求就完整滿足了。
一個真實工程裡的單例不會只有一個,少則十幾個,多則上百。若每個都手寫一遍 category,成本實在太高。而所有單例的 UnitTest category 結構幾乎一模一樣,用宏生成是最自然的選擇:
#define JTKMOCK_SINGLETON(__className, __sharedMethod) \
JTKMOCK_SINGLETON_CATEGORY_DECLARE(__className) \
JTKMOCK_SINGLETON_CATEGORY_IMPLEMENT(__className, __sharedMethod)
#define JTKMOCK_SINGLETON_CATEGORY_DECLARE(__className) \
@interface __className (UnitTest) \
+ (instancetype)JTKCreateClassMock; \
+ (instancetype)JTKCreatePartialMock:(__className *)obj;\
+ (void)JTKReleaseMock; \
@end
#define JTKMOCK_SINGLETON_CATEGORY_IMPLEMENT(__className, __sharedMethod) \
static __className *mock_singleton_##__className = nil; \
@implementation __className (UnitTest) \
+ (instancetype)__sharedMethod { \
if (mock_singleton_##__className) \
return mock_singleton_##__className; \
return JTKInvokeSupersequentNoParameters(); \
} \
+ (instancetype)JTKCreateClassMock { \
mock_singleton_##__className = OCMClassMock([__className class]); \
return mock_singleton_##__className; \
} \
+ (instancetype)JTKCreatePartialMock:(__className *)obj { \
mock_singleton_##__className = OCMPartialMock(obj); \
return mock_singleton_##__className; \
} \
+ (void)JTKReleaseMock { \
mock_singleton_##__className = nil; \
} \
@end
之後一個單例一行搞定,來一個寫一行,來一雙寫兩行:
JTKMOCK_SINGLETON(DemoStatusManage, sharedManage)
Matt 文中的代碼可以在 GitHub 上找到:NSObject+SupersequentImplementation。
如果調用 invokeSupersequentNoArgs() 時報 Too many arguments to function call, expected 0, have 2,請打開測試 target 的 Build Settings,把 Enable Strict Checking of objc_msgSend Calls 設為 NO。
用 category 重寫主類方法會產生警告 Category is implementing a method which will also be implemented by its primary class,用下面的 pragma 包住宏調用即可屏蔽:
#pragma clang diagnostic push #pragma clang diagnostic ignored "-Wobjc-protocol-method-implementation" JTKMOCK_SINGLETON(DemoStatusManage, sharedManage) #pragma clang diagnostic pop