Aspects源碼淺析

思維導(dǎo)圖

同步發(fā)布到博客地址Aspects源碼淺析

Aspects 可以很方便的讓我們 hook 要執(zhí)行的方法魂仍，可以很方便的在方法執(zhí)行前鸽斟，執(zhí)行后來執(zhí)行我們的操作至壤，也可以替換原方法的實(shí)現(xiàn)减噪。

Delightful, simple library for aspect oriented programming in Objective-C and Swift.

實(shí)現(xiàn)原理簡(jiǎn)單的說就是厦凤，通過動(dòng)態(tài)創(chuàng)建子類鼻吮、動(dòng)態(tài)修改子類方法的實(shí)現(xiàn)，將原類的類型指向子類较鼓，從而將原來的方法的實(shí)現(xiàn)指向了子類的方法實(shí)現(xiàn)狈网，可以方便的觀察方法的執(zhí)行情況。跟系統(tǒng)實(shí)現(xiàn) KVO 的原理一樣。

比如 hook A 類的 xxx 方法拓哺，實(shí)現(xiàn)原理大致就是：

1. 動(dòng)態(tài)創(chuàng)建類 A 的子類 B (A__Aspects_)
2. B 動(dòng)態(tài)添加方法 aspects_xxx 方法勇垛，aspects_xxx 的實(shí)現(xiàn)指向原來的 xxx 方法
3. B 替換 forwardInvocation: 實(shí)現(xiàn)為 __ASPECTS_ARE_BEING_CALLED__。
4. B 替換 原有的 xxx 實(shí)現(xiàn)為 _objc_msgForward
5. 將 A 的類型設(shè)置為 B 士鸥。
6. 當(dāng)調(diào)用 xxx 時(shí)闲孤，這個(gè)時(shí)候回 A 的類型已經(jīng)被設(shè)置為 B ，會(huì)向 B 的方法列表里面查找 xxx 的實(shí)現(xiàn)烤礁。這個(gè)時(shí)候 xxx 在 B 中已經(jīng)被替換為 _objc_msgForward讼积，進(jìn)入消息轉(zhuǎn)發(fā)流程，forwardInvocation:脚仔，forwardInvocation:的實(shí)現(xiàn)被替換為__ASPECTS_ARE_BEING_CALLED__勤众。最終會(huì)進(jìn)入 __ASPECTS_ARE_BEING_CALLED__ 來處理。

關(guān)于消息轉(zhuǎn)發(fā)的流程我這邊在這里有一個(gè)簡(jiǎn)單的總結(jié)：Objective-C 中的消息與消息轉(zhuǎn)發(fā)

簡(jiǎn)單使用

Aspects 的 API 封裝的非常簡(jiǎn)潔鲤脏，對(duì)外暴露了兩個(gè)方法们颜。

+ (id<AspectToken>)aspect_hookSelector:(SEL)selector
                           withOptions:(AspectOptions)options
                            usingBlock:(id)block
                                 error:(NSError **)error;

/// Adds a block of code before/instead/after the current `selector` for a specific instance.
- (id<AspectToken>)aspect_hookSelector:(SEL)selector
                           withOptions:(AspectOptions)options
                            usingBlock:(id)block
                                 error:(NSError **)error;

分別 hook 實(shí)例方法和類方法。
使用起來非常簡(jiǎn)單

 [testController aspect_hookSelector:@selector(viewWillDisappear:) withOptions:0 usingBlock:^(id<AspectInfo> info, BOOL animated) {
        UIViewController *controller = [info instance];
        if (controller.isBeingDismissed || controller.isMovingFromParentViewController) {
            [[[UIAlertView alloc] initWithTitle:@"Popped" message:@"Hello from Aspects" delegate:nil cancelButtonTitle:nil otherButtonTitles:@"Ok", nil] show];
        }
    } error:NULL];

源碼分析

Aspects hook 方法最終都會(huì)進(jìn)入一個(gè)叫做 aspect_add 的方法猎醇。
aspect_add 大體做的事情有三件窥突。

