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; - (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: 調用以後添加觀察者;不然可能會引發崩潰.