iOS Runtime(一) Runtime的應用

例子Demo

概述

Objc Runtime使得C具有了物件導向能力，在程式執行時建立，檢查，修改類、物件和它們的方法。Runtime是C和彙編編寫的，這裡www.opensource.apple.com/source/objc…

應用場景

將某些OC程式碼轉為執行時程式碼，探究底層，比如block的實現原理
攔截系統自帶的方法呼叫（Swizzle 黑魔法），比如攔截imageNamed:、viewDidLoad、alloc
實現分類也可以增加屬性
實現NSCoding的自動歸檔和自動解檔
實現字典和模型的自動轉換。(MJExtension)
修BUG神器，如果大型框架的BUG 通過Runtime來解決，非常好用。

一些常用型別

Method

Method
An opaque type that represents a method in a class definition.
Declaration
typedef struct objc_method *Method;

代表類定義中的方法的不透明型別。

Class

Class
An opaque type that represents an Objective-C class.
Declaration
typedef struct objc_class *Class;

代表Objective-C中的類

Ivar

An opaque type that represents an instance variable.
Declaration
typedef struct objc_ivar *Ivar;

代表例項變數

IMP

IMP
A pointer to the start of a method implementation.

指向方法實現的開始的記憶體地址的指標。

SEL

SEL
Defines an opaque type that represents a method selector.
Declaration
typedef struct objc_selector *SEL;

代表方法的選擇器

設定關聯值

Example : 在category 中新增物件

//.h
#import <UIKit/UIKit.h>
#import <objc/runtime.h>


@interface UIView (AssociatedObject)

@property (nonatomic, strong) id associatedObject;

@end

//.m
#import "UIView+AssociatedObject.h"

@implementation UIView (AssociatedObject)

static char kAssociatedObjectKey;


