KVC 집합 접근자/변경자 메소드 작성방법

키밸류 코딩의 집합 접근자/변경자 메소드

to-many 관계의 프로퍼티에 대한 조정은 키밸류 코딩에서 배열 프록시를 통해서 이루어진다고 했다. 이 때 개별 원소를 추가/삭제/교체하는 작업의 효율을 높이고, 각 동작에 대해서도 KVO 지원을 가능하게 하기 위해서 배열 프록시와 연계하여 동작할 수 있는 집합 메소드를 추가로 정의하는 것이 강력하게 권장된다. 이들 메소드들은 기본적으로 NSMutableArray의 기본적인 액세스 메소드들에 키 이름이 혼합된 형태로, 일정한 규칙에 의해 이름 지어진다. 단, 키 이름이 메소드 이름에 들어가기 때문에 메소드명이 고정되지 않았고, 따라서 NSKeyValueCoding 레퍼런스 상에서는 소개되지 않는다.

집합 접근자 및 변경자들은 기본적으로 NSMuatbleArray의 몇몇 메소드들의 이름에 키 이름을 추가하여 변형한 것이다. 집합메소드에서 키 이름은 <key>로 쓰여진다. 키 이름이 대문자로  시작해야하는 경우는 <Key>로 쓰였으니 잘 구분해서 사용해야 한다.

구분 Array 메소드 KVC 집합 메소드 비고
접근자 -count -countOf<Key> 필수
-objectAtIndex: -objectIn<Key>AtIndex: 둘 중 하나 필수
-objectsAtIndexes: -<key>AtIndexes:
-getObjects:range: -getObjectsIn<Key>:range: 선택적
변경자 -insertObject:atIndex: -insertObject:in<Key>AtIndex: 배열 변경이 필요한 경우에는 필수
-removeObjectAtIndex: -removeObjectFrom<Key>AtIndex:
-replaceObjectAtIndex:withObject: -replaceObjectIn<Key>AtIndex:withObject: 선택적

 

Swift 버전을 생각하기

Swift에서는 몇가지 고려해야 하는 부분이 있다.  (Swift4, Xcode9 버전 대응)

  1. KVC는 Objective-C 런타임의 기능이므로 이름 패턴 검색 정책 자체는 달라지는 점이 없다.
  2. 집합 메소드 프로퍼티는 모두 런타임에 이름을 통해서 액세스될 수 있어야 하므로 @objc를 통해서 런타임에 노출되어야 한다.
  3. insert... 를 제외하고는 메소드 이름을 지을 때,  ...AtIndex(_:)...(atIndex:)나 차이가 없다. 예를 들어 Swift 메소드명, objectInEmployeesAtIndex(_ index:)objectInEmployees(atIndex:) 모두 Objective-C에서는 -objectInEmployeesAtIndex:로 해석된다.
  4. 하지만 insertObject(_:...)insert(object:...)로 바꿔썼을 때 제대로 찾지 못한다.[^1] 즉, 파라미터 개수가 2개 이상인 경우는 명시적으로 밖으로 빼서 첫번째 파라미터를 숨겨야 한다. 이것은 Swift2 버전의 기본 메소드 이름 규칙인데, Objective-C 런타임에 적용된 이름 규칙이 오래전 버전인 것 같다.
  5. 이름 해석 규칙이 애매할 수도 있고, Xcode 버전이 올라감에 따라 다시 다른 규칙이 적용될지 모른다. 따라서 가장 좋은 방법은 @objc() 변경자에서 Objective-C 런타임상의 이름을 같이 써주는게 좋다. (그러면 Swift 이름은 뭐 어떻게 짓든 상관없다.)
  6. 그외 타입규칙
    1. 인덱스를 가리키는 NSUIntegerInt로 번역된다.
    2. Element의 타입은 Any, AnyObject가 아닌 소속 클래스 타입을 그대로 쓰면 된다. 다만 어떤 접근자이든 옵셔널타입을 쓰지는 않는다. 옵셔널 타입으로 파라미터나 리턴타입을 정의하면 올바른 메소드 이름이 아닌 것으로 간주되니 주의할 것.

