Swift debug 利器 - dump

今天偶然发现一个debug利器- dump

什么是dump呢？

文档里的解释是：

Dumps an object’s contents using its mirror to standard output

翻译过来意思是 object的内容用其镜像进行标准输出，也就是通过反射输出object的内容。

我们先看看这个方法的结构，官方文档并没有对参数的说明，所以这里我补充了一下：

/*
* - T：是要打印的参数，是一个范型，也就是支持输出各种类型
* - name： 默认是空白，如果加上则会在打印内容前加入这个name
* - indent：缩进，默认是0，如果设置则会向前缩进相应的空白
* - maxDepth：最大深度，默认全部打印，可以根据层级需要设置这个参数
* - maxItems：最大条数，默认是全部打印，如果需要限制内容，可以设置这个参数
*/
@discardableResult func dump<T>(_ value: T, 
                                   name: String? = default, 
                                 indent: Int= default, 
                               maxDepth: Int = default, 
                               maxItems: Int = default) -> T

下面是dump的几种使用场景：

打印array:

let names = ["apple", "orange", "banana"]
dump(names)

会输出

0 apple
1 orange
2 banana

我们看看print会输出什么

print(names)
["apple", "orange", "banana"]

打印dictionary：

let iPhones = ["iPhoneX": 9688, "iPhone8 plus": 7888, "iphone8": 6888]
dump(iPhones)

会输出

▿ 3 key/value pairs
  ▿ (2 elements)
    - key: "iPhoneX"
    - value: 9688
  ▿ (2 elements)
    - key: "iphone8"
    - value: 6888
  ▿ (2 elements)
    - key: "iPhone8 plus"
    - value: 7888

使用print输出

print(iPhones)
["iPhoneX": 9688, "iphone8": 6888, "iPhone8 plus": 7888]

下面进行更个性化的输出

dump(iPhones, name: "iPhones' price", indent: 8, maxDepth: 1, maxItems: 2)

会输出

        ▿ iPhones' price: 3 key/value pairs
          ▹ (2 elements)
            (2 more children)

如果打印的内容太多或者需要进行个性化的打印的时候，可以灵活使用后面的参数。

在我们开发的过程中，怎样使用这个方法呢？

• 打印log的时候，可以取代print，打印更详细的内容
• 需要在控制台打印数组或者字典的时候，用dump输出的东西更立体，不会像print一样打印出来是一行，对于特别大的数组或者字典很好用
• debug的时候能直接打印出对象的信息，我们debug的时候常常会打断点，然后查看对象里的参数的值，用dump相当于把参数的那个界面全部展开并打印到了控制台上

有这么多好处，是不是跃跃欲试了呢？快去用用吧，如果有更好的使用心得，记得和我分享。

这篇文章参考了这个链接 并进行了一些补充，希望对你有所帮助，不要再一尘不变的print了。