自动格式化打印变量HMLog介绍

mao2020
1,038 阅读6分钟

前言

在我初学iOS的时候，经常需要NSLog打印用于调试，有时候还需要打印多个变量：

NSLog(@"xxxx frame=%@ tag=%ld isHidden=%d", NSStringFromCGRect(view.frame), view.tag, view.isHidden);

仅考虑把NSLog用来调试输出，那写种代码就太麻烦了，主要存在着这样几个问题：

  • 需要格式化，如%@，%ld，%d
  • 需要设置标签，以便知道输出值对应的变量，如frame=，tag=，isHidden=
  • 需要类型转换，如NSStringFromCGRect
  • 有时候还需要写一些指定字符串以便于在Console输出中搜索或过滤，如xxxx

后来接触到各种各样的Debug Log，主要利用__LINE__和__func__可以很方便定位到输出的位置，但是依然还存在前面3个问题。另外LLDB可以很方便获取变量值，但在变量较多或需要连续打印的情况下也不够方便快捷。
那个时候我就产生了一个想法，能不能自己写一个Debug Log，解决上面这些困扰我的问题？这就是我开发HMLog的初衷，源码仅有一个HMLog.h文件。

基本用法

项目源码及demo：github.com/chenhuimao/…

以下用法均可在HMLogDemo项目中找到。

HMLog

HMLog最终是基于NSLog输出，根据前面的例子，使用HMLog的代码和输出是这样的：

UIView *view = [[UIView alloc] initWithFrame:CGRectMake(10, 20, 30, 40)];
view.tag = 333;
HMLog(view.frame);
HMLog(view.frame, view.tag, view.isHidden);

// 输出如下
// 2020-10-17 15:49:33.356890+0800 HMLogDemo[85956:1573131] 
// ================  -[ViewController viewDidLoad] [45]  ================
// 0: view.frame = NSRect: {{10, 20}, {30, 40}}
// 2020-10-17 15:49:33.357017+0800 HMLogDemo[85956:1573131] 
// ================  -[ViewController viewDidLoad] [46]  ================
// 0: view.frame = NSRect: {{10, 20}, {30, 40}}
// 1: view.tag = 333
// 2: view.isHidden = NO

Demo中的一个例子，用截图展示： example

HMPrint

HMPrint则基于printf：

UIView *view = [[UIView alloc] initWithFrame:CGRectMake(10, 20, 30, 40)];
view.tag = 333;
HMPrint(view.frame);
HMPrint(view.frame, view.tag, view.isHidden);

// 输出如下
// ================  -[ViewController viewDidLoad] [45]  ================
// 0: view.frame = NSRect: {{10, 20}, {30, 40}}
// 
// ================  -[ViewController viewDidLoad] [46]  ================
// 0: view.frame = NSRect: {{10, 20}, {30, 40}}
// 1: view.tag = 333
// 2: view.isHidden = NO

HMFormatString

如果只是需要自动格式化的目标字符串，可以使用HMFormatString：

self.displayLab.text = HMFormatString(self.view.frame, self.view.tag, @selector(viewDidLoad));
printf("%s", self.displayLab.text.UTF8String);

// ================  -[ViewController getFormatString1] [80]  ================
// 0: self.view.frame = NSRect: {{0, 0}, {414, 896}}
// 1: self.view.tag = 0
// 2: @selector(viewDidLoad) = SEL: viewDidLoad

可选参数

所有可选参数都应该在#import "HMLog.h"之前定义好

HMLogEnable / HMPrintEnable

分别控制HMLog和HMPrint的是否生效，默认生效，不生效情况下调用没有任何效果。如只需要在Debug模式下开启HMPrint：

// Only enable HMPrint in Debug configuration
#ifdef DEBUG
#define HMPrintEnable 1
#else
#define HMPrintEnable 0
#endif
#import "HMLog.h"

HMLogHeaderFormatString(FUNC, LINE)

控制头部字符串（注意可以重用FUNC和LINE，或者不使用）：

#define HMLogHeaderFormatString(FUNC, LINE) \
        [NSString stringWithFormat:@"%s  ?????  %s:\n", FUNC, FUNC]
#import "HMLog.h"
...

HMPrint(self.navigationItem.title);
HMPrint(self.view.bounds.size, self.view.alignmentRectInsets, self.title, self.automaticallyAdjustsScrollViewInsets, self.navigationController, [self class], @selector(viewDidAppear:));

// 输出如下
// -[ViewController print2]  ?????  -[ViewController print2]:
// 0: self.navigationItem.title = HMLogDemo
// 
// -[ViewController print2]  ?????  -[ViewController print2]:
// 0: self.view.bounds.size = NSSize: {414, 896}
// 1: self.view.alignmentRectInsets = {0, 0, 0, 0}
// 2: self.title = (null)
// 3: self.automaticallyAdjustsScrollViewInsets = YES
// 4: self.navigationController = <UINavigationController: 0x7fe108018400>
// 5: [self class] = ViewController
// 6: @selector(viewDidAppear:) = SEL: viewDidAppear:

HMLogPrefix(index, valueString)

控制每个变量输出的前缀。例如只需要展示下标，则按下面的方式定义：

// Only show index prefix
#define HMLogPrefix(index, valueString) [NSString stringWithFormat:@"%d: ", index]
#import "HMLog.h"
...

HMPrint(self.navigationItem.title);
HMPrint(self.view.bounds.size, self.view.alignmentRectInsets, self.title, self.automaticallyAdjustsScrollViewInsets, self.navigationController, [self class], @selector(viewDidAppear:));

