Runtime整理（二）——Runtime包含的全部函數

Runtime整理（二）——Runtime包含的全部函數

---

runtime.h中的全部函數

Working with Instances

// 返回指定對象的一份拷貝
id _Nullable object_copy(id _Nullable obj, size_t size);

// 釋放指定對象佔用的內存
id _Nullable object_dispose(id _Nullable obj);

// 返回對象的類
Class _Nullable object_getClass(id _Nullable obj);

// 設置對象的類
Class _Nullable object_setClass(id _Nullable obj, Class _Nonnull cls);

// 返回指定對象是不是一個類對象
BOOL object_isClass(id _Nullable obj);


// 已知Ivar，獲取對象中指定成員變量的值
id _Nullable object_getIvar(id _Nullable obj, Ivar _Nonnull ivar);

// 已知Ivar，設置對象中指定成員變量的值
void object_setIvar(id _Nullable obj, Ivar _Nonnull ivar, id _Nullable value);

// 已知Ivar，設置對象中指定成員變量的值（強引用）
void object_setIvarWithStrongDefault(id _Nullable obj, Ivar _Nonnull ivar, id _Nullable value);

// 設置對象中指定成員變量的值
Ivar _Nullable object_setInstanceVariable(id _Nullable obj, const char * _Nonnull name, void * _Nullable value);

// 設置對象中指定成員變量的值（強引用）
Ivar _Nullable object_setInstanceVariableWithStrongDefault(id _Nullable obj, const char * _Nonnull name, void * _Nullable value);

// 獲取對象中指定成員變量的值
Ivar _Nullable object_getInstanceVariable(id _Nullable obj, const char * _Nonnull name, void * _Nullable * _Nullable outValue);

Obtaining Class Definitions

// 經過類名字符串獲取類（若是類未在runtime中註冊，則調用類的處理回調，並再次確認類是否註冊，若是確認未註冊，再返回nil）
Class _Nullable objc_getClass(const char * _Nonnull name);

// 經過類名字符串獲取類（若是類未在runtime中註冊則返回nil）
Class _Nullable objc_lookUpClass(const char * _Nonnull name);

// 經過類名字符串獲取類（若是找不到該類則殺死進程）
Class _Nonnull
objc_getRequiredClass(const char * _Nonnull name);

// 經過類名字符串獲取該類的元類
Class _Nullable objc_getMetaClass(const char * _Nonnull name);


// 獲取已註冊的類定義列表
int objc_getClassList(Class _Nonnull * _Nullable buffer, int bufferCount);

// 建立並返回一個指向全部已註冊類的指針列表
Class _Nonnull * _Nullable objc_copyClassList(unsigned int * _Nullable outCount);

Working with Classes

// 獲取類的類名
const char * _Nonnull class_getName(Class _Nullable cls);
// 判斷一個是不是元類
BOOL class_isMetaClass(Class _Nullable cls);

// 獲取類的父類
Class _Nullable class_getSuperclass(Class _Nullable cls);

// 設置一個類的父類
Class _Nonnull class_setSuperclass(Class _Nonnull cls, Class _Nonnull newSuper);

// 獲取類版本號
int class_getVersion(Class _Nullable cls);

// 設置類版本號
void class_setVersion(Class _Nullable cls, int version);

// 獲取實例大小
size_t class_getInstanceSize(Class _Nullable cls);

// 獲取類中指定名稱實例成員變量的信息
Ivar _Nullable class_getInstanceVariable(Class _Nullable cls, const char * _Nonnull name);

// 獲取類成員變量的信息
Ivar _Nullable class_getClassVariable(Class _Nullable cls, const char * _Nonnull name);

// 獲取成員變量列表
Ivar _Nonnull * _Nullable class_copyIvarList(Class _Nullable cls, unsigned int * _Nullable outCount);

// 獲取實例方法
Method _Nullable class_getInstanceMethod(Class _Nullable cls, SEL _Nonnull name);