1. aspect_performLocked 加鎖保證線程安全。
2. aspect_isSelectorAllowedAndTrack 判斷是否允許 hook
3. aspect_prepareClassAndHookSelector 動(dòng)態(tài)創(chuàng)建原有類的子類和替換原有方法實(shí)現(xiàn)來達(dá)到 hook 的目的硫嘶。

aspect_performLocked 就略去不談阻问，我們主要分析下下面兩個(gè)方法的實(shí)現(xiàn)。

aspect_isSelectorAllowedAndTrack

1. 判斷 hook 的方法是否為系統(tǒng)方法沦疾。

   static dispatch_once_t pred;
    dispatch_once(&pred, ^{
        disallowedSelectorList = [NSSet setWithObjects:@"retain", @"release", @"autorelease", @"forwardInvocation:", nil];
    });

    // Check against the blacklist.
    NSString *selectorName = NSStringFromSelector(selector);
    //判斷是否是上面的幾個(gè)方法称近，如果是，不跟蹤哮塞。retain刨秆、release 等
    if ([disallowedSelectorList containsObject:selectorName]) {
        NSString *errorDescription = [NSString stringWithFormat:@"Selector %@ is blacklisted.", selectorName];
        AspectError(AspectErrorSelectorBlacklisted, errorDescription);
        return NO;
    }

判斷是否是 @"retain", @"release", @"autorelease", @"forwardInvocation:" 方法，如果是這幾個(gè)方法彻桃，返回 NO 坛善，不進(jìn)行 hook。

2. 判斷 hook 類型邻眷。

通過位運(yùn)算快速計(jì)算出 hook 類型眠屎。

    AspectOptions position = options&AspectPositionFilter;

#define AspectPositionFilter 0x07

typedef NS_OPTIONS(NSUInteger, AspectOptions) {
    AspectPositionAfter   = 0,            /// Called after the original implementation (default)
    AspectPositionInstead = 1,            /// Will replace the original implementation.
    AspectPositionBefore  = 2,            /// Called before the original implementation.
    
    AspectOptionAutomaticRemoval = 1 << 3 /// Will remove the hook after the first execution.
};

     AspectPositionFilter == 0x07 轉(zhuǎn)為為二進(jìn)制位 0000 0000 0000 0111
     AspectOptions 選項(xiàng)值分別為 0、1肆饶、2改衩、8，
     AspectOptionAutomaticRemoval = 1 << 3  就是1 的二進(jìn)制左移3位 變成 8

     這樣可以快速的計(jì)算出當(dāng)前選項(xiàng)值驯镊。
     
     轉(zhuǎn)為二進(jìn)制
     AspectPositionAfter            0000 0000 0000 0000
     AspectPositionInstead          0000 0000 0000 0001
     AspectPositionBefore           0000 0000 0000 0010
     AspectOptionAutomaticRemoval   0000 0000 0000 1000
     
    上面這個(gè)幾個(gè)值 分別于 AspectPositionFilter 進(jìn)行 & 位運(yùn)算后等到值
     
     AspectPositionAfter          &AspectPositionFilter         0000 0000 0000 0000
     AspectPositionInstead        &AspectPositionFilter         0000 0000 0000 0001
     AspectPositionBefore         &AspectPositionFilter         0000 0000 0000 0010
     AspectOptionAutomaticRemoval &AspectPositionFilter         0000 0000 0000 0000

     
     if (aspect.options & AspectOptionAutomaticRemoval) 可以計(jì)算出 這里是為了計(jì)算出那些是運(yùn)行后就移除的葫督。
     
     AspectPositionAfter          &AspectPositionFilter             0000 0000 0000 0000
     AspectPositionInstead        &AspectPositionFilter             0000 0000 0000 0000
     AspectPositionBefore         &AspectPositionFilter             0000 0000 0000 0000
     AspectOptionAutomaticRemoval &AspectOptionAutomaticRemoval     0000 0000 0000 1000
     

3. 如果要 hook dealloc 方法竭鞍。

