iOS 開發中 runtime 常用的幾種方法

n以夢為馬發表於2018-07-19
iOS

公司專案中用了一些 runtime 相關的知識, 初看時有些蒙, 雖然用的並不多, 但還是想著系統的把 runtime 相關的常用方法整理一下, 自己以後用著方便, 也希望對看到的朋友有所幫助.

一、runtime 簡介

runtime 簡稱執行時，是系統在執行的時候的一些機制，其中最主要的是訊息機制。它是一套比較底層的純 C 語言 API, 屬於一個 C 語言庫，包含了很多底層的 C 語言 API。我們平時編寫的 OC 程式碼，在程式執行過程時，其實最終都是轉成了 runtime 的 C 語言程式碼。如下所示:

// OC程式碼:
[Person coding];

//執行時 runtime 會將它轉化成 C 語言的程式碼:
objc_msgSend(Person, @selector(coding));
複製程式碼

二、相關函式

// 遍歷某個類所有的成員變數
class_copyIvarList

// 遍歷某個類所有的方法
class_copyMethodList

// 獲取指定名稱的成員變數
class_getInstanceVariable

// 獲取成員變數名
ivar_getName

// 獲取成員變數型別編碼
ivar_getTypeEncoding

// 獲取某個物件成員變數的值
object_getIvar

// 設定某個物件成員變數的值
object_setIvar

// 給物件傳送訊息
objc_msgSend
複製程式碼

三、相關應用

  • 更改屬性值
  • 動態新增屬性
  • 動態新增方法
  • 交換方法的實現
  • 攔截並替換方法
  • 在方法上增加額外功能
  • 歸檔解檔
  • 字典轉模型

以上八種用法用程式碼都實現了, 文末會貼出程式碼地址.

runtime

四、程式碼實現

要使用runtime，要先引入標頭檔案#import <objc/runtime.h>

4.1 更改屬性值

用 runtime 修改一個物件的屬性值

    unsigned int count = 0;
    // 動態獲取類中的所有屬性(包括私有)
    Ivar *ivar = class_copyIvarList(_person.class, &count);
    // 遍歷屬性找到對應欄位
    for (int i = 0; i < count; i ++) {
        Ivar tempIvar = ivar[i];
        const char *varChar = ivar_getName(tempIvar);
        NSString *varString = [NSString stringWithUTF8String:varChar];
        if ([varString isEqualToString:@"_name"]) {
            // 修改對應的欄位值
            object_setIvar(_person, tempIvar, @"更改屬性值成功");
            break;
        }
    }
複製程式碼

4.2 動態新增屬性

用 runtime 為一個類新增屬性, iOS 分類裡一般會這樣用, 我們建立一個分類, NSObject+NNAddAttribute.h, 並新增以下程式碼:

- (void)setName:(NSString *)name {
    objc_setAssociatedObject(self, @"name", name, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

- (NSString *)name {
    return objc_getAssociatedObject(self, @"name");
}
複製程式碼

這樣只要引用 NSObject+NNAddAttribute.h, 用 NSObject 建立的物件就會有一個 name 屬性, 我們可以直接這樣寫:

    NSObject *person = [NSObject new];
    person.name = @"以夢為馬";
複製程式碼

4.3 動態新增方法

person 類中沒有 coding 方法，我們用 runtime 給 person 類新增了一個名字叫 coding 的方法，最終再呼叫coding方法做出相應. 下面程式碼的幾個引數需要注意一下:

- (void)buttonClick:(UIButton *)sender {
    /*
     動態新增 coding 方法
     (IMP)codingOC 意思是 codingOC 的地址指標;
     "v@:" 意思是，v 代表無返回值 void，如果是 i 則代表 int；@代表 id sel; : 代表 SEL _cmd;
     “v@:@@” 意思是，兩個引數的沒有返回值。
     */
    class_addMethod([_person class], @selector(coding), (IMP)codingOC, "v@:");
    // 呼叫 coding 方法響應事件
    if ([_person respondsToSelector:@selector(coding)]) {
        [_person performSelector:@selector(coding)];
        self.testLabelText = @"新增方法成功";
    } else {
        self.testLabelText = @"新增方法失敗";
    }
}

// 編寫 codingOC 的實現
void codingOC(id self,SEL _cmd) {
    NSLog(@"新增方法成功");
}
複製程式碼

4.4 交換方法的實現

某個類有兩個方法, 比如 person 類有兩個方法, coding 方法與 eating 方法, 我們用 runtime 交換一下這兩個方法, 就會出現這樣的情況, 當我們呼叫 coding 的時候, 執行的是 eating, 當我們呼叫 eating 的時候, 執行的是 coding, 如下面的動態效果圖.

    Method oriMethod = class_getInstanceMethod(_person.class, @selector(coding));
    Method curMethod = class_getInstanceMethod(_person.class, @selector(eating));
    method_exchangeImplementations(oriMethod, curMethod);
複製程式碼

交換方法的實現

4.5 攔截並替換方法

這個功能和上面的其實有些類似, 攔截並替換方法可以攔截並替換同一個類的, 也可以在兩個類之間進行, 我這裡用了兩個不同的類, 下面是簡單的程式碼實現.

    _person = [NNPerson new];
    _library = [NNLibrary new];
    self.testLabelText = [_library libraryMethod];
    Method oriMethod = class_getInstanceMethod(_person.class, @selector(changeMethod));
    Method curMethod = class_getInstanceMethod(_library.class, @selector(libraryMethod));
    method_exchangeImplementations(oriMethod, curMethod);
複製程式碼

4.6 在方法上增加額外功能

這個使用場景還是挺多的, 比如我們需要記錄 APP 中某一個按鈕的點選次數, 這個時候我們便可以利用 runtime 來實現這個功能. 我這裡寫了個 UIButton 的子類, 然後在 + (void)load 中用 runtime 給它增加了一個功能, 核心程式碼及實現效果圖如下:

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Method oriMethod = class_getInstanceMethod(self.class, @selector(sendAction:to:forEvent:));
        Method cusMethod = class_getInstanceMethod(self.class, @selector(customSendAction:to:forEvent:));
        // 判斷自定義的方法是否實現, 避免崩潰
        BOOL addSuccess = class_addMethod(self.class, @selector(sendAction:to:forEvent:), method_getImplementation(cusMethod), method_getTypeEncoding(cusMethod));
        if (addSuccess) {
            // 沒有實現, 將源方法的實現替換到交換方法的實現
            class_replaceMethod(self.class, @selector(customSendAction:to:forEvent:), method_getImplementation(oriMethod), method_getTypeEncoding(oriMethod));
        } else {
            // 已經實現, 直接交換方法
            method_exchangeImplementations(oriMethod, cusMethod);
        }
    });
}
複製程式碼

