介绍

- (NSString*)description
{
   😱 😱 😱 ⌛️⌛️⌛️
}

写描述方法很无聊，每次修改类都要更新，更无聊的是要保持其更新。但是好的描述可以改善你的调试质量...还可以节省你的时间！

🎉别担心！现在是时候让AGCDescription为你做脏活了！🎉

AGCDescription是NSObject的一个分类，它使用Objective-c运行时特性来自动构建任何类描述字符串。如果你更改了类，描述将自动更新。

示例

给定一个代表用户的简单类

@interface AGCUser : NSObject

- (instancetype)initWithUserId:(NSNumber*)userId username:(NSString*)username password:(NSString*)password userImage:(UIImage*)userImage;

@property (nonatomic, strong) NSNumber* userId;
@property (nonatomic, copy) NSString* username;
@property (nonatomic, copy) NSString* password;
@property (nonatomic, strong) UIImage* userImage;

转到实现文件，导入分类

#import "NSObject+AGCDescription.h"

并将AGCDescription代理到返回描述字符串

- (NSString*)description
{
  return [self agc_description];
}

- (NSString*)debugDescription
{
  return [self agc_debugDescription];
}

这就完成了。很简单，不是吗？现在让我们打印用户的描述来查看结果

AGCUser* agcUser = [[AGCUser alloc] initWithUserId:@(123) username:@"Mick Jagger" password:@"angie123" userImage:[UIImage imageNamed:@"mick.png"]];
NSLog(@"%@",agcUser);

将输出以下内容

<AGCUser:
{
userId = 123;
username = Mick Jagger;
password = angie123;
userImage = <UIImage: 0x7faa7a5fb170>, {140, 154};
}>

😎😎😎

示例细节

而且不仅如此！假设几天后你决定用户应该还有电子邮件地址属性。你把它添加到你的类中

@property (nonatomic, copy) NSString* emailAddress;
//...
[agcUser setEmailAddress:@"[email protected]]

并且你不需要更改你的代码！描述将自动更新 - 如果删除或重命名属性，描述也会自动更新。

<AGCUser:
{
userId = 123;
username = Mick Jagger;
password = angie123;
userImage = <UIImage: 0x7faa7a5fb170>, {140, 154};
emailAddress = [email protected]
}>

如果你不想记录用户的密码？或者你只想忽略那些对描述没有影响的属性（例如，用户图像），请使用agc_descriptionIgnoringPropertiesWithNames方法

- (NSString*)description
{
  return [self agc_descriptionIgnoringPropertiesWithNames:@[@"password",@"userImage"]];
}

这样你就可以保护你的秘密了😉

<AGCUser:
{
userId = 123;
username = Mick Jagger;
emailAddress = [email protected]
}>

AGCDescription规则

让我们看看AGCDescription是如何构建描述字符串的

格式是

<$ClassName:
{
$firstPropertyName = $firstPropertyValue;
...
$lastPropertyName = $lastPropertyValue;
}>    

• 属性按照你在代码中声明的顺序排列
• 默认情况下，以下属性会被忽略：hash, description, debugDescription

有时属性值过长，无法放入描述中。在这种情况下，使用所谓的“简短描述”，其基本格式如下

<$ClassName: $objectAddress>

以下是评估属性值的规则

• 如果一个属性是原始数据类型或具有已知简短描述的Foundation对象，则将打印其描述作为值
• 如果一个属性类似一个自定义类，则打印其简短描述
• 如果该属性是集合，则打印集合中的所有对象
  • 如果这些对象中有一个是自定义类，则打印其简短描述
  • 如果这些对象中有一个是另一个集合，则打印该集合的简短描述

用法

要运行示例项目，首先从示例目录克隆仓库，然后运行 pod install

要求

iOS 8+ 和 ARC

安装

AGCDescription 可以通过 CocoaPods 获取。要安装它，只需将以下行添加到您的 Podfile 中

pod "AGCDescription"

作者

Andrea Cipriani, [email protected] - Twitter @AndreaCipriani

许可

AGCDescription 在 MIT 许可下可用。有关更多信息，请参阅 LICENSE 文件。