Swift CustomDebugStringConvertible用法及代码示例

CustomDebugStringConvertible

概述

Swift 为任何类型提供了默认的调试文本表示。 String(reflecting:) 初始值设定项和debugPrint(_:) 函数使用该默认表示，用于不提供自己的类型。要自定义该表示，请使您的类型符合CustomDebugStringConvertible 协议。

因为 String(reflecting:) 初始化程序适用于 any 类型的实例，如果传递的值符合 CustomDebugStringConvertible ，则返回实例的 debugDescription ，不鼓励直接访问类型的 debugDescription 属性或使用 CustomDebugStringConvertible 作为通用约束.

符合CustomDebugStringConvertible 协议

通过定义 debugDescription 属性，将 CustomDebugStringConvertible 一致性添加到您的自定义类型。

例如，这个自定义 Point 结构使用标准库提供的默认表示：

struct Point {
    let x: Int, y: Int
}


let p = Point(x: 21, y: 30)
print(String(reflecting: p))
// Prints "Point(x: 21, y: 30)"

通过实现debugDescription 属性添加CustomDebugStringConvertible 一致性后，Point 提供了自己的自定义调试表示。

extension Point: CustomDebugStringConvertible {
    var debugDescription: String {
        return "(\(x), \(y))"
    }
}


print(String(reflecting: p))
// Prints "(21, 30)"