[Android] UI Event with SingleLiveData

💡구성 변경 시 한 번의 데이터 변화를 관찰하기 위한 UI Event 활용법에 대하여 기록하였습니다.

 

Event

• LiveData와 같은 Observable 타입을 활용하면 변경 사항을 구독하여 데이터를 지속적으로 노출하고 관찰할 수 있습니다.
• 하지만 스낵바, 토스트, navigation 전환 등의 일회성 이벤트는 한 번의 데이터 변화만을 필요로 합니다.
• 이 때 여러 번 노출되지 않도록 별도의 Event wrapper class를 활용하거나 SingleLiveData 타입 등을 활용할 수 있습니다.

안드로이드에서 활용할 수 있는 방안은 SingleLiveData와 Event 패턴을 사용할 수 있습니다. LiveData를 이러한 환경에 활용할 경우 활성화될 때마다 데이터를 다시 전달하게 되며, 비효율적인 리소스를 낭비할 수 있습니다.

SingleLiveData

• SingleLiveData 패턴을 활용하면 LiveData를 확장하여 한 번만 데이터가 소비되도록 할 수 있습니다.
• 이벤트가 처리가 된 후에는 더 이상 데이터를 전달하지 않도록 설계합니다.

MutableLiveData

• SingleLiveData를 구현할 때 MutableLiveData를 상속받아 기능을 확장합니다.
• AtomicBoolean을 활용하여 스레드에서 안전하게 boolean 값을 업데이트할 수 있습니다.
• 이벤트가 처리 중인지 여부를 추적하여 true로 전환하고, 이벤트 처리를 완료하면 false로 전환합니다.
• 이를 통해 true인 상태에서만 이벤트를 발생하여 처리할 수 있습니다.

class SingleLiveData<T> : MutableLiveData<T>() {
    
    private val pending = AtomicBoolean(false)

    override fun observe(owner: LifecycleOwner, observer: Observer<in T>) {
        // Observe the internal MutableLiveData
        super.observe(owner, { t ->
            if (pending.compareAndSet(true, false)) {
                observer.onChanged(t)
            }
        })
    }

    override fun setValue(value: T?) {
        pending.set(true)
        super.setValue(value)
    }

    // 이벤트 트리거
    fun call() {
        value = null
    }
}

ViewModel에서 활용

• ViewModel에서 이벤트를 발생시키고, 이를 관찰하는 Activity 또는 Fragment에서 이벤트 발생에 따른 UI 로직을 처리하는 방법입니다.

class MyViewModel : ViewModel() {
    val singleLiveEvent = SingleLiveData<String>()

    fun triggerEvent() {
        singleLiveEvent.value = "한 번만 실행될 이벤트"
    }
}

// in Activity or Fragment
viewModel.singleLiveEvent.observe(this, Observer { event ->
    showToast(event)
})

Event Wrapper

• Event Wrapper 패턴은 데이터가 이미 처리되었는지 여부를 추적하여, 동일한 이벤트가 다시 전달되지 않도록 하는 방법입니다.
• Event라는 래퍼 클래스를 도입해, 한 번만 소비될 수 있는 데이터를 관리합니다.

class Event<out T>(private val content: T) {

    private var hasBeenHandled = false

    /**
     * 이벤트가 처리되지 않았다면 데이터를 반환하고, 처리된 경우에는 null을 반환
     */
    fun getContentIfNotHandled(): T? {
        return if (hasBeenHandled) {
            null
        } else {
            hasBeenHandled = true
            content
        }
    }

    /**
     * 이벤트가 이미 처리되었는지 여부와 관계없이 데이터를 반환
     */
    fun peekContent(): T = content
}

ViewModel에서 활용

• SingleLiveData와 마찬가지로 ViewModel에서 활용할 수 있습니다.

class MyViewModel : ViewModel() {
    private val _event = MutableLiveData<Event<String>>()
    val event: LiveData<Event<String>> get() = _event

    fun triggerEvent() {
        _event.value = Event("한 번만 처리될 이벤트")
    }
}

viewModel.event.observe(this, Observer { event ->
    event.getContentIfNotHandled()?.let {
        // 이벤트가 처리되지 않은 경우에만 처리
        showToast(it)
    }
})

어떤 방식이 좋을까?

• SingleLiveData는 한 번만 전달되는 간단한 이벤트에 적합합니다.
• 이는 토스트 메시지나 네비게이션과 같이 한 번 발생한 후 다시 발생할 필요가 없는 경우 유용합니다.
• Event Wrapper 패턴은 복잡한 UI 상태 관리에 더 유연하게 사용할 수 있습니다.
• UI 상태를 명시적으로 관리할 때 유용합니다.
• 안드로이드에서 두 패턴은 UI 이벤트를 처리할 때 중복 호출을 방지하는 방법이며, 이 패턴들을 활용하면 UI 상태를 관리하고, 한 번만 소비되는 이벤트를 관리할 수 있습니다.

참고

https://charlezz.com/?p=44609