[Kotlin] Backing Properties

🤔 왜일까?

Android 개발을 하다 ViewModel 내부의 프로퍼티를 외부에서 변경하지 못하기 위해 사용되는 Backing Properties에 대한 궁금점이 생겼다.

구글샘플에서 참고했을 때 아래 코드는 화면의 로딩 노출 여부를 결정하는 프로퍼티이다

    private val _dataLoading = MutableLiveData<Boolean>()
    val dataLoading: LiveData<Boolean> = _dataLoading
    
    private val _dataLoading = MutableLiveData<Boolean>()
    val dataLoading: LiveData<Boolean> 
    	get() = _dataLoading

위의 코드처럼 두가지 방식은 어떤 차이점이 있을까?

🔍 찾아보자

1. 기본 setter를 이용한 값 설정

    private val _dataLoading = MutableLiveData<Boolean>()
    val dataLoading: LiveData<Boolean> = _dataLoading

위의 방식을 사용하면 초기화될 당시 dataLoading에 _dataLoading를 세팅한다는 것이다.

2. Custom getter를 이용한 값 설정

   private val _dataLoading = MutableLiveData<Boolean>()
   val dataLoading: LiveData<Boolean> 
   	get() = _dataLoading

위의 방식을 사용하면 dataLoading을 가져올 때 _dataLoading를 return 해주는 것이다.

3. 2가지 방식 비교

위의 예시와 달리 _dataLoading이 가변이고 재생성 되었다고 가정해보자.

2번 방식에서는 dataLoading을 가져올 때 _dataLoading 자체를 가져오기 때문에 재생성된 프로퍼티를 얻을 수 있다. 반면에 1번 방식에서는 초기화 당시의 _dataLoading을 가지고 있기 때문에 재생성된 프로퍼티는 얻을 수 없을 것이다.

🧪 직접 해보자

간단한 테스트 코드를 작성해보았다.

  class BackingPropertiesTest {

      private var _user = User("이름")
      private val user1 = _user
      private val user2
          get() = _user

      @Test
      fun test() {
          println("user1: $user1")
          println("user2: $user2")
          println("_user: 재생성")
          _user = User("이름변경")
          println("user1: $user1")
          println("user2: $user2")
      }

      data class User(var name: String)
  }
  
  // 실행결과
  user1:: User(name=이름)
  user2: User(name=이름)
  _user: 재생성
  user1: User(name=이름)
  user2: User(name=이름변경)

user1은 초기화 당시의 User를 return 할 것이고, user2는 _user 자체를 return 할 것이다.

결과를 확인해 봤으니 자바 코드로 변환해서 살펴보자.

먼저 user1을 살펴보면 private final BackingPropertiesTest.User user1; 맴버번수가 선언되어 있고, public BackingPropertiesTest() { this.user1 = this._user; } 초기화 당시에 _user를 할당해 주고 있다.

user2를 살펴보면 private final BackingPropertiesTest.User getUser2() { return this._user; } 하나의 함수가 생성되었으며 _user를 반환하고 있다.

🙏 마치며

이제 두 가지 방식의 차이점을 확연히 알 수 있게 되었다. 상황에 따라 적절한 방식을 채택하면 될 것이다.