如果要 hook dealloc 方法，只能在方法執(zhí)行前 hook橄镜。

   if ([selectorName isEqualToString:@"dealloc"] && position != AspectPositionBefore) {
        NSString *errorDesc = @"AspectPositionBefore is the only valid position when hooking dealloc.";
        AspectError(AspectErrorSelectorDeallocPosition, errorDesc);
        return NO;
    }

4. 判斷當(dāng)前類是否相應(yīng)要 hook 的方法

判斷當(dāng)前類是否相應(yīng)要 hook 的方法偎快，如果不響應(yīng)，返回 NO洽胶。

   if (![self respondsToSelector:selector] && ![self.class instancesRespondToSelector:selector]) {
        NSString *errorDesc = [NSString stringWithFormat:@"Unable to find selector -[%@ %@].", NSStringFromClass(self.class), selectorName];
        AspectError(AspectErrorDoesNotRespondToSelector, errorDesc);
        return NO;
    }

5. 判斷是否為類對(duì)象

如果不是類對(duì)象晒夹，就是實(shí)例對(duì)象，直接 返回 YES姊氓。

class_isMetaClass(object_getClass(self))

     class_isMetaClass 判斷是不是 MetaClass
     object_getClass 當(dāng)參數(shù)傳入的是一個(gè)實(shí)例對(duì)象的時(shí)候丐怯，返回類對(duì)象，當(dāng)參數(shù)傳入的是一個(gè)類對(duì)象的時(shí)候翔横，返回一個(gè)元類對(duì)象（MetaClass）
     class_isMetaClass
     Class cla1 = object_getClass([UIView new]);
     Class cla2 = object_getClass([UIView class]);
     
     NSLog(@" %@ %d",cla1,class_isMetaClass(cla1));//UIView 0
     NSLog(@" %@ %d",cla2,class_isMetaClass(cla2));//UIView 1
     
     class_isMetaClass(object_getClass(self) 就是判斷 self 是不是類對(duì)象读跷，如果是類對(duì)象進(jìn)入 分支，如果是實(shí)例對(duì)象禾唁，返回 YES

如果是類對(duì)象效览，進(jìn)入分支。

6.判斷子類是否已經(jīng) hook 改方法

從全局的字典里面取出當(dāng)前類相關(guān)聯(lián)的 AspectTracker蟀俊，判斷子類是否已經(jīng) hook 過改方法钦铺。

   if (class_isMetaClass(object_getClass(self))) {
        Class klass = [self class];
        //全局緩存的字典 key是class订雾；value是AspectTracker實(shí)例
        NSMutableDictionary *swizzledClassesDict = aspect_getSwizzledClassesDict();
        Class currentClass = [self class];

        AspectTracker *tracker = swizzledClassesDict[currentClass];
        //判斷子類是否已經(jīng) hook肢预，如果子類已經(jīng) hook ，提示子類已經(jīng) hook了洼哎，返回 NO
        if ([tracker subclassHasHookedSelectorName:selectorName]) {
            NSSet *subclassTracker = [tracker subclassTrackersHookingSelectorName:selectorName];
            NSSet *subclassNames = [subclassTracker valueForKey:@"trackedClassName"];
            NSString *errorDescription = [NSString stringWithFormat:@"Error: %@ already hooked subclasses: %@. A method can only be hooked once per class hierarchy.", selectorName, subclassNames];
            AspectError(AspectErrorSelectorAlreadyHookedInClassHierarchy, errorDescription);
            return NO;
        }

- (BOOL)subclassHasHookedSelectorName:(NSString *)selectorName {
    return self.selectorNamesToSubclassTrackers[selectorName] != nil;
}

7. 判斷父類是否已經(jīng) hook 改方法

do {
    //獲取 AspectTracker
    tracker = swizzledClassesDict[currentClass];
    //判斷 AspectTracker 已經(jīng) hook 的方法是否包含要 hook 的方法名
    if ([tracker.selectorNames containsObject:selectorName]) {
        //如果是當(dāng)前類烫映，返回 YES ，可以對(duì)當(dāng)前類再次進(jìn)行 hook噩峦。
        if (klass == currentClass) {
            // Already modified and topmost!
            return YES;
        }
        //不一致的話锭沟，返回 NO，報(bào)錯(cuò)已經(jīng) 在 父類 HOOK 過了识补，保證一個(gè)繼承鏈上只能 hook 一個(gè)類
        NSString *errorDescription = [NSString stringWithFormat:@"Error: %@ already hooked in %@. A method can only be hooked once per class hierarchy.", selectorName, NSStringFromClass(currentClass)];
        AspectError(AspectErrorSelectorAlreadyHookedInClassHierarchy, errorDescription);
        return NO;
    }
} while ((currentClass = class_getSuperclass(currentClass)));

判斷繼承鏈上向父類查找是否已經(jīng)有類 hook 這個(gè)方法了族淮。

 Class currentClass      = object_getClass([UITableViewCell class]);
 NSLog(@"currentClass == %@",currentClass);//UITableViewCell
 do {
    NSLog(@"class_getSuperclass == %@",currentClass);
    //UITableViewCell
    //UIView
    //UIResponder
    //NSObject
    //NSObject
 } while ((currentClass = class_getSuperclass(currentClass)));
            

當(dāng)已經(jīng)找到繼承鏈的頂端后，class_getSuperclass 獲取的數(shù)據(jù)為 null 凭涂，跳出循環(huán)祝辣。

8. 在當(dāng)前類的繼承鏈上標(biāo)識(shí) hook 關(guān)系。

如果當(dāng)前類的繼承鏈上都沒有 hook 過改方法切油，在當(dāng)前類的繼承鏈上標(biāo)識(shí) hook 關(guān)系蝙斜。

    do {
        //從全局緩存的字典中獲取 AspectTracker
        tracker = swizzledClassesDict[currentClass];
        //如果 AspectTracker 為空
        if (!tracker) {
            // 根據(jù) currentClass 生成 AspectTracker 實(shí)例，并緩存在全局的字典里
            tracker = [[AspectTracker alloc] initWithTrackedClass:currentClass];
            swizzledClassesDict[(id<NSCopying>)currentClass] = tracker;
        }
        if (subclassTracker) {
            //如果 subclassTracker 存在 tracker 的根據(jù) selectorName 存儲(chǔ)的 set 中澎胡，添加subclassTracker
            [tracker addSubclassTracker:subclassTracker hookingSelectorName:selectorName];
        } else {
            // 把 selectorName 放入已經(jīng) hook 的集合里面
            [tracker.selectorNames addObject:selectorName];
        }

        // All superclasses get marked as having a subclass that is modified.
        subclassTracker = tracker;
    }while ((currentClass = class_getSuperclass(currentClass)));

aspect_prepareClassAndHookSelector

aspect_prepareClassAndHookSelector 主要做了三件事情孕荠。

1. aspect_hookClass 動(dòng)態(tài)的創(chuàng)建 當(dāng)前類的子類娩鹉，并交換 forwardInvocation:、class 方法的實(shí)現(xiàn)
2. aspect_isMsgForwardIMP稚伍，判斷當(dāng)前調(diào)用的方法是否是 _objc_msgForward 的實(shí)現(xiàn)弯予，如果是，跳過个曙。
3. 態(tài)的替換原方法的實(shí)現(xiàn) class_addMethod熙涤。class_replaceMethod 動(dòng)。

1. aspect_hookClass

動(dòng)態(tài)的創(chuàng)建當(dāng)前類的子類,并返回創(chuàng)建的子類困檩，并交換 forwardInvocation祠挫、class 方法的實(shí)現(xiàn)。

1. 判斷是否已經(jīng)hook過

判斷當(dāng)前類是否已經(jīng)被 hook 過

if ([className hasSuffix:AspectsSubclassSuffix]) {

如果已經(jīng)hook 過悼沿，直接返回 object_getClass(self) 獲取的類型等舔，也就是動(dòng)態(tài)創(chuàng)建的子類。

2. 判斷是否是類對(duì)象

如果是類對(duì)象糟趾，aspect_swizzleForwardInvocation 替換 forwardInvocation 的實(shí)現(xiàn)為 __ASPECTS_ARE_BEING_CALLED__

3. 判斷當(dāng)前類名稱是否一致

如果是self.class和 object_getClass(self) 獲取的類型不一致慌植，有可能進(jìn)行了 KVO 操作，aspect_swizzleForwardInvocation 替換 forwardInvocation 的實(shí)現(xiàn)為 __ASPECTS_ARE_BEING_CALLED__

4. 動(dòng)態(tài)創(chuàng)建當(dāng)前類的子類

如果上面的判斷都不成立义郑，就是一個(gè)實(shí)例對(duì)象蝶柿，且沒有被KVO。動(dòng)態(tài)創(chuàng)建子類非驮，原有類后面拼接 AspectsSubclassSuffix 作為新的類名交汤，并且替換子類的 forwardInvocation: 、-(Class)class劫笙、+(Class)class方法芙扎。

    const char *subclassName = [className stringByAppendingString:AspectsSubclassSuffix].UTF8String;

const char *subclassName = [className stringByAppendingString:AspectsSubclassSuffix].UTF8String;
//創(chuàng)建 subclassName 的類，他的父類為 baseClass（原來的類）
subclass = objc_allocateClassPair(baseClass, subclassName, 0);
//如果創(chuàng)建失敗填大，報(bào)錯(cuò)戒洼。
if (subclass == nil) {
    NSString *errrorDesc = [NSString stringWithFormat:@"objc_allocateClassPair failed to allocate class %s.", subclassName];
    AspectError(AspectErrorFailedToAllocateClassPair, errrorDesc);
    return nil;
}

//交換子類的 ForwardInvocation 方法
aspect_swizzleForwardInvocation(subclass);
// 交換實(shí)例方法 class 方法的實(shí)現(xiàn)
aspect_hookedGetClass(subclass, statedClass);
// 交換類方法 class 方法的實(shí)現(xiàn)
aspect_hookedGetClass(object_getClass(subclass), statedClass);
//注冊(cè)子類
objc_registerClassPair(subclass);

aspect_swizzleForwardInvocation

為新創(chuàng)建的子類替換 forwardInvocation: 實(shí)現(xiàn)，方法的實(shí)現(xiàn)指向 __ASPECTS_ARE_BEING_CALLED__允华。添加 __aspects_forwardInvocation:方法圈浇，方法的實(shí)現(xiàn)指向 __ASPECTS_ARE_BEING_CALLED__，

static void aspect_swizzleForwardInvocation(Class klass) {
    NSCParameterAssert(klass);
    // If there is no method, replace will act like class_addMethod.
    //替換 forwardInvocation 方法是實(shí)現(xiàn)
    IMP originalImplementation = class_replaceMethod(klass, @selector(forwardInvocation:), (IMP)__ASPECTS_ARE_BEING_CALLED__, "v@:@");
    if (originalImplementation) {
        //將方法的實(shí)現(xiàn) originalImplementation 對(duì)應(yīng)的SEL設(shè)置為 AspectsForwardInvocationSelectorName
        class_addMethod(klass, NSSelectorFromString(AspectsForwardInvocationSelectorName), originalImplementation, "v@:@");
    }
    AspectLog(@"Aspects: %@ is now aspect aware.", NSStringFromClass(klass));
}

aspect_hookedGetClass

修改子類的 -(Class)class靴寂、+(Class)class方法磷蜀，使其返回父類的類型。

static void aspect_hookedGetClass(Class class, Class statedClass) {
    NSCParameterAssert(class);
    NSCParameterAssert(statedClass);
    //獲取 class 方法的實(shí)現(xiàn)
    Method method = class_getInstanceMethod(class, @selector(class));
    IMP newIMP = imp_implementationWithBlock(^(id self) {
        return statedClass;
    });
    //替換class 方法的實(shí)現(xiàn)為  newIMP榨汤，返回 statedClass(父類) 的類型
    class_replaceMethod(class, @selector(class), newIMP, method_getTypeEncoding(method));
}

objc_registerClassPair

注冊(cè)子類

5. 設(shè)置原有對(duì)象類型

把 self 的類型指向 動(dòng)態(tài)創(chuàng)建的子類蠕搜。

object_setClass(self, subclass);

2. aspect_isMsgForwardIMP

判斷當(dāng)前要 hook 的方法是否是 _objc_msgForward 或者 _objc_msgForward_stret

static BOOL aspect_isMsgForwardIMP(IMP impl) {
    return impl == _objc_msgForward
#if !defined(__arm64__)
    || impl == (IMP)_objc_msgForward_stret
#endif
    ;
}

3. 動(dòng)態(tài)添加方法并且替換原方法的實(shí)現(xiàn)

動(dòng)態(tài)添加方法并且替換原方法的實(shí)現(xiàn)

1. 獲取原方法簽名，為原方法添加前綴

const char *typeEncoding = method_getTypeEncoding(targetMethod);
SEL aliasSelector = aspect_aliasForSelector(selector);

static SEL aspect_aliasForSelector(SEL selector) {
    NSCParameterAssert(selector);
    return NSSelectorFromString([AspectsMessagePrefix stringByAppendingFormat:@"_%@", NSStringFromSelector(selector)]);
}

2. 動(dòng)態(tài)添加方法

判斷當(dāng)前子類不響應(yīng)新拼接的方法名收壕。添加新創(chuàng)建的方法名到新類方法列表中妓灌。方法的實(shí)現(xiàn)指向原有的方法轨蛤。

__unused BOOL addedAlias = class_addMethod(klass, aliasSelector, method_getImplementation(targetMethod), typeEncoding);

3.將原有放方法實(shí)現(xiàn)替換

將原有的方法實(shí)現(xiàn) 替換為 _objc_msgForward 。每次調(diào)用 這個(gè)方法虫埂，就進(jìn)行了消息轉(zhuǎn)發(fā)祥山，相當(dāng)用調(diào)用 forwardInvocation：，上面 forwardInvocation: 已經(jīng)被替換為 __ASPECTS_ARE_BEING_CALLED__ 方法.

        class_replaceMethod(klass, selector, aspect_getMsgForwardIMP(self, selector), typeEncoding);

__ASPECTS_ARE_BEING_CALLED__

最終hook的方法會(huì)進(jìn)入這個(gè)方法中掉伏。

1. 獲取要調(diào)用方法名

//獲取調(diào)用方法名
SEL originalSelector = invocation.selector;
//獲取 交換后 的方法名
SEL aliasSelector = aspect_aliasForSelector(invocation.selector);

2. 通過方法名獲取要調(diào)用的方法的集合

//獲取 實(shí)例消息發(fā)送者的集合
AspectsContainer *objectContainer = objc_getAssociatedObject(self, aliasSelector);
//獲取 類方法消息發(fā)送者 的集合
AspectsContainer *classContainer = aspect_getContainerForClass(object_getClass(self), aliasSelector);

3. 按順序執(zhí)行回調(diào)和方法

1. 先便利 AspectsContainer 存儲(chǔ)的 beforeAspects 數(shù)組缝呕，執(zhí)行里面存儲(chǔ)的 block；
2. 然后便利 insteadAspects 數(shù)組斧散，執(zhí)行里面存儲(chǔ)的 block供常；
3. 如果 insteadAspects 數(shù)組為空，執(zhí)行 aliasSelector 方法鸡捐。aliasSelector 這個(gè)時(shí)候指向了原來方法的實(shí)現(xiàn)栈暇；
4. 然后便利 afterAspects 數(shù)組，執(zhí)行里面存儲(chǔ)的 block箍镜；
5. block 執(zhí)行的過程中源祈，會(huì)判斷類型是否為 AspectOptionAutomaticRemoval，如果是色迂，將改選項(xiàng)加入到一個(gè)數(shù)組中香缺，在方法執(zhí)行后，解除 hook 關(guān)系歇僧；
6. 如果沒有找到 aliasSelector图张，通過 doesNotRecognizeSelector 拋出一個(gè)異常。

到這里馏慨，大致過了一遍 Aspects 的代碼埂淮，但是這僅僅是粗略的過了一遍姑隅，還有很多細(xì)節(jié)可以繼續(xù)扣下去写隶。這里做個(gè)記錄。

NSInvocation如何調(diào)用block