- (void)setAssociatedObject:(id)associatedObject {
    objc_setAssociatedObject(self, &kAssociatedObjectKey, associatedObject, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

- (id)associatedObject {
    return objc_getAssociatedObject(self, &kAssociatedObjectKey);
}複製程式碼

objc_setAssociatedObject,給指定的物件設定關聯值。

objc_setAssociatedObject
Sets an associated value for a given object using a given key and association policy.
Declaration
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy);
Parameters
object
The source object for the association.
key
The key for the association.
value
The value to associate with the key key for object. Pass nil to clear an existing association.
policy
The policy for the association. For possible values, see Associative Object Behaviors.

object 指定的物件
const void *key key
value 值
policy 儲存策略

Behavior	@property Equivalent	Description
OBJC_ASSOCIATION_ASSIGN	@property (assign) 或 @property (unsafe_unretained)	指定一個關聯物件的弱引用。
OBJC_ASSOCIATION_RETAIN_NONATOMIC	@property (nonatomic, strong)	指定一個關聯物件的強引用，不能被原子化使用。
OBJC_ASSOCIATION_COPY_NONATOMIC	@property (nonatomic, copy)	指定一個關聯物件的copy引用，不能被原子化使用。
OBJC_ASSOCIATION_RETAIN	@property (atomic, strong)	指定一個關聯物件的強引用，能被原子化使用。
OBJC_ASSOCIATION_COPY	@property (atomic, copy)	指定一個關聯物件的copy引用，能被原子化使用。

objc_getAssociatedObject
Returns the value associated with a given object for a given key.
Declaration
id objc_getAssociatedObject(id object, const void *key);
Parameters
object
The source object for the association.
key
The key for the association.
Return Value
The value associated with the key key for object.

objc_getAssociatedObject

返回給定物件的key的關聯值

object 關聯的源物件
key 關聯的key
Return Value 與物件的key相關聯的值。

objc_removeAssociatedObjects

objc_removeAssociatedObjects
Removes all associations for a given object.
Declaration
void objc_removeAssociatedObjects(id object);
Parameters
object
An object that maintains associated objects.
Discussion
The main purpose of this function is to make it easy to return an object to a "pristine state”. You should not use this function for general removal of associations from objects, since it also removes associations that other clients may have added to the object. Typically you should use objc_setAssociatedObject with a nil value to clear an association.

刪除給定物件的所有關聯。

object 物件（關聯了許多值）
這個函式的主要目的是使物件返回一個“原始狀態”，你不應該使用這個函式從物件中刪除關聯，因為它也刪除了其他客戶端可能新增到物件的關聯。通常應該使用帶有nil值的objc_setAssociatedObject來清除關聯。

優秀樣例

新增私有屬性用於更好地去實現細節。當擴充套件一個內建類的行為時，保持附加屬性的狀態可能非常必要。注意以下說的是一種非常教科書式的關聯物件的用例：AFNetworking在 UIImageView 的category上用了關聯物件來保持一個operation物件，用於從網路上某URL非同步地獲取一張圖片。
新增public屬性來增強category的功能。有些情況下這種(通過關聯物件)讓category行為更靈活的做法比在用一個帶變數的方法來實現更有意義。在這些情況下，可以用關聯物件實現一個一個對外開放的屬性。回到上個AFNetworking的例子中的 UIImageView category，它的 imageResponseSerializer方法允許圖片通過一個濾鏡來顯示、或在快取到硬碟之前改變圖片的內容。
建立一個用於KVO的關聯觀察者。當在一個category的實現中使用KVO時，建議用一個自定義的關聯物件而不是該物件本身作觀察者。ng an associated observer for KVO**. When using KVO in a category implementation, it is recommended that a custom associated-object be used as an observer, rather than the object observing itself.

反例

當值不需要的時候建立一個關聯物件。一個常見的例子就是在view上建立一個方便的方法去儲存來自model的屬性、值或者其他混合的資料。如果那個資料在之後根本用不到，那麼這種方法雖然是沒什麼問題的，但用關聯到物件的做法並不可取。
當一個值可以被其他值推算出時建立一個關聯物件。例如：在呼叫 cellForRowAtIndexPath: 時儲存一個指向view的 UITableViewCell 中accessory view的引用，用於在 tableView:accessoryButtonTappedForRowWithIndexPath: 中使用。
用關聯物件替代X，這裡的X可以代表下列含義：
1. 當繼承比擴充套件原有的類更方便時用子類化。
2. 為事件的響應者新增響應動作。
3. 當響應動作不方便使用時使用的手勢動作捕捉。
4. 行為可以在其他物件中被代理實現時要用代理(delegate)。
5. 用NSNotification 和 NSNotificationCenter進行鬆耦合化的跨系統的事件通知。

動態新增方法

Example:

- (IBAction)addMethod:(id)sender {
    [self addMethodForPerson];
    if ([self.xjy respondsToSelector:@selector(speakMyName)]) {
        [self.xjy performSelector:@selector(speakMyName)];
    } else {
        NSLog(@"未新增成功");
    }
}

- (void)addMethodForPerson {
    class_addMethod([self.xjy class], @selector(speakMyName), (IMP)speakMyName, "v@:*");
}

void speakMyName(id self,SEL _cmd) {
    NSLog(@"新增成功啊QAQ");
}複製程式碼

class_addMethod

class_addMethod
Adds a new method to a class with a given name and implementation.
Declaration
BOOL class_addMethod(Class cls, SEL name, IMP imp, const char *types);
Parameters
cls
The class to which to add a method.
name
A selector that specifies the name of the method being added.
imp
A function which is the implementation of the new method. The function must take at least two arguments—self and _cmd.
types
An array of characters that describe the types of the arguments to the method. For possible values, see Objective-C Runtime Programming Guide > Type Encodings. Since the function must take at least two arguments—self and _cmd, the second and third characters must be “@:” (the first character is the return type).
Return Value
YES if the method was added successfully, otherwise NO (for example, the class already contains a method implementation with that name).

給一個類新增方法

cls 被新增方法的類
name 新增的方法的名稱的SEL
imp 方法的實現。該函式必須至少要有兩個引數，self,_cmd.

class_addMethod新增實現將覆蓋父類的實現，但不會替換此類中的現有實現。要更改現有實現，請使用method_setImplementation。
Objective-C方法只是一個C函式，至少需要兩個引數 - self和_cmd。例如，給定以下函式：

void myMethodIMP（id self，SEL _cmd）
{
     // implementation ....
}}複製程式碼

你可以動態地將它新增到類作為一個方法（稱為resolveThisMethodDynamically）像這樣：

class_addMethod（[self class]，@selector（resolveThisMethodDynamically），（IMP）myMethodIMP，“v @：”);複製程式碼

型別編碼

Type Encodings
To assist the runtime system, the compiler encodes the return and argument types for each method in a character string and associates the string with the method selector.

為了輔助執行時系統，編譯器對字串中每個方法的返回和引數型別進行編碼，並將字串與方法選擇器相關聯。它使用的編碼方案在其他上下文中也很有用，因此可以通過@encode（）編譯器指令公開獲得。當給定型別規範時，@encode（）返回該型別的字串編碼。型別可以是基本型別，例如int，指標，標記結構或聯合，或類名 - 實際上可以用作C sizeof（）運算子的引數的任何型別。

具體內容參見 Objective-C Runtime Programming Guide

動態交換方法實現

Example:

