[iOS/Swift] 프로퍼티 래퍼(Property Wrapper)

안녕하세요?

너구리입니다ㅎㅎ

 

오늘은 프로퍼티 래퍼에 대해서 공부해보려고 하는데요.

요즘 SwiftUI를 사용하면서

@State나 @Binding 같은 친구들을 많이 사용하고 있는데

이 친구들 이름이 프로퍼티 래퍼여서 내용을 공부하면서 정리해보려 합니다.

 

그럼 바로 시작해볼게요!!

 

프로퍼티 래퍼(Property Wrapper)란?

---

프로퍼티 래퍼..

직관적으로 보면 프로퍼티를 감싸서 사용하는 느낌이네요

(감싸서 뭘 하겠다는거지...?)

 

공식문서에서 나오는 내용을 보면 

프로퍼티가 저장되는 방법을 관리하는 코드와 프로퍼티를 정의하는 코드 사이에 분리계층을 추가하고 이것을 재사용한다.

라고 나오는데

음... 감이 잘 안오네요..

 

코드를 사용해 보면서 더 알아보도록 할게요!

먼저 프로퍼티 래퍼를 정의해볼게요!!

 

프러퍼티 래퍼를 정의하기 위해서는 wrappedValue 프로퍼티를 정의한

구조체, 열거형이나 클래스를 만들어야 합니다.

 

음 그럼 항상 12이하인 수를 저장하는 프로퍼티 래퍼를 선언해볼게요!

@propertyWrapper
struct TwelveOrLess {
    private var number = 0
    var wrappedValue: Int {
        get { return number }
        set { number = min(newValue, 12) }
    }
}

먼저 @propertyWrapper 키워드를 사용해서 선언하고자 하는 구조체 앞에 붙여줍니다.

이후에 wrappedValue 프로퍼티를 정의하고 원하는 기능을 리턴하도록  코드를 작성해 주는거에요!

이때 number를 private로 선언해서 내부에서만 접근할 수 있도록 해줍니다.

 

 

그리고 정의한 프로퍼티 래퍼를 사용해 볼게요!

struct SmallRectangle {
    @TwelveOrLess var height: Int
    @TwelveOrLess var width: Int
}

var rectangle = SmallRectangle()
print(rectangle.height)
// Prints "0"

rectangle.height = 10
print(rectangle.height)
// Prints "10"

rectangle.height = 24
print(rectangle.height)
// Prints "12"

위에서 만들었던 프로퍼티 래퍼를 사용해서

직사각형의 가로 세로 길이를 프로퍼티로 가지는 구조체를 만들었는데요.

 

아래에 인스턴스의 height값을 확인해 보면

초기값을 출력하면 프로퍼티 래퍼의 초기값이 출력되고,

이후에 여러 값을 입력해 주었을 때

프로퍼티 래퍼의 setter에서 설정한 값을 출력하는 것을 볼 수 있어요!!

신기하네요ㅎㅎ

 

프로퍼티에 래퍼를 적용할 때 컴파일러가

래퍼가 사용하는 저장소 코드와 프로퍼티에 접근하는 코드를 합성한다고 합니다.

그래서 이런 과정이 가능한가봐요!

 

또 프로퍼티 래퍼를 사용하지 않더라도 

똑같이 기능을 구현할 수 있는데요!

 

바로 프로퍼티 래퍼로 선언한 구조체를 프로퍼티로 만들어주는거에요!!

그렇게 작성된 코드를 보실까요?

struct SmallRectangle {
    private var _height = TwelveOrLess()
    private var _width = TwelveOrLess()
    var height: Int {
        get { return _height.wrappedValue }
        set { _height.wrappedValue = newValue }
    }
    var width: Int {
        get { return _width.wrappedValue }
        set { _width.wrappedValue = newValue }
    }
}

이렇게 하면 원래 기능과 같은 기능을 수행합니다!!

height와 width의 get과 set은 _height와 _width의 wrappedValue에 접근하여

기능을 구현합니다.

저는 뭔가 프로퍼티 래퍼로 구현한게 더 끌리네요ㅎㅎ

 

또, 프로퍼티 래퍼를 구현할 때 내부의 프로퍼티가 초기화가 되어 있어야 하고

이 부분은 외부에서 바꿀 수 없는데요!

 

만약에 초기값을 외부에서 바꾸어 주고 싶다면 

init 메소드를 통해 바꿀 수 있으니 참고하시면 좋을 것 같습니다.

 

 

프로퍼티 래퍼에 값 투영

---

프로퍼티 래퍼에 값 투영...?

잘 이해 안되시죠?

 

좀더 쉽게 설명하면 프로퍼티 래퍼에서

추가적인 기능을 사용하여 추가적인 출력값을 주는 것입니다.

 

이때, 추가적인 값을 나타내기 위해서는 달러 표시($)를 붙여야 하는데요.

코드를 보면서 사용법을 살펴 볼게요.

 

@propertyWrapper
struct SmallNumber {
    private var number: Int
    private(set) var projectedValue: Bool

    var wrappedValue: Int {
        get { return number }
        set {
            if newValue > 12 {
                number = 12
                projectedValue = true
            } else {
                number = newValue
                projectedValue = false
            }
        }
    }

    init() {
        self.number = 0
        self.projectedValue = false
    }
}
struct SomeStructure {
    @SmallNumber var someNumber: Int
}
var someStructure = SomeStructure()

someStructure.someNumber = 4
print(someStructure.$someNumber)
// Prints "false"

print(someStructure.someNumber)
// prints "4"

someStructure.someNumber = 55
print(someStructure.$someNumber)
// Prints "true"

추가적인 기능은 바로 12보다 크면 true, 작으면 false를 나타내는 기능인데요

이것을 구현하기 위해 

projectedValue 프로퍼티를 추가해 줍니다!!

 

이후 값을 구별하기 위해 get과 set에서 기능을 정리해 주고

외부에서 number프로퍼티에 $를 붙여서 접근하면

projectedValue의 값을 출려하게 됩니다!!

신기하네요..ㅎ

 

$ 로 시작하는 프로퍼티를 정의할 수 없기 때문에

투영된 값은 정의한 프로퍼티를 절대 방해하지 않는다고 하네요..

 

 

 

 

 

 

오늘 공부는 앞으로도 계속 도움이 될것같아요.

읽으신 분들에게도 도움이 되시길 바랍니다ㅎㅎ

감사합니당!!