// 獲取類方法
Method _Nullable class_getClassMethod(Class _Nullable cls, SEL _Nonnull name);

// 返回方法的具體實現
IMP _Nullable class_getMethodImplementation(Class _Nullable cls, SEL _Nonnull name);
IMP _Nullable class_getMethodImplementation_stret(Class _Nullable cls, SEL _Nonnull name);

// 類實例是否響應指定的selector
BOOL class_respondsToSelector(Class _Nullable cls, SEL _Nonnull sel);

// 獲取全部方法列表
Method _Nonnull * _Nullable class_copyMethodList(Class _Nullable cls, unsigned int * _Nullable outCount);

// 返回類是否實現指定的協議
BOOL class_conformsToProtocol(Class _Nullable cls, Protocol * _Nullable protocol);

// 返回類實現的協議列表
Protocol * __unsafe_unretained _Nonnull * _Nullable class_copyProtocolList(Class _Nullable cls, unsigned int * _Nullable outCount);

// 獲取指定的屬性
objc_property_t _Nullable class_getProperty(Class _Nullable cls, const char * _Nonnull name);

// 獲取屬性列表
objc_property_t _Nonnull * _Nullable class_copyPropertyList(Class _Nullable cls, unsigned int * _Nullable outCount);


// 添加方法
BOOL class_addMethod(Class _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, const char * _Nullable types);

// 替換方法的實現
IMP _Nullable class_replaceMethod(Class _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, const char * _Nullable types);

// 添加成員變量
BOOL class_addIvar(Class _Nullable cls, const char * _Nonnull name, size_t size, uint8_t alignment, const char * _Nullable types);

// 添加協議
BOOL class_addProtocol(Class _Nullable cls, Protocol * _Nonnull protocol);

// 爲類添加屬性
BOOL class_addProperty(Class _Nullable cls, const char * _Nonnull name, const objc_property_attribute_t * _Nullable attributes, unsigned int attributeCount);

// 替換類的屬性
void class_replaceProperty(Class _Nullable cls, const char * _Nonnull name, const objc_property_attribute_t * _Nullable attributes, unsigned int attributeCount);

// 肯定一個對象的內存區域是否能夠被垃圾回收器掃描，以處理strong/weak引用，無需主動調用
const uint8_t * _Nullable class_getIvarLayout(Class _Nullable cls);
const uint8_t * _Nullable class_getWeakIvarLayout(Class _Nullable cls);
void class_setIvarLayout(Class _Nullable cls, const uint8_t * _Nullable layout);
void class_setWeakIvarLayout(Class _Nullable cls, const uint8_t * _Nullable layout);

// 提供給CoreFoundation的tool-free bridging使用的方法
Class _Nonnull objc_getFutureClass(const char * _Nonnull name);

Instantiating Classes

// 建立類實例
id _Nullable class_createInstance(Class _Nullable cls, size_t extraBytes);

// 在指定位置建立類實例
id _Nullable objc_constructInstance(Class _Nullable cls, void * _Nullable bytes);

// 銷燬類實例
void * _Nullable objc_destructInstance(id _Nullable obj);

Adding Classes

// 建立一個新類和元類
Class _Nullable objc_allocateClassPair(Class _Nullable superclass, const char * _Nonnull name, size_t extraBytes);
// 在應用中註冊由objc_allocateClassPair建立的類
void objc_registerClassPair(Class _Nonnull cls);
// 用於KVO，不要本身調用
Class _Nonnull objc_duplicateClass(Class _Nonnull original, const char * _Nonnull name, size_t extraBytes);
// 銷燬一個類及其相關聯的類
void objc_disposeClassPair(Class _Nonnull cls);

Working with Methods

// 獲取方法名
SEL _Nonnull method_getName(Method _Nonnull m);

// 獲取方法實現
IMP _Nonnull method_getImplementation(Method _Nonnull m);

