Общий метод описания Objective-C для печати значений ivar

Question

В Objective-C принято переопределять -description с методом, который печатает идентификатор объекта и имена / значения переменных экземпляра. Я хотел бы сделать общий -description метод, который делает это с помощью самоанализа, а не вручную, для каждого класса. Я хотел бы, чтобы результат был примерно таким:

<ClassName: 0x??????, ivar1: value1, ivar2: value2, ivar3: value3, ...>

Также было бы неплохо отсортировать по имени переменной экземпляра (чтобы они всегда были в одинаковом порядке). Наконец, если это можно было бы отнести к категории, безопасно переопределяющей NSObject функциональность, это было бы идеально (но я вижу, что это не так просто, как NSObject.m есть предупреждение об использовании -[NSString stringWithFormat:] в -description).

Answer 1

Это большой вопрос! Поскольку я не нашел ничего подобного, я написал небольшую функцию, которая сделает это за вас. Заменяет - (NSString *)description из NSObject используя метод swizzling (да, я - это зло. MAHAHAHAHAHahahahaha) и печатает ивар в порядке их появления в классе (вы можете легко редактировать его, отображая в алфавитном порядке).

DO NOT! забудь позвонить NSObjectSwizzleDescription()!

.h файл:

@interface NSObject (JSObjectAdditions)
@end


void NSObjectSwizzleDescription();

.m файл:

#import <objc/objc.h>
#import "JSObject.h"

@implementation NSObject (JSObjectAdditions)

- (NSString *)verboseDescription
{
    NSMutableString *description = [NSMutableString stringWithFormat:@"<%@: %p>", NSStringFromClass([self class]), self];

    uint32_t ivarCount;
    Ivar *ivars = class_copyIvarList([self class], &ivarCount);

    if(ivars)
    {
        [description appendString:@"\n{"];

        for(uint32_t i=0; i<ivarCount; i++)
        {
            Ivar ivar = ivars[i];
            const char *ivarType = ivar_getTypeEncoding(ivar);
            id ivarObject = object_getIvar(self, ivar);

            [description appendFormat:@"\n   %s: ", ivar_getName(ivar)];

            // Default signed data types
            if(strcmp(ivarType, "c") == 0)
            {
                char character = (char)ivarObject;
                [description appendFormat:@"'%c'", character];
            }
            else if(strcmp(ivarType, "i") == 0 || strcmp(ivarType, "l") == 0) // l is also 32 bit in the 64 bit runtime environment
            {
                int integer = (int)ivarObject;
                [description appendFormat:@"%i", integer];
            }
            else if(strcmp(ivarType, "s") == 0)
            {
                short shortVal = (short)ivarObject;
                [description appendFormat:@"%i", (int)shortVal];
            }
            else if(strcmp(ivarType, "q") == 0)
            {
                long long longVal = (long long)ivarObject;
                [description appendFormat:@"%l", longVal];
            }
            // Default unsigned data types
            else if(strcmp(ivarType, "C") == 0)
            {
                unsigned char chracter = (unsigned char)ivarObject;
                [description appendFormat:@"'%c'", chracter];
            }
            else if(strcmp(ivarType, "I") == 0 || strcmp(ivarType, "L") == 0)
            {
                unsigned int integer = (unsigned int)ivarObject;
                [description appendFormat:@"%u", integer];
            }
            else if(strcmp(ivarType, "S") == 0)
            {
                unsigned short shortVal = (unsigned short)ivarObject;
                [description appendFormat:@"%i", (int)shortVal];
            }
            else if(strcmp(ivarType, "Q") == 0)
            {
                unsigned long long longVal = (unsigned long long)ivarObject;
                [description appendFormat:@"%ll", longVal];
            }
            // Floats'n'stuff
            else if(strcmp(ivarType, "f") == 0)
            {
                float floatVal;
                memcpy(&floatVal, &ivarObject, sizeof(float));

                [description appendFormat:@"%f", floatVal];
            }
            else if(strcmp(ivarType, "d") == 0)
            {
                double doubleVal;
                memcpy(&doubleVal, &ivarObject, sizeof(double));

                [description appendFormat:@"%f", doubleVal];
            }
            // Boolean and pointer
            else if(strcmp(ivarType, "B") == 0)
            {
                BOOL booleanVal = (BOOL)ivarObject;
                [description appendFormat:@"%@", (booleanVal ? @"YES" : @"NO")];
            }
            else if(strcmp(ivarType, "v") == 0)
            {
                void *pointer = (void *)ivarObject;
                [description appendFormat:@"%p", pointer];
            }
            else if(strcmp(ivarType, "*") == 0 || strcmp(ivarType, ":") == 0) // SEL is just a typecast for a cstring
            {
                char *cstring = (char *)ivarObject;
                [description appendFormat:@"\"%s\"", cstring];
            }
            else if(strncmp(ivarType, "@", 1) == 0)
            {
                [description appendFormat:@"%@", ivarObject];
            }
            else if(strcmp(ivarType, "#") == 0)
            {
                Class objcClass = (Class)ivarObject;
                [description appendFormat:@"%s", class_getName(objcClass)];
            }
            else
                [description appendString:@"???"];
        }

        [description appendString:@"\n}"];
        free(ivars);
    }

    return description; 
}

@end


void NSObjectSwizzleDescription()
{
    Method origMethod = class_getInstanceMethod([NSObject class], @selector(description));
    Method newMethod = class_getInstanceMethod([NSObject class], @selector(verboseDescription));

    method_exchangeImplementations(origMethod, newMethod);
}

Answer 2

Я не знаю ни одного кода, делающего это, но если он существует, я был бы заинтересован в целях отладки!

Я удивлен, что еще не нашел ничего подобного, классические техники просто работают, но было бы неплохо иметь какую-то inspect метод, который, я думаю, возможен с помощью рефлексии, но, возможно, я ошибаюсь.

Я бы посоветовал взглянуть на этот интересный пост, который связан с тем, что вы ищете, и может послужить основой для его реализации.

Еще одна интересная вещь также NSLogger, который является хорошим инструментом для отладки.