[Swift Basic] - 생성된 객체를 print 메소드로 출력하기

🧑🏻‍💻 생성된 인스턴스의 Print 메소드 출력 결과물을 변경하기

• 스위프트 프로그래밍 책을 복습하며 무심코 넘어갔던 부분 중 궁금한 것이 생겨 테스트를 해봤습니다. 우선 아래는 책에 나오는 print 메소드에 대한 설명입니다.

  ...

  "print() 함수는 출력하려는 인스턴스의 description 프로퍼티에 해당하는 내용을 출력해주고, dump() 함수는 출력하려는 인스턴스의 자세한 내부 콘텐츠까지 출력해줍니다."

  ...

  이 구절에서 혹시 어떤 인스턴스가 description이란 이름의 프로퍼티를 갖게되면 무조건 그 값을 출력하는 지 궁금해져 실험을 해봤습니다. 우선 아래는 테스트를 위한 클래스와 그 인스턴스를 출력했을 때 일반적인 결과물 입니다.

  
  

  class Car {
      let name: String
  
      init(name: String) {
          self.name = name
      }
  }
  
  let bmw = Car(name: "bmw")
  let audi = Car(name: "Audi")
  
  print(bmw) // PrintMethod.Car
  print(audi) // PrintMethod.Car

  
  

  print 메소드의 결과물이 단순히 Car 인스턴스임을 표현해주기 때문에 서로 다른 인스턴스간 구별이 안될 뿐만아니라 원하는 정보를 충분히 얻을 수 없습니다. 이 때 dump를 하면 정보가 자세히 표현됩니다.

  
  

  dump(bmw)
  //▿ PrintMethod.Car #0
  //  - name: "bmw"
  dump(audi)
  // ▿ PrintMethod.Car #0
  //  - name: "Audi"

  
  

  이제 위에서 언급한 description을 테스트해보겠습니다.

  
  

• Car 클래스 내부에 description이라는 프로퍼티를 생성해주겠습니다.

  
  

  class Car {
      let name: String
  
      init(name: String) {
          self.name = name
      }
  
      var description: String {
          return self.name
      }
  }
  
  let bmw = Car(name: "bmw")
  print(bmw) // PrintMethod.Car

  
  

  description 프로퍼티를 생성해주었지만 출력 결과물에는 변화가 없었습니다. 단순히 설명을 위한 표현으로 description이란 표현을 한 것인지 궁금해서 공식문서에서 String을 검색했습니다.

  
  

  

  
  

  String은 description이란 프로퍼티를 갖고 있고, 이 description의 설명을 더 읽어보겠습니다.

  
  

  

  
  

  설명은 특별할 것이 없지만 가장 아래쪽에 보면 CustomStringConvertible을 채택하는 과정에서 생성되는 프로퍼티임을 알 수 있습니다. 이제 CustomStringConvertible을 보면

  
  

  

  
  

  위의 프로토콜을 채택한 타입은 인스턴스가 string으로 변환될 때 인스턴스 자신을 표현할 수 있는 representation을 제공한다고 되어 있습니다. 그래서 생성된 타입에 단순히 description 프로퍼티를 구현하는 것이 아니라 CustomStringConvertable을 채택한 후 프로퍼티를 구현했습니다.

  
  

  class Car: CustomStringConvertible {
      let name: String
  
      init(name: String) {
          self.name = name
      }
  
      var description: String {
          return self.name
      }
  }
  
  let bmw = Car(name: "bmw i8")
  let audi = Car(name: "audi a7")
  print(bmw) // bmw i8
  print(audi) // audi a7

📝 Sum Up

• 정리하면, print 메소드는 어떤 인스턴스의 description 프로퍼티를 출력해주는 것이 맞지만 단순히 description이란 이름의 프로퍼티만으로는 동작하지 않습니다. 해당 타입이 CustomStringConvertible을 채택하고, 그 프로토콜이 가진 description이란 프로퍼티를 구현한 상태에서 print 메소드가 그 description 프로퍼티를 출력합니다.

Ref

• https://developer.apple.com/documentation/swift/customstringconvertible

• 스위프트 프로그래밍 by 야곰