Aspects– iOS的AOP面向切面編程的庫

標籤：

簡介

一個簡潔高效的用於使iOS支援AOP面向切面編程的庫.它可以協助你在不改變一個類或類執行個體的代碼的前提下,有效更改類的行為.比iOS傳統的 AOP方法,更加簡單高效.支援在方法執行的前/後或替代原方法執行.曾經是 PSPDFKit 的一部分,PSPDFKit,在Dropbox和Evernote中都有應用,現在單獨單獨開源出來給大家使用.

項目首頁: Aspects

最新執行個體:點擊下載

注: AOP是一種完全不同於OOP的設計模式.更多資訊,可以參考這裡: AOP 百度百科

快速入門環境要求

• ARC
• iOS 7 + 或 OS X 10.7 +

安裝使用 CocoaPods 安裝

pod "Aspects"

手動安裝

把檔案 Aspects.h/m 拖到工程中即可.

用法應用情境

Aspects 用於支援AOP(面向切面編程)模式,用於部分解決OOP(物件導向)模式無法解決的特定問題.具體指的是那些在多個方法有交叉,無法或很難被有效歸類的操作,比如:

• 不論何時使用者通過用戶端擷取伺服器端資料,許可權檢查總是必須的.
• 不論何時使用者和市場互動,總應該更具使用者的操作提供相應地購買參考或相關商品.
• 所有需要日誌記錄的操作.

介面概述

Aspects 給 NSObject 擴充了下面的方法:

/// 為一個指定的類的某個方法執行前/替換/後,添加一段代碼塊.對這個類的所有對象都會起作用.////// @param block  方法被添加鉤子時,Aspectes會拷貝方法的簽名資訊./// 第一個參數將會是 `id<AspectInfo>`,餘下的參數是此被調用的方法的參數./// 這些參數是可選的,並將被用於傳遞給block代碼塊對應位置的參數./// 你甚至使用一個沒有任何參數或只有一個`id<AspectInfo>`參數的block代碼塊.////// @注意 不支援給靜態方法添加鉤子./// @return 返回一個唯一值,用於取消此鉤子.+ (id<AspectToken>)aspect_hookSelector:(SEL)selector                      withOptions:(AspectOptions)options                       usingBlock:(id)block                            error:(NSError **)error;/// 為一個指定的對象的某個方法執行前/替換/後,添加一段代碼塊.只作用於當前對象. - (id<AspectToken>)aspect_hookSelector:(SEL)selector withOptions:(AspectOptions)options usingBlock:(id)block error:(NSError **)error; /// 撤銷一個Aspect 鉤子./// @return YES 撤銷成功, 否則返回 NO. id<AspectToken> aspect = ...; [aspect remove];

 

所有的調用,都會是安全執行緒的.Aspects 使用了Objective-C 的訊息轉寄機會,會有一定的效能消耗.所有對於過於頻繁的調用,不建議使用 Aspects.Aspects更適用於視圖/控制器相關的等每秒調用不超過1000次的代碼.

程式碼範例

可以在調試應用時,使用Aspects動態添加日誌記錄功能.

[UIViewController aspect_hookSelector:@selector(viewWillAppear:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo, BOOL animated) {    NSLog(@"控制器 %@ 將要顯示: %tu", aspectInfo.instance, animated);} error:NULL];

 

使用它,分析功能的設定會很簡單:

https://github.com/orta/ARAnalytics

你可以在你的測試案例中用它來檢查某個方法是否被真正調用(當涉及到繼承或類目擴充時,很容易發生某個父類/子類方法未按預期調用的情況):

- (void)testExample {    TestClass *testClass = [TestClass new];    TestClass *testClass2 = [TestClass new];    __block BOOL testCallCalled = NO;    [testClass aspect_hookSelector:@selector(testCall) withOptions:AspectPositionAfter usingBlock:^{        testCallCalled = YES;    } error:NULL];    [testClass2 testCallAndExecuteBlock:^{        [testClass testCall];    } error:NULL];    XCTAssertTrue(testCallCalled, @"調用testCallAndExecuteBlock 必須調用 testCall");}

 

它對調試應用真的會提供很大的作用.這裡我想要知道究竟何時輕擊手勢的狀態發生變化(如果是某個你自訂的手勢的子類,你可以重寫setState:方法來達到類似的效果;但這裡的真正目的是,捕捉所有的各類控制項的輕擊手勢,以準確分析原因):

[_singleTapGesture aspect_hookSelector:@selector(setState:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) {    NSLog(@"%@: %@", aspectInfo.instance, aspectInfo.arguments);} error:NULL];

 

下面是一個你監測一個模態顯示的控制器何時消失的樣本.通常,你也可以寫一個子類,來實現相似的效果,但使用 Aspects 可以有效減小你的代碼量:

@implementation UIViewController (DismissActionHook)// Will add a dismiss action once the controller gets dismissed.- (void)pspdf_addWillDismissAction:(void (^)(void))action {    PSPDFAssert(action != NULL);    [self aspect_hookSelector:@selector(viewWillDisappear:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) {        if ([aspectInfo.instance isBeingDismissed]) {            action();        }    } error:NULL];}@end

 

對調試的好處

Aspectes 會自動標籤自己,所有很容易在調用棧中查看某個方法是否已經調用:

在傳回值不為void的方法上使用 Aspects

你可以使用 NSInvocation 對象類自訂傳回值:

    [PSPDFDrawView aspect_hookSelector:@selector(shouldProcessTouches:withEvent:) withOptions:AspectPositionInstead usingBlock:^(id<AspectInfo> info, NSSet *touches, UIEvent *event) {        // 調用方法原來的實現.        BOOL processTouches;        NSInvocation *invocation = info.originalInvocation;        [invocation invoke];        [invocation getReturnValue:&processTouches];        if (processTouches) {            processTouches = pspdf_stylusShouldProcessTouches(touches, event);            [invocation setReturnValue:&processTouches];        }    } error:NULL];

 

相容性與限制

• 當應用於某個類時(使用類方法添加鉤子),不能同時hook父類和子類的同一個方法;否則會引起迴圈調用問題.但是,當應用於某個類的樣本時(使用執行個體方法添加鉤子),不受此限制.
• 使用KVO時,最好在 aspect_hookSelector: 調用之後添加觀察者;否則可能會引起崩潰.

Aspects– iOS的AOP面向切面編程的庫