// 獲取方法的屬性信息（包括返回值類型，參數類型等等信息）
const char * _Nullablemethod_getTypeEncoding(Method _Nonnull m);

// 獲取方法的參數個數
unsigned int method_getNumberOfArguments(Method _Nonnull m);


// 獲取參數的屬性參數
char * _Nullable method_copyArgumentType(Method _Nonnull m, unsigned int index);
void method_getArgumentType(Method _Nonnull m, unsigned int index, char * _Nullable dst, size_t dst_len);

// 獲取返回值的類型
void method_getReturnType(Method _Nonnull m, char * _Nonnull dst, size_t dst_len);
char * _Nonnull method_copyReturnType(Method _Nonnull m);


// 設置一個方法的實現
IMP _Nonnull method_setImplementation(Method _Nonnull m, IMP _Nonnull imp);

// 交換兩個方法的實現
void method_exchangeImplementations(Method _Nonnull m1, Method _Nonnull m2);

Working with Instance Variables

// 獲取變量名
const char * _Nullable ivar_getName(Ivar _Nonnull v);

// 獲取變量類型描述
const char * _Nullable ivar_getTypeEncoding(Ivar _Nonnull v);

// 獲取變量基地址偏移量
ptrdiff_t ivar_getOffset(Ivar _Nonnull v);

Working with Properties

// 獲取屬性名
const char * _Nonnull property_getName(objc_property_t _Nonnull property);

// 獲取屬性的屬性
const char * _Nullable property_getAttributes(objc_property_t _Nonnull property);

// 獲取屬性的屬性列表
objc_property_attribute_t * _Nullable property_copyAttributeList(objc_property_t _Nonnull property, unsigned int * _Nullable outCount);

// 獲取屬性的屬性值
char * _Nullable property_copyAttributeValue(objc_property_t _Nonnull property, const char * _Nonnull attributeName);

Working with Protocols

// 根據字符串獲取協議
Protocol * _Nullable objc_getProtocol(const char * _Nonnull name);


// 獲取runtime中已知的全部協議列表
Protocol * __unsafe_unretained _Nonnull * _Nullable objc_copyProtocolList(unsigned int * _Nullable outCount);

// 返回一個協議是否遵照另外一個協議。
BOOL protocol_conformsToProtocol(Protocol * _Nullable proto, Protocol * _Nullable other);

// 返回兩個協議是否相等
BOOLprotocol_isEqual(Protocol * _Nullable proto, Protocol * _Nullable other);

// 獲取協議名
const char * _Nonnull protocol_getName(Protocol * _Nonnull proto);

// 根據給定的協議、方法選擇器和要求返回方法描述
struct objc_method_description protocol_getMethodDescription(Protocol * _Nonnull proto, SEL _Nonnull aSel, BOOL isRequiredMethod, BOOL isInstanceMethod);

// 返回協議中符合給定要求的方法描述數組
struct objc_method_description * _Nullable
protocol_copyMethodDescriptionList(Protocol * _Nonnull proto, BOOL isRequiredMethod, BOOL isInstanceMethod, unsigned int * _Nullable outCount);

// 獲取協議的指定屬性
objc_property_t _Nullable protocol_getProperty(Protocol * _Nonnull proto, const char * _Nonnull name, BOOL isRequiredProperty, BOOL isInstanceProperty);

// 獲取協議中的屬性列表
objc_property_t _Nonnull * _Nullable protocol_copyPropertyList(Protocol * _Nonnull proto, unsigned int * _Nullable outCount);
objc_property_t _Nonnull * _Nullable protocol_copyPropertyList2(Protocol * _Nonnull proto, unsigned int * _Nullable outCount, BOOL isRequiredProperty, BOOL isInstanceProperty);

// 獲取協議遵照的全部協議
Protocol * __unsafe_unretained _Nonnull * _Nullable protocol_copyProtocolList(Protocol * _Nonnull proto, unsigned int * _Nullable outCount);

// 建立新的協議
Protocol * _Nullable objc_allocateProtocol(const char * _Nonnull name);

