[Swift] Property Wrapper 뽀개기 (1)

개요

제대로 프로퍼티 래퍼를 이해하지 못한 채로 살다가 스유 공부 중 너무 많은 프로퍼티 래퍼의 등장으로 혼미해진 정신을 부여잡고 돌아왔습니다…🫠 스유의 @Published, @Binding, @ObservedObject 이런 애들이 다 property wrapper라고 하네요.

You can also use a property wrapper to reuse code in the getter and setter of multiple properties.

아직도 property wrapper가 정확히 뭘 위한건지 & 어떻게 사용하는건지 잘 감이 안와서 … 애플 공식 스위프트 문서에는 이렇게 써져있습니다.

여러 프로퍼티의 getter, setter에 있는 코드를 재사용하기 위해서 property wrapper를 사용한다! 그럼 결국 property wrapper는 getter, setter의 역할을 동시에 해주고 있는건가 ?! 대충 그렇게 감을 잡아봅니다 … 맞는지 공부하면서 알아봅시다 👀

공식 문서에서 알아보자

property wrapper는 프로퍼티를 저장하는 코드와 정의하는 코드 사이에 계층을 추가합니다. 무슨 소리일지.. 조금 더 알아봅시다.

정의

@propertyWrapper
struct TwelveOrLess {
	private var number = 0
	var wrappedValue: Int {
		get {
			number
		}
		set {
			// number에는 무조건 12보다 같거나 작은 값이 들어가게 됨
			number = min(newValue, 12)
		}
	}
}

property wrapper는 enum, class, struct를 모두 사용해서 생성할 수 있습니다.

정의할 때 @propertyWrapper를 붙이면 만들 수 있어요!

그리고 필수적으로 wrappedValue라는 변수를 선언 및 구현해줘야 합니다.

그러면 저장 및 불러오고자 하는 변수에 접근할 때 직접 접근하는게 아니라 wrappepdValue를 통해 저장하거나 값을 불러올 수 있게 되는거죠.

사용

struct Rectangle {
	@TwelveOrLess var height: Int = 0
	@TwelveOrLess var width: Int = 0
}

var testRectangle = Rectangle()

testRectangle.height = 10
// 10

testRectangle.width = 15
// 12

사용할 때는 정의한 타입의 이름 앞에 @를 붙여서 원하는 프로퍼티 앞에 붙여주면 됩니다. 그치.. 이름이 property wrapper니까 아무래도 프로퍼티를 감싸야겠죠?

struct Rectangle {
	private var _height = TwelveOrLess()
	private var _width = TwelveOrLess()

	var height: Int {
		get { _height.wrappedValue }
		set { _height.wrappedValue = newValue }
	}

	var width: Int {
		get { _width.wrappedValue }
		set { _width.wrappedValue = newValue }
	}
}

이렇게 special attribute syntax를 사용하지 않고 직접 프로퍼티 래퍼를 활용한 코드를 작성할수도 있습니다.

 

property wrapper TwelveOrLess도 결국 struct이기 때문에 객체를 생성해서 변수에 할당해주면 해당 struct가 가진 wrappedValue에 직접 접근해서 사용할 수 있습니다. 근데 이렇게까지 해야되나 ?! 이걸 property wrapper 내부에서 다 코드를 합성해주고 있는걸 이렇게 이해만 하면 되는거겠징?ㅎㅎ 이라고 생각하고 넘어가겠습니다 🙇‍♀️

Initialization

현재 TwelveOrLess property wrapper는 정의 당시에 0으로 디폴트값을 주고 있어서 사용하는 타이밍에는 따로 값을 지정해줄 수 없는 상태입니다! 하지만 초기값이나 max값을 생성 당시에 정해주고 싶을 수 있잖아유 ? 그런 경우에 property wrapper의 initializer를 제공해줘야합니다.

@propertyWrapper
struct TwelveOrLess {
	private var maximum: Int
	private var number: Int

	var wrappedValue: Int {
		get { number }
		set { number = min(newValue, 12) }
	}

	init() {
		self.maximum = 12
		self.number = 0
	}