다음 예에서 Foo 클래스의 words프로퍼티에 대한 집합 접근자/변경자는 다음과 같이 작성할 수 있다.

/// 프로퍼티 선언

/// Objective-C
@property (strong, nonatmoic) NSMutableArray<NSString *>* words;

/// Swift
/// setter에 의한 교체를 추적하려면 @objc dynamic var... 로 선언해야 하지만
/// 배열 프록시를 통해서 제어하는 경우, 굳이 해당 프로퍼티가 노출되지 않아도 된다.
var words:[String] = []


/// 집합 액세스 메소드
/// 꼭 필요하지는 않다.
/// Swift의 경우 @objc 를 붙이지 않았다면 이들을 구현해서
/// 배열 프록시로 동작하게 할 수 있다.
/// Objective-C
- (NSUInteger)countOfWords { 
    return [_words count]; 
}
- (NSString*)objectInWordsAtIndex:(NSUInteger)index 
{
    return [_words objectAtIndex:index];
}

/// Swift
@objc func countOfWords() -> Int {
  return words.count
}

@objc func objectInWord(atIndex index: Int) -> String
{
  return words[index]
}

/// 변경자
/// Objective-C
- (void)insertObject:(NSString*)object inWordsAtIndex:(NSUInteger)index
{
    [_words insertObject:object atIndex:index];
}

- (void)removeObjectFromWordsAtIndex:(NSUInteger)index
{
   [_words removeAtIndex:index];
}

/// swift
@objc(insertObject:inWordsAtIndex:)
func insert(words: String, at index:Int) {
  words.insert(words, at:index)
}

@objc(removeFromWordsAtIndex:)
func remove(at index:Int) {
  words.remove(at:index)
}

참고자료

키밸류 코딩의 검색 패턴과 그 동작방식

키밸류 코딩은 런타임에 문자열로 된 프로퍼티 이름을 키로 하여 임의의 객체로부터 고정된 접근자가 아닌 임의의 키를 통해서 특정한 프로퍼티 값을 액세스하는 기술이다. 이는 코드에 고정되지 않은 특정 프로퍼티를 접근할 수 있게 하여 유연성을 극대화하는 동시에 “코드를 작성을 줄여주는” 코코아의 여러가지 하위 프레임워크 기술들을 사용하는 근간이 된다. 키밸류 코딩 호환 클래스를 작성하는 기본적인 방법은 이전 포스팅에서 간단히 살펴보았다. 여기서는 실제로 키밸류 코딩에서의 접근자는 어떤식으로 동작하는지를 살펴보고, 집합 형식의 프로퍼티가 KVO 호환이 되기 위해서 필요한 집합 접근자/변경자에 대해서 살펴보겠다.

기본 접근자의 검색 패턴

