후로훠티 래퍼

[leeinae]

Property Wrapper

정의?

Swift 5.1에 추가된 문법 중 하나.

냥. 이름 그대로 프로퍼티를 감싼다

• 프로퍼티가 저장되는 방식을 관리하는 코드
• 프로퍼티가 정의되는 코드

사이에 분리된 레이어를 추가해준다.

⇒ struct, enum, class를 사용해서 다른 프로퍼티를 정의할 때 필요한 로직을 재사용할 수 있도록 한다.

기본 형태

1. propertyWrapper 어노테이션
2. wrappedValue
3. projectedValue (optional)

가 필요함

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

    init() {
        self.number = 0
    }

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

struct a {
	@TwelveOrLess var height: Int
}
let a = a()
print(a.height)

wrappedValue는 프로퍼티 래퍼에서 꼭 필요한 값이다. 없으면 컴파일 에러.

해당 프로퍼티 래퍼의 의도는, number에 어떤 값을 넣어도 12보다 작은 값이 지정되는 구조체를 가지도록 함.

사용할 때는, @ ← 어노테이션을 붙여 표시한다. 이 표시를 통해서 컴파일러에게 해당 프로터피를 프로퍼티 래퍼가 관리하길 원한다고 말해주는 것임..

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

var rectangle = SmallRectangle()
// Print : 0
print(rectangle.height)

rectangle.height = 10
// Print : 10
print(rectangle.height)

rectangle.height = 24
// Print : 12
print(rectangle.height)

rectangle.width = 12
// Print : 12
print(rectangle.width)

적용한 모습임. 선언했던 프로퍼티 래퍼를 어노테이션으로 표시하고, 해당 값들을 호출하면 didSet, willSet처럼 작동한다.

컴파일러

프로퍼티 래퍼를 추가했을 때 컴파일러가 수행하는 세 가지 작업

1. getter, setter를 생성해 그 속성을 계산하게 한다.

2. wrapper type의 저장 프로퍼티를 가짐

   It introduces a stored property whose type is the wrapper type. ~

3. 저장 프로퍼티를 초기화한다.

   💡 **A property wrapper adds a layer of separation between code that manages how a property is stored and the code that defines a property.**

프로퍼티 래퍼를 사용하지 않고 구현한다면?

struct SmallRectangle {
	var height: Int {
		get { self.height }
		set { self.height = min(newValue, 12) }
	}

	var width: Int {
		get { self.width }
		set { self,width = min(newValue, 12) }
	}
}

// 혹은 ... 해당 구조체를 선언해본다면?
struct SmallRectangle {
    private var _height = TwelveOrLess() // 직접 12 이상의 값으로 조절할 수 없도록 private
    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 }
    }
}

많은 부분에서 중복이 발생한다 ..

프로퍼티 래퍼의 존재 이유는 관리 코드를 하나로 묶어서 추상화해놓고, 재사용하는 것이라고 생각함.

아 물론.. 커스텀해서 사용할 수도 있음. 그런데 wrappedValue라는 것을 굳이 참조하지 않아도 되니까 해당 프로퍼티 래퍼를 사용하자..

When you use a property wrapper, you write the management code once when you define the wrapper, and then reuse that management code by applying it to multiple properties.

didSet, willSet과의 차이

• didSet / willSet
  • 초기화가 필수
  • 초기값이 들어갔을 때는 동작하지 않음 → 이 이슈는 defer라는 키워드를 이용하는 .. 방법도 있음 (?)
  • 해당 문법의 의도 상 자기 자신을 변경하기 보다 옵저버 역할이 더 큼.
• property wrapper

  • 초기값 설정이 필요하다면, initializer를 추가할 수 있음

    init(wrappedValue: Int) {
    	number = min(wrappedValue, 12)
    }

Projected Value

또, wrapped Value 외에도 projected Value를 추가할 수 있음. 투영된 값이라고 해석하면 될까나 싶다?

해당 값은 wrappedValue를 기반으로 다른 값을 투영해 사용할 수 있다.

어떤 타입이든 가능하고, property wrapper type과 동일한 접근 제한 레벨을 가져야함~!

얘도 wrappedValue와 마찬가지로 projectedValue라는 네이밍을 사용해야함.

대표적인 사용 예는 해당 값을 통해 propertyWrapper가 저장되기 전에 값이 조정(adjust)되었는지 확인하는 용도로 사용할 수도 있다.

접근 방법

해당 값은 $기호를 통해 접근할 수 있다.

• 그냥 접근 시 wrapperedValue
• $ 표시를 붙이면 projectedValue

사용 예

@propertyWrapper
struct SmallNumber {
	private var number = 0
	var projectedValue = false