// 在運行時中註冊新建立的協議
void objc_registerProtocol(Protocol * _Nonnull proto);

// 爲協議添加方法
void protocol_addMethodDescription(Protocol * _Nonnull proto, SEL _Nonnull name, const char * _Nullable types, BOOL isRequiredMethod, BOOL isInstanceMethod);

// 添加一個已註冊的協議到協議中
void protocol_addProtocol(Protocol * _Nonnull proto, Protocol * _Nonnull addition);

// 爲協議添加屬性
void protocol_addProperty(Protocol * _Nonnull proto, const char * _Nonnull name, const objc_property_attribute_t * _Nullable attributes, unsigned int attributeCount, BOOL isRequiredProperty, BOOL isInstanceProperty);

Working with Libraries

// 獲取全部加載的Objective-C框架和動態庫的名稱
const char * _Nonnull * _Nonnull objc_copyImageNames(unsigned int * _Nullable outCount);

// 獲取指定類所在動態庫
const char * _Nullable class_getImageName(Class _Nullable cls);

// 獲取指定庫或框架中全部類的類名
const char * _Nonnull * _Nullable objc_copyClassNamesForImage(const char * _Nonnull image, unsigned int * _Nullable outCount);

Working with Selectors

// 獲取方法選擇器的名字
const char * _Nonnull sel_getName(SEL _Nonnull sel);

// 向運行時系統註冊一個方法選擇器
SEL _Nonnull sel_registerName(const char * _Nonnull str);

// 判斷兩個方法選擇器是否相等
BOOL sel_isEqual(SEL _Nonnull lhs, SEL _Nonnull rhs);

Objective-C Language Features

// 在迭代期間檢測到遍歷對象發生了改變，則會插入該函數拋出異常
void objc_enumerationMutation(id _Nonnull obj);
// 設置出現上述異常時的處理塊
void objc_setEnumerationMutationHandler(void (*_Nullable handler)(id _Nonnull ));


// 設置objc_msgForward的回調方法
void objc_setForwardHandler(void * _Nonnull fwd, void * _Nonnull fwd_stret);

// 建立一個指針函數的指針，該函數調用時會調用特定的block
IMP _Nonnull imp_implementationWithBlock(id _Nonnull block);

// 返回與IMP(使用imp_implementationWithBlock建立的)相關的block
id _Nullable imp_getBlock(IMP _Nonnull anImp);

// 解除block與IMP(使用imp_implementationWithBlock建立的)的關聯關係，並釋放block的拷貝
BOOL imp_removeBlock(IMP _Nonnull anImp);

// 加載弱引用指針引用的對象並返回
id _Nullable objc_loadWeak(id _Nullable * _Nonnull location);

// 存儲__weak變量的新值
id _Nullable objc_storeWeak(id _Nullable * _Nonnull location, id _Nullable obj);

Associative References

// 爲對象設置關聯對象
void objc_setAssociatedObject(id _Nonnull object, const void * _Nonnull key, id _Nullable value, objc_AssociationPolicy policy);

// 獲取對象的關聯對象
id _Nullable objc_getAssociatedObject(id _Nonnull object, const void * _Nonnull key);

// 移除對象的全部關聯對象
void objc_removeAssociatedObjects(id _Nonnull object);

Hooks for Swift

/* Hooks for Swift */

// 攔截class_getImageName()的hook方法類型
typedef BOOL (*objc_hook_getImageName)(Class _Nonnull cls, const char * _Nullable * _Nonnull outImageName);

// 給class_getImageName()安裝一個hook方法
void objc_setHook_getImageName(objc_hook_getImageName _Nonnull newValue,objc_hook_getImageName _Nullable * _Nonnull outOldValue)

---

回顧

Runtime整理（一）——Runtime的介紹和知識點

---

參考文章

Objective-C Runtime 運行時之一：類與對象
iOS-runtime通篇詳解-上