Що таке еквівалент Swift - [опис NSObject]?

У Objective-C можна додати descriptionметод до свого класу, щоб допомогти у налагодженні:

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

Потім у відладчику ви можете:

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

Який еквівалент у Свіфті? Вихід з відмови від Свіфта може бути корисним:

  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

Чи є кращий спосіб?

Для реалізації цього типу типу 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".

Приклад використання 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протоколам.

Просто використовуйте CustomStringConvertibleіvar description: String { return "Some string" }

працює в бета-версії Xcode 7.0

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))"
}

Відповіді, що стосуються, 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!"

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

Як описано тут , ви також можете використовувати можливості відображення 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
    }
}

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