#import "UIViewController+LogTracking.h"
#import <objc/runtime.h>

@implementation UIViewController (LogTracking)
+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{

        Class class = [self class];
        SEL originalSelector = @selector(viewWillAppear:);
        SEL swizzledSelector = @selector(xjy_viewWillAppear:);

        Method originalMethod = class_getInstanceMethod(class,originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class,swizzledSelector);

        //judge the method named  swizzledMethod is already existed.
        BOOL didAddMethod = class_addMethod(class, originalSelector, method_getImplementation(swizzledMethod), method_getTypeEncoding(swizzledMethod));
        // if swizzledMethod is already existed.
        if (didAddMethod) {
            class_replaceMethod(class, swizzledSelector, method_getImplementation(originalMethod), method_getTypeEncoding(originalMethod));
        } else {
            method_exchangeImplementations(originalMethod, swizzledMethod);
        }
    });
}


- (void)xjy_viewWillAppear:(BOOL)animated {
    [self xjy_viewWillAppear:animated];
    NSLog(@"viewWillAppear : %@",self);
}
@end複製程式碼

+load vs +initialize

swizzling應該只在+load中完成。在 Objective-C 的執行時中，每個類有兩個方法都會自動呼叫。+load 是在一個類被初始裝載時呼叫，+initialize 是在應用第一次呼叫該類的類方法或例項方法前呼叫的。兩個方法都是可選的，並且只有在方法被實現的情況下才會被呼叫。

dispatch_once

swizzling 應該只在 dispatch_once 中完成

由於 swizzling 改變了全域性的狀態，所以我們需要確保每個預防措施在執行時都是可用的。原子操作就是這樣一個用於確保程式碼只會被執行一次的預防措施，就算是在不同的執行緒中也能確保程式碼只執行一次。Grand Central Dispatch 的 dispatch_once 滿足了所需要的需求，並且應該被當做使用 swizzling 的初始化單例方法的標準。

method_getImplementation

method_getImplementation
Returns the implementation of a method.
Declaration
IMP method_getImplementation(Method m);
Parameters
method
The method to inspect.
Return Value
A function pointer of type IMP.

返回方法的實現

method Method

method_getTypeEncoding

method_getTypeEncoding
Returns a string describing a method's parameter and return types.
Declaration
const char * method_getTypeEncoding(Method m);
Parameters
method
The method to inspect.
Return Value
A C string. The string may be NULL.

返回一個C 字串，描述方法的引數和返回型別.

method Method

class_replaceMethod

class_replaceMethod
Replaces the implementation of a method for a given class.
Declaration
IMP class_replaceMethod(Class cls, SEL name, IMP imp, const char *types);
Parameters
cls
The class you want to modify.
name
A selector that identifies the method whose implementation you want to replace.
imp
The new implementation for the method identified by name for the class identified by cls.
types
An array of characters that describe the types of the arguments to the method. For possible values, see Objective-C Runtime Programming Guide > Type Encodings. Since the function must take at least two arguments—self and _cmd, the second and third characters must be “@:” (the first character is the return type).
Return Value
The previous implementation of the method identified by name for the class identified by cls.

替換指定方法的實現

cls class
name selector
imp 新的IMP
types 型別編碼

此函式以兩種不同的方式執行：

如果通過名稱標識的方法不存在，則會像呼叫class_addMethod一樣新增它。由型別指定的型別編碼按給定使用。
如果按名稱標識的方法存在，那麼將替換其IMP，就好像呼叫了method_setImplementation。將忽略由types指定的型別編碼。

method_exchangeImplementations

method_exchangeImplementations
Exchanges the implementations of two methods.
Declaration
void method_exchangeImplementations(Method m1, Method m2);

交換兩個方法的實現.

原子版本的實現：

IMP imp1 = method_getImplementation(m1);
IMP imp2 = method_getImplementation(m2);
method_setImplementation(m1, imp2);
method_setImplementation(m2, imp1);複製程式碼

Selectors, Methods, & Implementations

在 Objective-C 的執行時中，selectors, methods, implementations 指代了不同概念，然而我們通常會說在訊息傳送過程中，這三個概念是可以相互轉換的。下面是蘋果 Objective-C Runtime Reference中的描述：

Selector（typedef struct objc_selector *SEL）:在執行時 Selectors 用來代表一個方法的名字。Selector 是一個在執行時被註冊（或對映）的C型別字串。Selector由編譯器產生並且在當類被載入進記憶體時由執行時自動進行名字和實現的對映。
Method（typedef struct objc_method *Method）:方法是一個不透明的用來代表一個方法的定義的型別。
Implementation（typedef id (*IMP)(id, SEL,...)）:這個資料型別指向一個方法的實現的最開始的地方。該方法為當前CPU架構使用標準的C方法呼叫來實現。該方法的第一個引數指向呼叫方法的自身（即記憶體中類的例項物件，若是呼叫類方法，該指標則是指向元類物件metaclass）。第二個引數是這個方法的名字selector，該方法的真正引數緊隨其後。

