『Runtime』详解（四）获取类详细属性、方法

本文用来介绍 iOS 开发中，如何通过『Runtime』获取类详细属性、方法。通过本文，您将了解到：

1. 获取类详细属性、方法简述
2. 获取类详细属性、方法（成员变量列表、属性列表、方法列表、所遵循的协议列表）
3. 应用场景
   3.1 修改私有属性
   3.2 万能控制器跳转
   3.3 实现字典转模型
   3.4 改进 iOS 归档和解档

文中示例代码在： bujige / YSC-Class-DetailList-Demo

---

image

1. 获取类详细属性、方法简述

在苹果官方为我们提供的类中，只能获取一小部分公开的属性和方法。有些我们恰好需要的属性和方法，可能会被官方隐藏了起来，没有直接提供给我们。

那应该如何才能获取一个类中所有的变量和方法，用来查找是否有对我们有用的变量和方法呢？

幸好 Runtime 中为我们提供了一系列 API 来获取 Class （类）的 成员变量（ Ivar ）、属性（ Property ）、方法（ Method ）、协议（ Protocol ） 等。我们可以通过这些方法来遍历一个类中的成员变量列表、属性列表、方法列表、协议列表。从而查找我们需要的变量和方法。

比如说遇到这样一个需求：更改 UITextField 占位文字的颜色和字号。实现代码参考 3.1 修改私有属性 中的例子。

下面我们先来讲解一下如何通过代码获取类详细属性、方法。

---

2. 获取类详细属性、方法

注意：头文件中需引入 #import 。

2.1 获取类的成员变量列表

| | |

2.2 获取类的属性列表

| | |

2.3 获取类的方法列表

| | |

2.4 获取类所遵循的协议列表

| | |

---

3. 应用场景

3.1 修改私有属性

需求：更改 UITextField 占位文字的颜色和字号

先来想想又几种做法：

方法 1：通过 attributedPlaceholder 属性修改

我们知道 UITextField 中有 placeholder 属性和 attributedPlaceholder 属性。通过 placeholder 属性只能更改占位文字，无法修改占位文字的字体和颜色。而通过 attributedPlaceholder 属性我们就可以修改 UITextField 占位文字的颜色和字号了。

方法 2：重写 UITextField 的 drawPlaceholderInRect: 方法修改

实现步骤：

1. 自定义一个 XXTextField 继承自 UITextField；
2. 重写自定义 XXTextField 的 drawPlaceholderInRect: 方法；
3. 在 drawPlaceholderInRect 方法中设置 placeholder 的属性。

| | |

方法 3：利用 Runtime，找到并修改 UITextfield 的私有属性

实现步骤：

1. 通过获取类的属性列表和成员变量列表的方法打印 UITextfield 所有属性和成员变量；
2. 找到私有的成员变量 _placeholderLabel；
3. 利用 KVC 对 _placeholderLabel 进行修改。

| | |

---

3.2 万能控制器跳转

需求：

1. 某个页面的不同 banner 图，点击可以跳转到不同页面。
2. 推送通知，点击跳转到指定页面。
3. 二维码扫描，根据不同内容，跳转不同页面。
4. WebView 页面，根据 URL 点击不同，跳转不同的原生页面。

先来思考一下几种解决方法。

方法 1：在每个需要跳转的地方写一堆判断语句以及跳转语句。

方法 2：将判断语句和跳转语句抽取出来，写到基类，或者对应的 Category 中。

方法 3：利用 Runtime，定制一个万能跳转控制器工具。

实现步骤：

1. 事先和服务器端商量好，定义跳转不同控制器的规则，让服务器传回对应规则的相关参数。
   比如：跳转到 A 控制器，需要服务器传回 A 控制器的类名，控制器 A 需要传入的属性参数（id、type 等等）。
2. 根据服务器传回的类名，创建对应的控制器对象；
3. 遍历服务器传回的参数，利用 Runtime 遍历控制器对象的属性列表；
4. 如果控制器对象存在该属性，则利用 KVC 进行赋值；
5. 进行跳转。

首先，定义跳转规则，如下所示。XXViewController 是将要跳转的控制器类名。property 字典中保存的是控制器所需的属性参数。

| | |

然后，添加一个工具类 XXJumpControllerTool，添加跳转相关的类方法。

| | |

测试代码：

| | |

---

3.3 实现字典转模型

在日常开发中，将网络请求中获取的 JSON 数据转为数据模型，是我们开发中必不可少的操作。通常我们会选用诸如 YYModel、JSONModel 或者 MJExtension 等第三方框架来实现这一过程。这些框架实现原理的核心就是 Runtime 和 KVC，以及 Getter / Setter。

实现的大体思路如下：借助 Runtime 可以动态获取成员列表的特性，遍历模型中所有属性，然后以获取到的属性名为 key，在 JSON 字典中寻找对应的值 value；再使用 KVC 或直接调用 Getter / Setter 将每一个对应 value 赋值给模型，就完成了字典转模型的目的。

需求：将服务器返回的 JSON 字典转为数据模型。

先准备一份待解析的 JSON 数据，内容如下：

| | |

假设这就是服务器返回的 JSON 数据，内容是一个学生的信息。现在我们需要将该 JSON 字典转为方便开发的数据模型。

从这份 JSON 中可以看出，字典中取值除了字符串之外，还有数组和字典。那么在将字典转换成数据模型的时候，就要考虑 模型嵌套模型、模型嵌套模型数组 的情况了。具体步骤如下：

3.3.1 创建模型

经过分析，我们总共需要三个模型： XXStudentModel、XXAdressModel、XXCourseModel。

| | |

3.3.2 在 NSObject 分类中实现字典转模型

细心的你可能已经发现：上面的 XXStudentModel.h 文件中导入了 #import "NSObject+XXModel.h" 文件，并且遵循了 协议，并且在 XXStudentModel.m 文件中实现了协议的 + (NSDictionary *)modelContainerPropertyGenericClass 方法。

NSObject+XXModel.h、NSObject+XXModel.m 就是我们用来解决字典转模型所创建的分类，协议中的 + (NSDictionary *)modelContainerPropertyGenericClass 方法用来告诉分类特殊字段的处理规则，比如 id --> uid。

| | |

| | |

3.3.3 测试代码

| | |

效果如下：

image

当然，如若需要考虑缓存机制、性能问题、对象类型检查等，建议还是使用例如 YYModel 之类的知名第三方框架，或者自己造轮子。

---

3.4 改进 iOS 归档和解档

『归档』是一种常用的轻量型文件存储方式，在项目中，如果需要将数据模型本地化存储，一般就会用到归档和解档。但是如果数据模型中有多个属性的话，我们不得不对每个属性进行处理，这个过程非常繁琐。

这里我们可以参考之前『字典转模型』 的代码。通过 Runtime 获取类的属性列表，实现自动归档和解档。归档操作和解档操作主要会用到了两个方法： encodeObject: forKey: 和 decodeObjectForKey:。

首先在 NSObject 的分类 NSObject+XXModel.h、NSObject+XXModel.m 中添加以下代码：

| | |

然后在需要实现归档解档的模型中，添加 -initWithCoder: 和 -encodeWithCoder: 方法。

| | |

测试一下归档解档代码：

| | |

当然，上边代码只是演示一下 Runtime 对于归档和解档的优化，真正用在开发中的逻辑远比上边的样例要负责，具体也参考 YYModel 的实现。