// ================  -[ViewController print2] [79]  ================
// 0: HMLogDemo
// 
// ================  -[ViewController print2] [80]  ================
// 0: NSSize: {414, 896}
// 1: {0, 0, 0, 0}
// 2: (null)
// 3: YES
// 4: <UINavigationController: 0x7fab8c82be00>
// 5: ViewController
// 6: SEL: viewDidAppear:

HMLogTypeExtension

默认情况下不支持CGVector和CLLocationCoordinate2D类型，可以额外匹配需要格式化的类型：

#define HMLogTypeExtension \
        else if (strcmp(type, @encode(CGVector)) == 0) { \
            CGVector actual = (CGVector)va_arg(v, CGVector); \
            obj = NSStringFromCGVector(actual); \
        } else if (strcmp(type, @encode(CLLocationCoordinate2D)) == 0) { \
            CLLocationCoordinate2D actual = (CLLocationCoordinate2D)va_arg(v, CLLocationCoordinate2D); \
            obj = [NSString stringWithFormat:@"latitude: %lf, longitude: %lf", actual.latitude, actual.longitude]; \
        }

#import <CoreLocation/CoreLocation.h>
#import "HMLog.h"
...

CGVector vector = CGVectorMake(110, 119);
CLLocationCoordinate2D coordinate = CLLocationCoordinate2DMake(22.512145, 113.9155);
HMPrint(vector, coordinate);

// ================  -[CustomizeFormatViewController log] [65]  ================
// 0: vector = {110, 119}
// 1: coordinate = latitude: 22.512145, longitude: 113.915500

使用注意

  • 项目需要Foundation和UIKit框架。C语言标准为gnu99，Xcode项目的C Language Dialect选项设置为gnu99或gnu11
  • HMLog项目的实现仅有一个文件HMLog.h，可以在pch文件导入，也可以在每个需要的文件分别导入。所有可选参数都应该在#import "HMLog.h"之前定义好
  • 一次调用最多支持20个变量
  • 没有支持所有的数据类型，默认支持的类型参考源码，可以使用HMLogTypeExtension进行扩展

设计思路

只考虑1个变量

首先考虑1个变量的情况，即HMLog只能传入1个变量。

  1. 要格式化1个变量，就要先知道这个变量的类型。变量可以通过__typeof__获取类型，比如我们常常这样用__weak __typeof__(self) weakSelf = self;。

  2. 取得变量类型后，还需要比较判断，之后才能把id类型格式化为"%@"，把long类型格式化为"%ld"。类型如何做判断呢？if(long == id)显然是不行的，OC类型编码@encode会返回一个char *字符串，这样就可以利用strcmp函数做比较了：

    NSString *format;
if (strcmp(@encode(__typeof__(self.view)), @encode(id)) == 0) {
    format = @"%@";
} else if (strcmp(@encode(__typeof__(self.view)), @encode(long)) == 0) {
    format = @"%ld";
} else if ...

    参考苹果的文档，也可以写成if (strcmp(@encode(__typeof__(self.view)), "@") == 0)的形式。不过HMLog并没有采用这种简化的形式，@encode是编译器指令，并不影响运行时效率，上面的代码块中的形式更加直观。

  3. 要把这个功能写成一个通用函数，那如何表示任意的类型？换句话说，如果value是NSObject对象可以用id value表示，但如果value可能是任何类型，id该换成什么？这个时候，可变参数函数派上用场了，可变参数最后的...，是不需要写明数据类型的，这样可以把变量(value)和变量的类型编码@encode(__typeof__(value))同时传入进去，同时利用宏把一个变量替换为这两种形式：

    #define MyLog(value) _MyLog(__func__, __LINE__, @encode(__typeof__(value)), (value))

static void _MyLog(const char *func, int line, ...) {
    NSMutableString *result = [[NSMutableString alloc] init];
    [result appendFormat:@"\n===== %s [%d] =====\n", func, line];
    
    va_list v;
    va_start(v, line);
    char *type = va_arg(v, char *);
    if (strcmp(type, @encode(id)) == 0) {
        id actual = (id)va_arg(v, id);
        [result appendFormat:@"id: %@\n", actual];
    } else if (strcmp(type, @encode(long)) == 0) {
        long actual = (long)va_arg(v, long);
        [result appendFormat:@"long: %ld\n", actual];
    }
    va_end(v);
    NSLog(@"%@", result);
}

// 可以愉快地打印id和long类型了
MyLog(self.view);
MyLog(self.view.tag);

    把上面的例子的条件语句补充好需要的类型，MyLog宏就可以打印任意类型的1个变量了。

考虑多个变量

接下来要考虑的是如何同时打印多个变量。

  1. 按照前面的思路，打印多个变量，需要把每个变量(value)和变量的类型编码@encode(__typeof__(value))都传给可变参数函数_MyLog，另外还需要一个数量count表示一共有几组变量及其类型编码。为了实现这个需求，这里使用了获取宏参数个数以及递归宏的技巧，请阅读完这篇文章，了解C语言宏定义使用总结与递归宏。

  2. 最后补充好细节，使变量名称化为字符串作为提示标签，定制化使用的可选参数，这就完成了HMLog。

整体思路很清晰，源码也只有一个200多行的HMLog.h文件，难点基本上只有递归宏的使用。除此之外值得一提的还有两点：

  • float类型的值，通过va_arg获取值先传入double类型，然后再强制类型转换为float类型：float actual = (float)va_arg(v, double);，这是因为有个规则叫默认参数提升，还有一些char、short等类型也是如此。
  • [result appendFormat:@"%@%@\n", ((void)(valueString), HMLogPrefix(i, valueString)), obj];这行代码，为了消除宏HMLogPrefix(i, valueString)可能没有用到valueString导致的警告，使用了逗号运算符，这是宏定义使用中常用的一个运算符。

参考资料

avatar
文章
阅读
粉丝