	init(
		number: Int
	) {
		self.maximum = 12
		self.number = number
	}

	init(
		number: Int,
		maximum: Int
	) {
		self.maximum = maximum
		// 여기서 number 초기화해줄 때 wrapped value의 setter에 들어가는 로직이 적용돼야함 !!
		self.number = min(number, maximum)
	}
}

• init()

struct Rectangle {
	@TwelveOrLess var height
	@TwelveOrLess var width
}

let testRectangle = Rectangle()
testRectangle.height // 0
testRectangle.width // 0

이렇게 property wrapper를 적용한 프로퍼티에 초기값을 주지 않고 사용하는 경우, init() 메서드가 호출되면서 maximum과 number은 각각 12, 0으로 초기화됩니다. 

따라서 초기화 직후 height와 width에 접근해보면 모두 0으로 초기화 돼있는 것을 확인해보실 수 있습니다.

 

• init(number:)

struct Rectangle {
	@TwelveOrLess var height = 4
	@TwelveOrLess var height = 4
}

let testRectangle = Rectangle()
testRectangle.height // 4
testRectangle.width // 4

요렇게 초기값을 주는 경우에는 init(number:) 호출되면서 해당 값으로 number가 초기화됩니다.

 

• init(number:maximum:)

struct Rectangle {
	@TwelveOrLess(number: 10, maximum: 5) var height
	@TwelveOrLess(number: 6, maximum: 4) var height
}

let testRectangle = Rectangle()
testRectangle.height // 5
testRectangle.width // 4

이렇게 property wrapper의 위치 뒤에 initializer처럼 값을 제공할 수도 있다는데요 !!

이런 경우에는 당연히 init(number:maximum:)가 호출되겠죠?

 

• mixed

struct Rectangle {
	@TwelveOrLess(maximum: 5) var height = 3
	@TwelveOrLess var height = 3
}

이런 식으로 각 프로퍼티별로 다른 initializer를 사용할 수도 있습니다 ~~

 

Projected value

property wrapper는 projected value라는 개념을 갖고 있습니다.

추가적인 정보를 전달할 수 있는 변수로 해당 property wrapper로 감싼 프로퍼티 앞에 $를 붙여서 접근할 수 있습니다.

 

타입은 어떠한 타입도 다 올 수 있습니다.

아래의 예시에서는 하나의 값만 전달하면 되기 때문에 Bool Type으로 선언돼있지만 만약 여러 데이터를 전달해야한다면 어떠한 클래스 타입이라던지… 필요한 모든 타입으로 선언이 가능합니다. + self 리턴도 가능!

wrappedValue처럼 projectedValue라는 이름으로 반드시 선언해줘야합니다.

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

	init() {
		self.number = 0
		self.projectedValue = false
	}

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

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

let testRectangle = Rectangle()
testRectangle.height = 4
testRectangle.$height // false
testRectangle.width = 55
testRectangle.$width // true

wrappedValue의 set 로직 내부에서 projectedValue의 값을 설정해줌으로써 

projectedValue를 통해 wrappedValue의 값 보정 여부를 알 수 있습니다! 

이렇게 활용하면 정말 편할 것 같아요 !!

enum Size {
	case small, large
}

struct Rectangle {
	@TwelveOrLess var height: Int
	@TwelveOrLess var width: Int

	mutating func resize(to size: Size) -> Bool {
		switch size {
			case .small: 
				height = 10
				width = 20
			case .large:
				height = 100
				width = 100
		}

		return $height || $width
	}
}

그리고 구조체 내부에서 자기 자신의 property의 projectedValue에도 접근할 수 있습니다.
이를 통해서 height 혹은 width 중 하나라도 값이 보정됐는지에 대한 여부를 확인할 수 있습니다.

---

Property wrapper 개념에 대해서는 이제 감을 잡은 것 같구 

회사에서도 활용하고 있는 property wrapper 코드가 있는데 아직 제대로 이해를 못한 것 같아서
다음에는 property wrapper를 활용한 예시 코드를 뜯어보는 시간 & 아직 헷갈리는 부분에 대해 정리해보는 시간을 가져보겠습니다 🙇‍♀️