	var wrappedValue: Int {
		get { return number }
		set {
			if newValue > 12 {
				number = 12
				projectedValue = true // 🍪 값이 12보다 큰 경우 조정되었다고 표시 (true)
			} else {
				number = newValue
				projectedValue = false // 🍪 값이 12보다 작으면 바로 대입 후 표시 (false)
			}
		}
	}

	init() { self.number = 0 }
}

struct SomeStruct {
	@SmallNumber var num: Int
}

var s = SomeStruct()
s.num = 4

/// 퀴즈입니다. 맞혀보새요
print(s.num) 
print(s.$num)

예시로는 bool 타입을 들어서 말했지만, 다른 데이터 타입도 사용할 수 있다. (self, instance 타입 등)

진짜 어디에 쓰이고 있는가!!

UserDefaults

WWDC 19에서 나온 예시임

class UserManager {
    static var usesTouchID: Bool {
        get { return UserDefaults.standard.bool(forKey: "usesTouchID") }
        set { UserDefaults.standard.set(newValue, forKey: "usesTouchID") }
    }
    
    static var myEmail: String? {
        get { return UserDefaults.standard.string(forKey: "myEmail") }
        set { UserDefaults.standard.set(newValue, forKey: "myEmail") }
    }

    static var isLoggedIn: Bool {
        get { return UserDefaults.standard.bool(forKey: "isLoggedIn") }
        set { UserDefaults.standard.set(newValue, forKey: "isLoggedIn") }
    }
}

코드 중복 꼬라지 좀 봐주삼

getter / setter에 forKey 파라미터만 달라지고 있다. 이것을 프로퍼티 래퍼로 추상화해보면,

@propertyWrapper
struct UserDefaultsWrapper<T> {
	private var `default` = UserDefaults.standard
	private let keyString: String

	init(keyString: String) {
		self.keyString = keyString
	}

	var wrappedValue: T? {
		get {
			self.default.object(forKey: keyString) as? T
		}

		set {
			self.default.setValue(newValue, forKey: keyString)
		}
	}
}

/// 선언한 propertyWrapper를 사용하면 아래와 같다. 
final class UserManager {
	@UserDefaultsWrapper<String>(keyString: "usesTouchID") 
	private var usesTouchID
}

Auto Layout

뷰의 translatesAutoresizingMaskIntoConstraints가 false여야 코드로 뷰의 오토레이아웃을 설정할 수 있음. 이 속성을 늘 해주지 않기 위해서 PropertyWrapper로 감싼다.

@propertyWrapper
public struct UsesAutoLayout<T: UIView> {
    public var wrappedValue: T {
        didSet {
            wrappedValue.translatesAutoresizingMaskIntoConstraints = false
        }
    }

    public init(wrappedValue: T) {
        self.wrappedValue = wrappedValue
        wrappedValue.translatesAutoresizingMaskIntoConstraints = false
    }
}

final class MyViewController {
    @UsesAutoLayout
    var label = UILabel()
}

SampleFile

디버깅이나 테스트에 필요한 파일들을 정의할 수 있음.. mock .. json 이런 것?

@propertyWrapper
struct SampleFile {
    let fileName: String

    var wrappedValue: URL { // 파일이 위치한 번들 리소스 URL
        let file = fileName.split(separator: ".").first! // 파일의 순수 이름
        let fileExtension = fileName.split(separator: ".").last! // 파일의 확장자
        let url = Bundle.main.url(forResource: String(file), withExtension: String(fileExtension))!
        return url
    }

    var projectedValue: String { // 원본 파일 이름
        return fileName
    }
}

struct SampleFiles {
    @SampleFile(fileName: "sample-image.png")
    static var image: URL
}

요약..

• 프로퍼티의 getter, setter에 들어갈 코드가 여러 프로퍼티에서 재사용되는 경우, 그것을 property wrapper로 정의해놓으면 그 동작을 쉽게 끌어다 쓸 수 있음 (+혹은 코드 분리의 목적)
• 특정 속성이 저장되거나 불리는 방법을 일괄적으로 강제할 때. 그 속성에 변화가 일어날 때 발생되는 일들을 일괄적으로 강제할 때 가장 강력함.
• 정의하는 법은 struct, class, enum 등을 만들고 @propertyWrapper라고 명시.
• 실제 저장하는 값은 wrapperdValue, 추가 제공하고 싶은 값은 projectedValue
• 밖에서 쓰는 법은 프로퍼티를 선언하면서 @wrapperName으로 어노테이션을 붙임

[hyun99999]

진짜 꼭 리펙한다 ㅜ 감사합니다