理解 selector, method, implementation 這三個概念之間關係的最好方式是：在執行時，類（Class）維護了一個訊息分發列表來解決訊息的正確傳送。每一個訊息列表的入口是一個方法（Method），這個方法對映了一對鍵值對，其中鍵是這個方法的名字 selector（SEL），值是指向這個方法實現的函式指標 implementation（IMP）。 Method swizzling 修改了類的訊息分發列表使得已經存在的 selector 對映了另一個實現 implementation，同時重新命名了原生方法的實現為一個新的 selector。

思考

很多人認為交換方法實現會帶來無法預料的結果。然而採取了以下預防措施後, method swizzling 會變得很可靠：

在交換方法實現後記得要呼叫原生方法的實現（除非你非常確定可以不用呼叫原生方法的實現）：APIs 提供了輸入輸出的規則，而在輸入輸出中間的方法實現就是一個看不見的黑盒。交換了方法實現並且一些回撥方法不會呼叫原生方法的實現這可能會造成底層實現的崩潰。
避免衝突：為分類的方法加字首，一定要確保呼叫了原生方法的所有地方不會因為你交換了方法的實現而出現意想不到的結果。
理解實現原理：只是簡單的拷貝貼上交換方法實現的程式碼而不去理解實現原理不僅會讓 App 很脆弱，並且浪費了學習 Objective-C 執行時的機會。閱讀 Objective-C Runtime Reference 並且瀏覽能夠讓你更好理解實現原理。
持續的預防：不管你對你理解 swlzzling 框架，UIKit 或者其他內嵌框架有多自信，一定要記住所有東西在下一個發行版本都可能變得不再好使。做好準備，在使用這個黑魔法中走得更遠，不要讓程式反而出現不可思議的行為。

通過Method Swizzling可以把事件程式碼或Logging，Authentication，Caching等跟主要業務邏輯程式碼解耦。這種處理方式叫做Cross Cutting Concernsen.wikipedia.org/wiki/Cross-… 用Method Swizzling動態給指定的方法新增程式碼解決Cross Cutting Concerns的程式設計方式叫Aspect Oriented Programming en.wikipedia.org/wiki/Aspect… 目前有些第三方庫可以很方便的使用AOP，比如Aspects github.com/steipete/As… 這裡是使用Aspects的範例github.com/okcomp/Aspe…

訊息分發

//  第一步
//  在沒有找到方法時，會先呼叫此方法，可用於動態新增方法
//  返回 YES 表示相應 selector 的實現已經被找到並新增到了類中，否則返回 NO
+ (BOOL)resolveInstanceMethod:(SEL)sel {
return YES;
}


//  第二步
//  如果第一步的返回 NO 或者直接返回了 YES 而沒有新增方法，該方法被呼叫
//  在這個方法中，我們可以指定一個可以返回一個可以響應該方法的物件
//  如果返回 self 就會死迴圈
- (id)forwardingTargetForSelector:(SEL)aSelector
{
if(aSelector == @selector(xxx:)){
return self.alternateObject;
}
return [super forwardingTargetForSelector:aSelector];
}

//  第三步
//  如果 `forwardingTargetForSelector:` 返回了 nil，則該方法會被呼叫，系統會詢問我們要一個合法的『型別編碼(Type Encoding)』
//  若返回 nil，則不會進入下一步，而是無法處理訊息

- (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector {
return [NSMethodSignature signatureWithObjCTypes:"v@:"];
}

// 當實現了此方法後，-doesNotRecognizeSelector: 將不會被呼叫
// 如果要測試找不到方法，可以註釋掉這一個方法
// 在這裡進行訊息轉發
- (void)forwardInvocation:(NSInvocation *)anInvocation {
// 我們還可以改變方法選擇器
[anInvocation setSelector:@selector(notFind)];
// 改變方法選擇器後，還需要指定是哪個物件的方法
[anInvocation invokeWithTarget:self];
}

- (void)notFind {
NSLog(@"沒有實現 -mysteriousMethod 方法，並且成功的轉成了 -notFind 方法");
}複製程式碼

部分內容引用和翻譯自
nshipster.cn/method-swiz…
nshipster.cn/associated-…
developer.apple.com/library/con…
github.com/ming1016/st…

第二篇深入理解OC Runtime