(十七)[OC高效系列]为你的模型对象加上description方法

1.为什么要为你的模型对象加上description方法

比如类Person

@interface Person : NSObject
@property (nonatomic,copy) NSString *name;
@property (nonatomic,assign) int  age;
@property (nonatomic,strong) NSDate *birthday;
@end

@implementation Person
@end

我们平时将它的一个对象打印

Person *p = [[Person alloc] init];
p.name = @"aaa";
p.birthday = [NSDate date];
p.age = 18;
NSLog(@"%@",p);

然而打印的结果，却并不是我们想要的，我们更想要打印其中的各个属性的值

2016-08-16 11:38:27.860 Demo[30316:1805760] <Person: 0x7ff84b811ae0>

所以我们可以实现description方法


@implementation Person
-(NSString *)description{
    return [NSString stringWithFormat:@"name : %@ age : %d ,birthday : %@",self.name,self.age,self.birthday];
}
@end

这样打印的结果如下

2016-08-16 11:53:06.024 Demo[31045:1826418] 
name : aaa age : 18 ,birthday : 2016-08-16 03:53:06 +0000

看起来更加清晰了

2.使用NSDictionary来辅助实现description

也许description方法可以这样实现

@implementation Person
-(NSString *)description{
    NSMutableDictionary *properties  = [NSMutableDictionary dictionary];
    properties[@"name"] = self.name;
    properties[@"age"] = [NSNumber numberWithInt:self.age];
    properties[@"birthday"] = self.birthday;
    return [NSString stringWithFormat:@"%@",properties];
}
@end

这样打印出来就是这样

2016-08-16 11:59:14.195 Demo[31083:1830255] {
    age = 18;
    birthday = "2016-08-16 03:59:14 +0000";
    name = aaa;
}

打印的整洁，易看，而且还不用写那么多String的格式语句。

3.使用runtime辅助实现

虽然借助NSDictionary可以方便一点，但是当成员变量增多的时候仍然需要一个一个加入到字典中，比较麻烦。所以我们可以借助runtime自动遍历类中的所有属性


@implementation NSObject (YXParams)
- (NSDictionary *)keyValues
{
    NSMutableDictionary *props = [NSMutableDictionary dictionary];
    unsigned int outCount, i;
    objc_property_t *properties = class_copyPropertyList([self class], &outCount);
    
    NSDictionary *values;
    NSDictionary *propertyNames;
    if ([self respondsToSelector:@selector(paramsValueReplace)]) {
        values=[self paramsValueReplace];
    }
    if ([self respondsToSelector:@selector(paramsNamesReplace)]) {
        propertyNames=[self paramsNamesReplace];
    }
    for (i = 0; i<outCount; i++)
    {
        objc_property_t property = properties[i];
        const char* char_f =property_getName(property);
        NSString *propertyName = [NSString stringWithUTF8String:char_f];
        
        id propertyValue;
        if (values[propertyName]) {
            propertyValue=values[propertyName];
        }else{
            propertyValue= [self valueForKey:(NSString *)propertyName];
        }
        
        if (propertyNames[propertyName]) {
            propertyName=propertyNames[propertyName];
        }

        if (propertyValue) {
            [props setObject:propertyValue forKey:propertyName];
        }
    }
    free(properties);
    return props;
}
end

这样description方法就变为

@implementation Person
- (NSString *)description{
    return [NSString stringWithFormat:@"%@",[self keyValues]];
}
@end

这样是不是就很简单了?

4.防止无限递归

上面的方式虽然简单了，但是仍然会有问题，那就是当A有一个B的属性，B有一个A的属性的时候，调用A 或者 B的对象的打印，都会造成无限递归。比如:
Person:

@interface Person : NSObject
@property (nonatomic,copy) NSString *name;
@property (nonatomic,assign) int  age;
@property (nonatomic,strong) NSDate *birthday;
@property (nonatomic,weak) Tool *tool;
@end
@implementation Person
- (NSString *)description{
    return [NSString stringWithFormat:@"%@",[self keyValues]];
}
@end

Tool:

@interface Tool : NSObject
@property (nonatomic,copy) NSString *name;
@property (nonatomic,assign) float price;
@property (nonatomic,weak) Person *person;
@end
@implementation Tool
- (NSString *)description{
    return [NSString stringWithFormat:@"%@",[self keyValues]];
}
@end

调用场景

Person *p = [[Person alloc] init];
p.name = @"aaa";
p.birthday = [NSDate date];
p.age = 18;
Tool *tool = [[Tool alloc] init];
tool.name = @"锤子";
tool.price = 11;
tool.person = p;
p.tool = tool;
NSLog(@"%@",p);

这样就会出现如下的递归错误:


递归错误

怎么解决呢？

5.在使用runtime获取属性的时候，进行过滤

这样keyValues方法就要改成如下的形式，通过一个block进行过滤

- (NSDictionary *)keyValuesWithFilter:(BOOL(^)(NSString *propertyName,id value))filter
{
    NSMutableDictionary *props = [NSMutableDictionary dictionary];
    unsigned int outCount, i;
    objc_property_t *properties = class_copyPropertyList([self class], &outCount);
    
    NSDictionary *values;
    NSDictionary *propertyNames;
    if ([self respondsToSelector:@selector(paramsValueReplace)]) {
        values=[self paramsValueReplace];
    }
    if ([self respondsToSelector:@selector(paramsNamesReplace)]) {
        propertyNames=[self paramsNamesReplace];
    }
    for (i = 0; i<outCount; i++)
    {
        objc_property_t property = properties[i];
        const char* char_f =property_getName(property);
        NSString *propertyName = [NSString stringWithUTF8String:char_f];
        
        id propertyValue;
        if (values[propertyName]) {
            propertyValue=values[propertyName];
        }else{
            propertyValue= [self valueForKey:(NSString *)propertyName];
        }
        
        if (propertyNames[propertyName]) {
            propertyName=propertyNames[propertyName];
        }
        
        if (propertyValue) {
            //在此处利用block过滤一下
            if(filter(propertyName,propertyValue))
                [props setObject:propertyValue forKey:propertyName];
        }
    }
    free(properties);
    return props;
}

我们只需要把其中一个对象的description方法变成如下形式就好了,比如tool:

@implementation Tool
- (NSString *)description{
    return [NSString stringWithFormat:@"%@",[self keyValuesWithFilter:^BOOL(NSString *propertyName, id value) {
        if([value isKindOfClass:[Person class]]){
            Person *p = (Person *)value;
            if(p.tool == self){
                return NO;
            }
        }
        return YES;
    }]];
}
@end

这样打印就不会出现无线递归错误了。

6.使用xCodeGenerateDescriptionPlugin插件自动生成description方法

上面的方法，我们还可以使用插件自动为类生成description方法

Github地址

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,456评论 5赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,370评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,337评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,583评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,596评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,572评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,936评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,595评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,850评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,371评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,951评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2赞 342

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,398评论 25赞 707
  • 目标管理培训方案
    很多时候，目标是指引我们完成的重要方向，确定好目标，我们就有做事的动力了。那么，在工作中我们应该如何做好目标管理，...
    Eggyino阅读 627评论 0赞 2
  • 以科研的姿态学做菜
    有些技能一旦学会，一辈子忘不了。比如语言，游泳，骑自行车，厨艺……这些技能投入产出比极高，必须要学。 今天...
    牛粪茶壶阅读 3,109评论 5赞 30