调试器（或日志）中类似 NSDictionary 的漂亮打印

这已经困扰我一段时间了。如何抵消在调试器中转储对象时发生的丑陋转义po foo（或通过NSLog）。我尝试了多种方法来实施-description or -debugDescription无济于事。

鉴于这个简单的类

@interface Foo : NSObject
@property NSDictionary* dict;
@end

@implementation Foo
- (NSString *)description {
    // super.description for the <{classname} pointer> output
    return [NSString stringWithFormat:@"%@ %@", super.description, self.dict];
}
@end

以及人为的用法

Foo* f0 = [[Foo alloc] init];
f0.dict = @{ @"value": @0, @"next": NSNull.null };
Foo* f1 = [[Foo alloc] init];
f1.dict = @{ @"value": @1, @"next": f0 };
Foo* f2 = [[Foo alloc] init];
f2.dict = @{ @"value": @2, @"next": f1 };

我们得到了很好的输出f0

(lldb) po f0
<Foo: 0x8cbc410> {
    next = "<null>";
    value = 0;
}

容许输出f1

(lldb) po f1
<Foo: 0x8cbc480> {
    next = "<Foo: 0x8cbc410> {\n    next = \"<null>\";\n    value = 0;\n}";
    value = 1;
}

和可怕的输出f2

(lldb) po f2
<Foo: 0x8cbc4b0> {
    next = "<Foo: 0x8cbc480> {\n    next = \"<Foo: 0x8cbc410> {\\n    next = \\\"<null>\\\";\\n    value = 0;\\n}\";\n    value = 1;\n}";
    value = 2;
}

在调试现实世界的对象层次结构时，这很难快速解析。我假设自从转储类似的嵌套 NSDictionary 以来我还缺少一些其他技巧

NSDictionary* d0 = @{ @"value": @0, @"next": NSNull.null };
NSDictionary* d1 = @{ @"value": @1, @"next": d0 };
NSDictionary* d2 = @{ @"value": @2, @"next": d1 };

保持缩进并避免逃离地狱

(lldb) po d2
{
    next =     {
        next =         {
            next = "<null>";
            value = 0;
        };
        value = 1;
    };
    value = 2;
}

UPDATE

切换到-debugDescription并简单地转发到字典

@implementation Foo
- (NSString *)debugDescription {
    return self.dict.debugDescription;
}
@end

丢失递归输出

(lldb) po f2
{
    next = "<Foo: 0x8b70e20>";
    value = 2;
}

内部NSDictionary必须依靠-description我在这个例子中没有实现，只是-debugDescription。切换到类似下面的内容

@implementation Foo
- (NSString *)description {
    return self.dict.description;
}
- (NSString *)debugDescription {
    return self.dict.debugDescription;
}
@end

也会产生同样糟糕的输出

(lldb) po f2
{
    next = "{\n    next = \"{\\n    next = \\\"<null>\\\";\\n    value = 0;\\n}\";\n    value = 1;\n}";
    value = 2;
}

TL;DR;

Use NSContainers-PrettyPrint http://openradar.appspot.com/10765424并仔细地read https://github.com/NSError/NSContainers-PrettyPrint/blob/master/String-Tools.md the docs https://github.com/NSError/NSContainers-PrettyPrint/blob/master/Best-Practices.md.

长答案

经过更多搜索后我发现descriptionWithLocale:indent: https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSDictionary_Class/Reference/Reference.html#//apple_ref/occ/instm/NSDictionary/descriptionWithLocale:indent:方法。如文档所述，我应该能够在我自己的类中实现这一点，以实现所需的漂亮打印格式。然而，经过一些失败的尝试后，我发现了一个类似的问题 https://stackoverflow.com/questions/7521683/nsdictionary-description-formatting-problem-treats-structure-like-char-data。事实证明descriptionWithLocale:indent:仅当出于“安全考虑”而对 Foundation 容器类进行子类化时才有效。

对这种方法不满意，我继续挖掘并发现了这个radar http://openradar.appspot.com/10765424也是一个解决方案NSContainers-PrettyPrint https://github.com/NSError/NSContainers-PrettyPrint。经过一番尝试和错误后，我的工作进展顺利。 （它不在 CocoaPods 上，因此您必须手动添加）。

添加 NSContainers-PrettyPrint 后，您可能会想要JRSwizzle https://github.com/rentzsch/jrswizzle也。然后定义DEBUGPRINT_ALL and DEBUGPRINT_SWIZZLE在您的 DEBUG 目标预处理器宏中。最后，您可以实施您的descriptionWithLocale:indent:方面的方法fs_* 助手 https://github.com/NSError/NSContainers-PrettyPrint/blob/master/String-Tools.md and 最佳实践 https://github.com/NSError/NSContainers-PrettyPrint/blob/master/Best-Practices.md.

使用相同的Foo以我的问题为例

@implementation Foo
- (NSString*)description
{
    return [NSString stringWithFormat:@"%@ %@", super.description, self.dict.description];
}

- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level
{
    NSString * indent = [NSString fs_stringByFillingWithCharacter:' ' repeated:fspp_spacesPerIndent*level];
    NSMutableString * str = [[NSMutableString alloc] init];
    [str fs_appendObjectStartWithIndentString:indent caller:self];
    [str appendString:[self.dict descriptionWithLocale:locale indent:level+1]];
    [str fs_appendObjectEnd];
    return str;
}
@end

给出相同的情况下会产生以下输出f0, f1 and f2实例

(lldb) po f0
<Foo: 0x8a385c0> {
    value = 0;
    next = <null>;
}
(lldb) po f1
<Foo: 0x8a38630> {
    value = 1;
    next = <Foo:0x8a385c0        {
            value = 0;
            next = <null>;
        }>;
}
(lldb) po f2
<Foo: 0x8a38660> {
    value = 2;
    next = <Foo:0x8a38630        {
            value = 1;
            next = <Foo:0x8a385c0                {
                    value = 0;
                    next = <null>;
                }>;
        }>;
}

以上descriptionWithLocale:indent:可以使用一些调整来减少过多的空白，但它仍然胜过其他选择。