Что такое эквивалент Swift -[NSObject description]?

Question

В Objective-C можно добавить description метод для их класса, чтобы помочь в отладке:

@implementation MyClass
- (NSString *)description
{
    return [NSString stringWithFormat:@"<%@: %p, foo = %@>", [self class], foo _foo];
}
@end

Затем в отладчике вы можете сделать:

po fooClass
<MyClass: 0x12938004, foo = "bar">

Что эквивалентно в Swift? Вывод REPL Swift может быть полезным:

  1> class MyClass { let foo = 42 }
  2> 
  3> let x = MyClass()
x: MyClass = {
  foo = 42
}

Но я хотел бы переопределить это поведение для печати на консоли:

  4> println("x = \(x)")
x = C11lldb_expr_07MyClass (has 1 child)

Есть ли способ убрать это println выход? Я видел Printable протокол:

/// This protocol should be adopted by types that wish to customize their
/// textual representation.  This textual representation is used when objects
/// are written to an `OutputStream`.
protocol Printable {
    var description: String { get }
}

Я подумал, что это будет автоматически "видно" println но это не похоже на случай:

  1> class MyClass: Printable {
  2.     let foo = 42
  3.     var description: String { get { return "MyClass, foo = \(foo)" } }
  4. }   
  5> 
  6> let x = MyClass()
x: MyClass = {
  foo = 42
}
  7> println("x = \(x)")
x = C11lldb_expr_07MyClass (has 1 child)

И вместо этого я должен явно вызвать описание:

 8> println("x = \(x.description)")
x = MyClass, foo = 42

Есть ли способ лучше?

Answer 1

Для реализации этого на типе Swift вы должны реализовать CustomStringConvertible протокол, а затем также реализовать свойство строки под названием description,

Например:

class MyClass: CustomStringConvertible {
    let foo = 42

    var description: String {
        return "<\(type(of: self)): foo = \(foo)>"
    }
}

print(MyClass()) // prints: <MyClass: foo = 42>

Замечания: type(of: self) получает тип текущих экземпляров вместо явного написания "MyClass".

Answer 2

Пример использования CustomStringConvertible а также CustomDebugStringConvertible протоколы в Swift:

PageContentViewController.swift

import UIKit

class PageContentViewController: UIViewController {

    var pageIndex : Int = 0

    override var description : String { 
        return "**** PageContentViewController\npageIndex equals \(pageIndex) ****\n" 
    }

    override var debugDescription : String { 
        return "---- PageContentViewController\npageIndex equals \(pageIndex) ----\n" 
    }

            ...
}

ViewController.swift

import UIKit

class ViewController: UIViewController
{

    /*
        Called after the controller's view is loaded into memory.
    */
    override func viewDidLoad() {
        super.viewDidLoad()

        let myPageContentViewController = self.storyboard!.instantiateViewControllerWithIdentifier("A") as! PageContentViewController
        print(myPageContentViewController)       
        print(myPageContentViewController.description)
        print(myPageContentViewController.debugDescription)
    }

          ...
}

Какой распечатать:

**** PageContentViewController
pageIndex equals 0 ****

**** PageContentViewController
pageIndex equals 0 ****

---- PageContentViewController
pageIndex equals 0 ----

Примечание: если у вас есть собственный класс, который не наследуется ни от какого класса, включенного в библиотеки UIKit или Foundation, то сделайте его наследником NSObject класс или заставить его соответствовать CustomStringConvertible а также CustomDebugStringConvertible протоколы.

Answer 3

Просто используйте CustomStringConvertible а также var description: String { return "Some string" }

работает в Xcode 7.0 beta

class MyClass: CustomStringConvertible {
  var string: String?


  var description: String {
     //return "MyClass \(string)"
     return "\(self.dynamicType)"
  }
}

var myClass = MyClass()  // this line outputs MyClass nil

// and of course 
print("\(myClass)")

// Use this newer versions of Xcode
var description: String {
    //return "MyClass \(string)"
    return "\(type(of: self))"
}

Answer 4

Ответы, касающиеся CustomStringConvertible путь Лично, чтобы сохранить определение класса (или структуры) как можно более чистым, я бы также выделил код описания в отдельное расширение:

class foo {
    // Just the basic foo class stuff.
    var bar = "Humbug!"
}

extension foo: CustomStringConvertible {
    var description: String {
        return bar
    }
}

let xmas = foo()
print(xmas)  // Prints "Humbug!"

Answer 5

Как описано здесь, вы также можете использовать возможности отражения Swift, чтобы ваши классы генерировали свое собственное описание, используя это расширение:

extension CustomStringConvertible {
    var description : String {
        var description: String = "\(type(of: self)){ "
        let selfMirror = Mirror(reflecting: self)
        for child in selfMirror.children {
            if let propertyName = child.label {
                description += "\(propertyName): \(child.value), "
            }
        }
        description = String(description.dropLast(2))
        description += " }"
        return description
    }
}

Answer 6

class SomeBaseClass: CustomStringConvertible {

    //private var string: String = "SomeBaseClass"

    var description: String {
        return "\(self.dynamicType)"
    }

    // Use this in newer versions of Xcode
    var description: String {
        return "\(type(of: self))"
    }

}

class SomeSubClass: SomeBaseClass {
    // If needed one can override description here

}


var mySomeBaseClass = SomeBaseClass()
// Outputs SomeBaseClass
var mySomeSubClass = SomeSubClass()
// Outputs SomeSubClass
var myOtherBaseClass = SomeSubClass()
// Outputs SomeSubClass

Answer 7

struct WorldPeace: CustomStringConvertible {
    let yearStart: Int
    let yearStop: Int

    var description: String {
        return "\(yearStart)-\(yearStop)"
    }
}

let wp = WorldPeace(yearStart: 2020, yearStop: 2040)
print("world peace: \(wp)")

// outputs:
// world peace: 2020-2040