키밸류 코딩의 가장 기본적인 아이디어는 미리 코딩된, 즉 하드코딩된 접근자 메소드가 아닌 “문자열”로 된 이름을 통해서 특정한 데이터를 객체로부터 얻는 동적인 프로퍼티 getter에 관한 것이다. 실제로 이를 구현하는 메소드는 valueForKey:(=value(forKey:))이며, 이는 NSObject에서 기본 구현이 만들어져있기 때문에 공짜로 사용할 수 있다. 특정한 이름 키와 함께 이 메소드가 호출되었을 때, 어떤식으로 작동하는지는 키밸류 코딩 프로그래밍 가이드에 다음과 같이 설명되어 있다.

  1. get<Key>, <key>, is<Key>, _<key> 의 패턴으로 된 접근자 메소드를 찾는다. (명시된 순서) 접근자 메소드를 찾는다면 해당 접근자가 호출된다.
  2. 이 때 접근자의 리턴타입이 객체인 경우에는 그대로 리턴된다. 숫자인 경우에는 NSNumber로 래핑되며, 구조체인 경우에는 NSValue로 래핑된다.
  3. 1에서 키의 이름에 매칭되는 접근자 패턴을 찾을 수 없다면, 해당 키에 대응하는 값이 일반값이 아닌 배열형식이라고 가정한다. 기본적으로 배열은 몇 개의 원소가 있으며, 몇 번째 원소는 무엇인가만 알면 액세스할 수 있다. 따라서  countOf<key>를 찾고 objectIn<Key>AtIndex:<key>AtIndexes: 도 찾는다. countOf<key>와 후자 중 한개를 찾으면 NSArray 프록시가 생성되어 리턴된다.
  4. 2에서 찾을 수 없다면 해당 이름의 키의 값이 집합형식일 것으로 가정한다. 집합 타입이 가져야 하는 최소한의 요건인 세 가지 메소드가 존재하는지를 검사하게된다.  countOf<Key>, enumeratorOf<Key> 그리고 memberOf<Key>를 찾는다. 이 세 가지를 모두 찾으면 NSSet 프록시가 생성되어 리턴된다.
  5. 모두 실패했다면, 해당 클래스에게 accessInstanceVariablesDirectly를 호출해보고, YES를 리턴받는다면 (놀랍게도) _<key>, _is<Key>, <key>, is<Key> 의 이름인 인스턴스 변수를 찾는다.
  6. 여기서도 마찬가지로 찾은 인스턴스 변수가 객체 포인터라면 그대로 반환된다. 그렇지 않다면 NSNumberNSValue로 변환되어 리턴된다.
  7. 모든 탐색에 실패하면 valueForUndefinedKey: 가 호출된다. 이 메소드의 기본 구현은 예외를 일으키는 것이지만, 다른 객체에게 위임하고자한다면 이 메소드를 오버라이드 할 수 있다. 예외가 발생하면 우리는 해당 클래스가 그 키에 대해 키밸류 코딩 호환이 아니라는 메시지를 볼 수 있게 된다.

 

실제 키밸류 코딩에서 동적으로 프로퍼티에 접근하는 방식은 생각했던 것 보다 매우 복잡하다. 이것은 프로퍼티를 보는 관점 때문이다. 프로퍼티는 기본적으로 스토리지 변수와 이 스토리지 변수를 액세스하는 접근자 메소드들의 세트를 하나의 개념으로 묶어서 보는 것이다. 따라서 보통 프로퍼티를 객체 내부에 저장되는 특정한 값이라고 생각한다. (클래스 인스턴스의 멤버 변수같은 개념) 하지만 Objective-C의 프로퍼티는 개념상 두 가지로 구분하는데 (기술적으로는 객체 포인터를 저장하는 것이니 차이는 없다.) 하나는 우리가 알고 있던 프로퍼티와 같이 객체가 내부에 가지고 있는 어떤 값을 액세스하는 것이다. 그리고 다른 하나는 해당 객체와 어떤 관계를 맺고 있는 다른 값들을 말한다.

to-many 관계

예를 들어 Person 이라는 클래스를 하나 만든다고 가정해보자. 이 클래스에는 firstName 이나 lastName과 같은 프로퍼티가 있을 수 있다. 그리고 이 프로퍼티는 객체 내부에 문자열을 저장하는 변수가 있고, 이 변수를 통해서 값을 액세스하는 개념이라 생각할 수도 있지만 Person 객체가 프로퍼티 하나 당 NSString 객체와 one-to-one의 관계(relationship)를 맺고 있는 것으로 이해할 수 있다. 만약 Person 클래스에 friends라는 프로퍼티가 있고, 이 프로퍼티는 다른  Person 객체들의 배열이라고 해보자. 이 때는 Person 하나가 다른 여러 개의 Person 객체와 one-to-many 관계를 맺고 있는 것으로 이해할 수 있다. 즉, 단순히 배열 타입의 프로퍼티를 가지고 있는 것이 아니라 여러 개의 다른 객체와 관계를 의미하는 프로퍼티가 있다고 보는 것이다.