在方法上增加額外功能

4.7 歸檔解檔

當我們使用 NSCoding 進行歸檔及解檔時, 如果不用 runtime, 那麼不管模型裡面有多少屬性, 我們都需要對其實現一遍 encodeObject 和 decodeObjectForKey 方法, 如果模型裡面有 10000 個屬性, 那麼我們就需要寫 10000 句encodeObject 和 decodeObjectForKey 方法, 這個時候用 runtime, 便可以充分體驗其好處(以下只是核心程式碼, 具體程式碼請見 demo).

- (void)encodeWithCoder:(NSCoder *)aCoder {
    unsigned int count = 0;
    // 獲取類中所有屬性
    Ivar *ivars = class_copyIvarList(self.class, &count);
    // 遍歷屬性
    for (int i = 0; i < count; i ++) {
        // 取出 i 位置對應的屬性
        Ivar ivar = ivars[i];
        // 檢視屬性
        const char *name = ivar_getName(ivar);
        NSString *key = [NSString stringWithUTF8String:name];
        // 利用 KVC 進行取值，根據屬性名稱獲取對應的值
        id value = [self valueForKey:key];
        [aCoder encodeObject:value forKey:key];
    }
    free(ivars);
}

- (instancetype)initWithCoder:(NSCoder *)aDecoder {
    if (self = [super init]) {
        unsigned int count = 0;
        // 獲取類中所有屬性
        Ivar *ivars = class_copyIvarList(self.class, &count);
        // 遍歷屬性
        for (int i = 0; i < count; i ++) {
            // 取出 i 位置對應的屬性
            Ivar ivar = ivars[i];
            // 檢視屬性
            const char *name = ivar_getName(ivar);
            NSString *key = [NSString stringWithUTF8String:name];
            // 進行解檔取值
            id value = [aDecoder decodeObjectForKey:key];
            // 利用 KVC 對屬性賦值
            [self setValue:value forKey:key];
        }
    }
    return self;
}
複製程式碼

4.8 字典轉模型

字典轉模型我們通常用的都是第三方, MJExtension, YYModel 等, 但也有必要了解一下其實現方式: 遍歷模型中的所有屬性，根據模型的屬性名，去字典中查詢對應的 key，取出對應的值，給模型的屬性賦值。

/** 字典轉模型 **/
+ (instancetype)modelWithDict:(NSDictionary *)dict {
    id objc = [[self alloc] init];
    unsigned int count = 0;
    // 獲取成員屬性陣列
    Ivar *ivarList = class_copyIvarList(self, &count);
    // 遍歷所有的成員屬性名
    for (int i = 0; i < count; i ++) {
        // 獲取成員屬性
        Ivar ivar = ivarList[i];
        // 獲取成員屬性名
        NSString *ivarName = [NSString stringWithUTF8String:ivar_getName(ivar)];
        NSString *key = [ivarName substringFromIndex:1];
        // 從字典中取出對應 value 給模型屬性賦值
        id value = dict[key];
        // 獲取成員屬性型別
        NSString *ivarType = [NSString stringWithUTF8String:ivar_getTypeEncoding(ivar)];
        // 判斷 value 是不是字典
        if ([value isKindOfClass:[NSDictionary class]]) {
            ivarType = [ivarType stringByReplacingOccurrencesOfString:@"@" withString:@""];
            ivarType = [ivarType stringByReplacingOccurrencesOfString:@"\"" withString:@""];
            Class modalClass = NSClassFromString(ivarType);
            // 字典轉模型
            if (modalClass) {
                // 字典轉模型
                value = [modalClass modelWithDict:value];
            }
        }
        if ([value isKindOfClass:[NSArray class]]) {
            // 判斷對應類有沒有實現字典陣列轉模型陣列的協議
            if ([self respondsToSelector:@selector(arrayContainModelClass)]) {
                // 轉換成id型別，就能呼叫任何物件的方法
                id idSelf = self;
                // 獲取陣列中字典對應的模型
                NSString *type = [idSelf arrayContainModelClass][key];
                // 生成模型
                Class classModel = NSClassFromString(type);
                NSMutableArray *arrM = [NSMutableArray array];
                // 遍歷字典陣列，生成模型陣列
                for (NSDictionary *dict in value) {
                    // 字典轉模型
                    id model =  [classModel modelWithDict:dict];
                    [arrM addObject:model];
                }
                // 把模型陣列賦值給value
                value = arrM;
            }
        }
        // KVC 字典轉模型
        if (value) {
            [objc setValue:value forKey:key];
        }
    }
    return objc;
}
複製程式碼

上面的所有程式碼都可以在這裡下載: runtime 練習: NNRuntimeTest

相關文章