Runtime结合description自动输出模型全部属性

不知不觉从iOS转到Android开发已经一年了，由于业务需求现在又开始回到iOS开发来，挺好的，我个人还是比较钟情iOS开发，简洁高效。

在Android开发过程中，可以使用IDE提供的快捷方式覆盖toString方法并且自动拼接该类的所有属性，例如：

public class User {
   public static final int ROLE_OTHER = 0;
   public static final int ROLE_VOLUNTEER = 1;
   public String phone_number;
   public String avatar; 
   public int userRole;
   public ArrayList<CardInfo> cards;

   @Override
   public String toString() {
      return "User phone_number=" + phone_number + ",avatar=" + avatar + ",userRole=" + userRole;
   }
}

在iOS中与toString( )相同功能的方法是description( )，该方法是NSObject类中的一个成员方法，返回一个描述该类对象的特征的字符串。

所以我们可以通过覆盖description( )来打印出对象的所有属性，这个时候就有两个问题

1. 如何拿到模型的所有属性？
2. 如何获取属性对应的值？

实现起来并不难，获取模型的所有属性可以通过runtime，获取属性对应的值可以通过KVC，所以我们覆盖的description( )如下

-(NSString *)description{
    NSString *className = [NSString stringWithUTF8String:class_getName([self class])];
    NSMutableString *logM = [NSMutableString stringWithString:className];
    [logM appendString:[NSString stringWithFormat:@"<%p>",self]];
    [logM appendString:@" ["];
    unsigned int count;
    Ivar *ivars = class_copyIvarList([self class], &count);
    for (int i = 0; i < count ; i++) {
        //取出成员变量(就是结构体)
        Ivar ivar = ivars[i];
        //取出成员变量的名称
        NSMutableString *name = [NSMutableString stringWithUTF8String:ivar_getName(ivar)];
        //通过KVC获取变量对应的值
        id value = [self valueForKey:name];
        [name deleteCharactersInRange:NSMakeRange(0, 1)];
        [logM appendString:name];
        [logM appendString:@"="];
        [logM appendString:[NSString stringWithFormat:@"%@",value]];
        [logM appendString:@", "];
    }
    NSUInteger length = logM.length;
    [logM deleteCharactersInRange:NSMakeRange(length - 2, 2)];
    [logM appendString:@"]"];
    
    return logM;
}

log的格式便如下所示
2016-11-28 21:06:32.063 Transfrom2016[21582:2973176] MGAccount<0x600000223f80> [age=18, name=Mango]

通过代码，我们可以发现此段代码适用于任何模型，所以我们并不满足于重复造轮子，于是有什么方法可以让我们的代码只写一次，然后处处生效呢？
答案就是分类！
新建一个基础模型类，然后新建一个该模型类的分类，覆盖其父类的descrption( )，方法体为上面descrption( )的代码即可。
具体代码如下：

#import <Foundation/Foundation.h>

@interface MGBaseModel (Desc)

@end

#import "MGBaseModel+Desc.h"
#import <objc/runtime.h>

@implementation MGBaseModel (Desc)
-(NSString *)description{
    NSString *className = [NSString stringWithUTF8String:class_getName([self class])];
    NSMutableString *logM = [NSMutableString stringWithString:className];
    [logM appendString:[NSString stringWithFormat:@"<%p>",self]];
    [logM appendString:@" ["];
    unsigned int count;
    Ivar *ivars = class_copyIvarList([self class], &count);
    for (int i = 0; i < count ; i++) {
        //取出成员变量(就是结构体)
        Ivar ivar = ivars[i];
        //取出成员变量的名称
        NSMutableString *name = [NSMutableString stringWithUTF8String:ivar_getName(ivar)];
        //通过KVC获取变量对应的值
        id value = [self valueForKey:name];
        [name deleteCharactersInRange:NSMakeRange(0, 1)];
        [logM appendString:name];
        [logM appendString:@"="];
        [logM appendString:[NSString stringWithFormat:@"%@",value]];
        [logM appendString:@", "];
    }
    NSUInteger length = logM.length;
    [logM deleteCharactersInRange:NSMakeRange(length - 2, 2)];
    [logM appendString:@"]"];
    return logM;
}
@end

强调一下，是新建一个模型基类(可以无任何属性)，以后所有模型都继承自该类即可，不推荐直接创建一个NSObject的分类，因为刚才测试通知的时候出现消息栈溢出，根本原因是NSObject是所有OC类的父类，导致每次Log输出都会遍历属性树，增大内存开销，并且消息栈可能溢出(循环调用的情况下)

以上便是通过运行时结合KVC以及OC分类的概念实现的拼接模型所有属性的实现过程。当然，这只是runtime的冰山一角，个人觉得运行时机制是一种艺术，再配合OC这门动态语言，就感觉有无限可能。