iOS - description 用于打印出便于查看的log

今天在研究代码的时候,发现一个很有趣的函数,- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level 便研究了一下。

个人博客: https://linit.space

问题

比如我们有如下代码块

    TestObj *object = [[TestObj alloc] init];
    object.name1 = @"vname1";
    object.name2 = @"vname2";
    object.name3 = @"vname3";
    object.name4 = @"vname4";
      NSLog(@"%@",@[@"1",@"2",@{@"keyxx":@"value",@"key2":@"value2",@"key3":@{@"1":@"xxxx",@"dic":@{@"你好啊1":@"林某某!",@"你好啊2":@"林某某!",@"你好啊3":@"林某某!",@"你好啊4":@"林某某!",@"你好啊5":@"林某某!",@"你好啊6":@"林某某!",@"你好啊7":@"林某某!"},@"axaasx":@"3"},@"key4":@"value4"},@"3",object]);

打印的结果是

(
    1,
    2,
        {
        key2 = value2;
        key3 =         {
            1 = xxxx;
            axaasx = 3;
            dic =             {
                "\U4f60\U597d\U554a1" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a2" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a3" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a4" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a5" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a6" = "\U6797\U67d0\U67d0\Uff01";
                "\U4f60\U597d\U554a7" = "\U6797\U67d0\U67d0\Uff01";
            };
        };
        key4 = value4;
        keyxx = value;
    },
    3,
    "<TestObj: 0x7fb7fbc71520>"
)

中文直接用unicode编码打印出,自定义类的内容也不明确,导致查看的非常的不方便。

解决方案

实现description开头方法,为了更加使得打印结果更有格式,所以实现- (NSString )descriptionWithLocale:(id)locale indent:(NSUInteger)level。
==
*注:优先级 - (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level > - (NSString *)description ,所以,例如NSDictionary,NSArray等,已经实现了- (NSString )descriptionWithLocale:(id)locale indent:(NSUInteger)level此方法,所以如果实现- (NSString )description则没有效果。==

原理

在使用NSObject类替换%@占位符时,会调用description相关方法,所以只要实现此方法,就可以起到修改打印内容的作用。因此对于系统的类,才用增加分类的方式实现,而自己的类,就是增加方法。

代码实现

#import <objc/runtime.h>
@interface TestObj : NSObject
@property (nonatomic, copy)NSString *name1;
@property (nonatomic, copy)NSString *name2;
@property (nonatomic, copy)NSString *name3;
@property (nonatomic, copy)NSString *name4;
@end

@implementation TestObj

- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level
{
    NSMutableString *mStr = [NSMutableString string];
    NSMutableString *tab = [NSMutableString stringWithString:@""];
    for (int i = 0; i < level; i++) {
        [tab appendString:@"\t"];
    }
    [mStr appendFormat:@"<%@ = {\n",NSStringFromClass(self.class)];
    
    unsigned int outCount;
    objc_property_t *properties = class_copyPropertyList([self class], &outCount);
    for (int i = 0; i < outCount; i++)
    {
        objc_property_t property = properties[i];
        const char *charProperty = property_getName(property);
        NSString *propertyName = [NSString stringWithUTF8String:charProperty];
        if (propertyName) {
            id propertyValue = [self valueForKey:propertyName];
            NSString *lastSymbol = (outCount == i + 1) ? @"":@";";
            if ([propertyValue respondsToSelector:@selector(descriptionWithLocale:indent:)]) {
                [mStr appendFormat:@"\t%@%@ = %@%@\n",tab,propertyName,[propertyValue descriptionWithLocale:locale indent:level + 1],lastSymbol];
            } else {
                [mStr appendFormat:@"\t%@%@ = %@%@\n",tab,propertyName,propertyValue,lastSymbol];
            }
        }
    }
    free(properties);
    [mStr appendFormat:@"%@}>",tab];
    return mStr;
}

@end

@implementation NSDictionary (myTest)


- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level
{
    NSMutableString *mStr = [NSMutableString string];
    NSMutableString *tab = [NSMutableString stringWithString:@""];
    for (int i = 0; i < level; i++) {
        [tab appendString:@"\t"];
    }
    [mStr appendString:@"{\n"];
    NSArray *allKey = self.allKeys;
    for (int i = 0; i < allKey.count; i++) {
        id value = self[allKey[i]];
        NSString *lastSymbol = (allKey.count == i + 1) ? @"":@";";
        if ([value respondsToSelector:@selector(descriptionWithLocale:indent:)]) {
            [mStr appendFormat:@"\t%@%@ = %@%@\n",tab,allKey[i],[value descriptionWithLocale:locale indent:level + 1],lastSymbol];
        } else {
            [mStr appendFormat:@"\t%@%@ = %@%@\n",tab,allKey[i],value,lastSymbol];
        }
    }
    [mStr appendFormat:@"%@}",tab];
    return mStr;
}
@end


@implementation NSArray (myTest)

- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level
{
    NSMutableString *mStr = [NSMutableString string];
    NSMutableString *tab = [NSMutableString stringWithString:@""];
    for (int i = 0; i < level; i++) {
        [tab appendString:@"\t"];
    }
    [mStr appendString:@"(\n"];
    for (int i = 0; i < self.count; i++) {
         NSString *lastSymbol = (self.count == i + 1) ? @"":@",";
        id value = self[i];
        if ([value respondsToSelector:@selector(descriptionWithLocale:indent:)]) {
            [mStr appendFormat:@"\t%@%@%@\n",tab,[value descriptionWithLocale:locale indent:level + 1],lastSymbol];
        } else {
            [mStr appendFormat:@"\t%@%@%@\n",tab,value,lastSymbol];
        }
    }
    [mStr appendFormat:@"%@)",tab];
    return mStr;
}

@end

结果

(
    1,
    2,
    {
        keyxx = value;
        key3 = {
            1 = xxxx;
            dic = {
                你好啊2 = 林某某!;
                你好啊6 = 林某某!;
                你好啊3 = 林某某!;
                你好啊7 = 林某某!;
                你好啊4 = 林某某!;
                你好啊1 = 林某某!;
                你好啊5 = 林某某!
            };
            axaasx = 3
        };
        key4 = value4;
        key2 = value2
    },
    3,
    <TestObj = {
        name1 = vname1;
        name2 = vname2;
        name3 = vname3;
        name4 = vname4
    }>
)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,478评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,825评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,482评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,726评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,633评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,018评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,168评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,320评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,264评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,288评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,995评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,587评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,909评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,284评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,862评论 2 339

推荐阅读更多精彩内容