왜 이렇게 one-to-one, one-to-many 의 관계를 구분하여 사용하려는 것일까? 그것은 여러 가지 이유가 있는데, 가장 크게는 키밸류 옵저빙과 관련이 있다. 기본적으로 키밸류 옵저빙은 특정 프로퍼티의 setter가 동작하여 프로퍼티의 값이 새로운 다른 값으로 변경되었을 때, 해당 프로퍼티 키에 대해 등록된 옵저버에게 통지 메시지를 보내게 된다. 이것이 one-to-one 관계인 프로퍼티일 때는 별 문제의 소지가 없다. 2였던 값이 3으로 교체될 때 옵저버가 통지를 받는 것이 이러한 관계에서의 가능한 변경의 전부이기 때문이다. 그런데, one-to-many의 경우에는 조금 사정이 다르다.

Person *tom = [[Person alloc] init];
/// tom의 friends 키에 대해 옵저버를 설치한다.
anObserver = [[Observer alloc] init];
[tom addObserver:anObserver forKeyPath:@"friends" options:... context:...];
....
/// tom에게 새 친구가 생겼다.
Person *jane = [[Person alloc] init];
[tom.friends addObject:jane];
/// 이 변경은 옵저버에게 통지를 보내지 않는다.

만약 tomfriends 키에 대한 옵저버가 있을 때, 위 동작을 보자. one-to-many 관계에서 새로운 원소가 추가되는 것은 비즈니스로직 상에서는 의미가 있는 변경이다. 위 코드는 접근자 메소드가 기존의 배열값을 다른 배열값으로 통째로 교체한 변경 (setter를 통한 변경)이 아니다. 따라서 옵저버는 이 변경에 대해서 아무런 통지를 받지 못한다. 물론 필요할 때마다 배열을 조작하고, 그 사본을 만들어서 기존 배열을 통째로 교체하는 식으로 처리하면 KVO는 동작할 것이다. 하지만 배열의 덩치가 매우 크다면 이것은 성능에서 발목을 잡는 요인이 될 수 있다.

배열이나 Set 타입의 프로퍼티 즉, one-to-many 관계의 프로퍼티에서 요소의 추가/삭제/교체가 발생하는 경우에 KVO 통지가 보내질 수 있도록 하고 싶다면 다음의 두 대안 중 하나를 선택할 수 있다.

  1. 해당 to-many 프로퍼티에 대해서 프로퍼티를 직접 액세스하지 않고 배열 프록시를 사용한다.
  2. 해당 키를 집합으로 액세스하는데 필요한 집합 접근자를 직접 작성한다.

 

배열 프록시

to-many 관계에 있는 특정 프로퍼티를 직접 액세스하는 대신에 배열 프록시를 얻어서 조작하게 되면, 원소의 추가, 제거 및 교체에 대해서도 KVO 호환이 가능해진다. 배열 프록시는 마치 NSMuatbleArray 처럼 행동할 수 있는 프록시 객체이다. 따라서 이 프록시를 통해서 배열을 조작하면 프록시는 실제 프로퍼티값을 조작하는 식으로 동작을 연계하고, KVO에 필요한 여러 처리를 자동으로 수행한다. 배열 프록시는 -mutableArrayValueForKey: 라는 메시지를 보내어 얻을 수 있는데, 이 메소드가 프록시를 생성하는 과정은 다음과 같다.

  1. 배열 조작에 필요한 집합 메소드 변경자가 있는지 확인한다. insertObject:in<Key>AtIndex:removeObjectFrom<Key>AtIndex: 메소드가 구현되어 있는지를 체크하게 된다.
  2. 이 각각의 메소드는 배열 프록시가 insertObjectAtIndex:, removeObjectAtIndex: 메시지를 받을 때, 프록시로부터 전달될 메시지들이다.
  3. 1의 메소드들이 없으면, 그 대용으로 insert<Key>:atIndexes:remove<Key>AtIndexes: 가 있는지를 체크한다.
  4. 최소 1개씩의 삽입/삭제 메소드가 발견되면 Objective-C 런타임은 해당 메소드를 사용해서 배열을 조정할 수 있는 배열 프록시 객체를 리턴한다.
  5. 만약 replaceObjectIn<Key>AtIndex:withObject: 도 구현되어 있다면 원소를 교체하는데 있어서 두 번 동작해야 할 것을 한 번만 동작해도 되기 때문에 성능을 높일 수 있다.
  6. 배열에 대한 변경자 메소드를 발견하지 못하면 set<Key>: 메소드를 찾는다. 이 경우, 배열 프록시는 삽입/삭제에 대한 메시지를 받게되면, 원래 객체에게는 set<Key>:를 통해서 배열 전체를 set하는 변경을 수행한다.
  7. 집합 변경자도 없고, setter 메소드도 없다면 해당 객체의 accessInstanceVariablesDirectily 를 호출해본다. 이 값이 YES인 경우 _<key><key>의 이름의 인스턴스 변수를 찾는다. 이러한 변수를 찾으면 해당 변수의 객체로 메시지를 포워딩하는 배열 프록시가 생성되어 리턴된다.
  8. 이 모든 과정에서 실패하면 setValue:forUndefinedKey: 메시지가 원래 객체로 전송된다. (그리고 해당 키에 대해서 KVC 호환이 아니라는 메시지와 함께 예외가 발생한다.)

따라서 위 예에서 tom의 친구가 추가되거나 하는 경우에 KVO 통지를 받으려고 한다면 다음과 같이 프록시를 사용해야 한다.

NSMutableArray* friends = [tom mutableArrayValueForKey:@"friends"];
[friends addObject:jane];

집합 변경자 메소드를 작성하기

to-many 관계에 대해서 집합의 변형 동작에 대한 KVO 호환이 가능하게 하려면 배열 프록시를 사용해야 한다. 그런데 집합 타입의 프로퍼티에 대한 배열 프록시의 기본 동작은 1) 원본에 어떤 변경을 가해서 만들어지는 사본을 생성한 후, 2) 해당 원본 키의 setter를 사용해서 원본을 “수정된 복사본”으로 교체한다는 것이다.

즉 위의 [friends addObjects:jane]은 결국 원래의 배열의 사본을 만들고, 여기에 jane을 더해서 다시 tom.friends에 대입하는 동작으로 실행된다. 이 동작의 효율성을 높이기 위해서는 배열 프록시가 원래의 프로퍼티의 각 원소를 제어할 수 있도록 해야 하며, 이를 위해서 앞서 언급된 집합 변경자 메소드를 구현해야 한다.

최소한 삽입관련 메소드 1개와 삭제 관련 메소드 1개를 구현한다. 많은 경우 프로퍼티 자체가 변경 가능한 배열일 것이므로 래핑하는 수준의 처리만 해주면 된다. 예를 들어서 PersonfriendsNSMuatbleArray 타입일 때에도 다음의 메소드를 추가로 구현해주면된다.

@implementation Person
- (void)insertObject:(NSString*)obj inWordsAtIndex:(NSUInteger)index
{
  [_words insert:obj atIndex:index];
}

- (void)removeObjectFromWordsAtIndex:(NSUInteger)index
{
  [_words removeAtIndex:index];
}
@end

정리

이상 조금 더 자세한 키밸류 코딩의 동작 방식과, one-to-one 외에 one-to-many 관계로 정의되는 프로퍼티의 변경을 위한 집합 접근자 및 집합 변경자 메소드에 대해서 살펴보았다. 흔히 배열 타입으로 정의되는 to-many 관계의 프로퍼티는 프로퍼티 값 자체가 교체되기 보다는 원소의 추가/삭제/교체등의 변경이 잦다. 기본적인 KVO는 이러한 변경을 감지하지 못하지만, 배열 프록시를 사용하면 이러한 배열 조작 변경에 대한 KVO 탐지가 가능해진다.

이 때 배열 프록시가 배열 전체를 교체하는 것이 아닌, 배열 내부 구조를 직접 변경하게 하기 위해서 KVC 집합 변경자 메소드를 정의해야 할 필요가 있다. 특히 코코아 바인딩에서 사용되는 배열 컨트롤러(NSArrayController)는 원본 모델 키패스에 대해 배열 프록시를 사용하여 KVC/KVO를 구동하므로 이러한 기술에 사용되는 클래스의 경우, 꼭 집합 변경자 메소드를 구현해주도록 하자.

참고자료