[Kotlin][Android] 안드로이드 Coroutine Flow 적용하기 (2) ( LiveData를 Flow로 변경하기 : LiveData 와 Flow 비교하기 )

안녕하세요 👋

오늘은 저번 포스팅에 이어 LiveData를 Flow로 이전하는 과정을 포스팅해보려 합니다.

뿐만 아니라, LiveData와 Flow의 차이점에 대해서도 함께 다뤄볼 예정입니다 😃

이전 포스팅은 아래 링크를 통해 참고 바랍니다. 🙏

 

[Kotlin][Android] 안드로이드 Coroutine Flow 적용하기 (1) (네트워크 통신 Flow로 이전하기)

 

LiveData를 Flow로 변경하기에 앞서 둘의 차이점과 왜 Flow를 사용하는지에 대해서 알아보도록 하겠습니다.

---

LiveData

LiveData는 관찰 가능한 data holder class입니다.

 

또한, LiveData는 다른 안드로이드 구성요소에서 관찰할 수 있는 데이터 집합을 보유할 수 있으며 생명주기를 인식하기 때문에 데이터를 관찰하는 구성 요소가 파괴되거나 활성화되지 않으면 해당 observer에게 데이터 게시를 중지합니다. 

 

LiveData의 장점

- 메모리 누수가 없다.

- 생명 주기를 인식하기 때문에 중지된 컴포넌트로 인한 충돌이 없고, 수동으로 생명주기를 관리해 줄 필요가 없다.

- UI와 Data의 일치성을 보장한다.

그렇다면 왜 Flow를 사용하려 할까요? 🤔

LiveData 개요  |  Android 개발자  |  Android Developers

Android Developer에 따르면 LiveData는 비동기 데이터 스트림을 처리하도록 설계 되어 있지 않다고 합니다.

LiveData는 기본적으로 변경된 값을 Main Thread에서 관찰하기 때문에 다른 레이어에서 데이터 스트림을 관찰하고 싶을 경우에는

Flow를 사용한 다음 asLiveData()를 통해 ViewModel에서 변환하여 사용하는 게 좋다고 나와있습니다.

 

[Android] 안드로이드 Clean Architecture에 대해서 ( 1 ) - Clean Architecture의 개념

 

뿐만 아니라, 안드로이드의 Clean Architecture 측면에서 Domain Layer에는 

안드로이드 의존성이 없는 순수 자바/코틀린 코드만이 존재해야 하는데 해당 Layer에서 LiveData를 사용하기에는

부적합하므로 Flow를 통해 해당 부분을 해소할 수 있습니다.

 

Android) LiveData와 Coroutine Flow 비교해보기

하지만, Flow는 LiveData와는 다르게 생명주기를 인식하지 못하며 상태가 존재하지 않아 현재 무슨 값을 가지고 있는지 알기 어렵습니다. 뿐만 아니라, Cold Stream으로 사용자가 collect 하기 전까지는 값을 반환하지 않아 연속해서 들어오는 값에 대한 처리가 어렵습니다.

 

그렇기에 위 자료에 따르면

 

---

LiveData는 구성 변경 시에 안정성을 제공하고 최신 데이터를 뷰로 전달하는 역할을 한다.

 

 Flow는 UseCase, Repository, DataSources Layer와 긴밀하게 작동해 데이터를 수집 및 처리해서

서로 다른 코루틴 범위에서 작업을 실행한다.

 

그러므로 ViewModel, View 사이의 상호작용은 LiveData, 더 깊은 레이어와 쓰레딩 같은 더 복잡한 처리는 Flow가 처리한다.

---

 

즉, LiveData와 Flow는 서로의 단점을 보완해 주며 Repository에서 처리되는 일련의 데이터 스트림은 Flow를 통해 처리하고

전달받은 View에서의 처리는 LiveData를 통해 사용하는 구조로 많이 사용한다고 보면 될 것 같습니다. 

 

하지만 ✋

StateFlow의 등장

StateFlow란 현재 상태와 새로운 상태 업데이트를 수집기에 내보내는 관찰 가능한 상태 홀더 흐름으로 value 속성을 통해 현재 상태값을 읽을 수 있습니다.

 

위에선 언급한 Flow의 단점을 해소하여 LiveData와 같이 만든 것이 바로 이 StateFlow입니다. 

 

그렇다면 사용하는 방법은 어떻게 될까요? 😎

• StateFlow는 기본적으로 Read-Only입니다. 해당 값을 변경하기 위해서는 MutableStateFlow를 사용해야 합니다.

 

• StateFlow는 LiveData와는 다르게 기본값을 설정해주어야 합니다.

 

• StateFlow는 다른 Flow에서 수집하는 경우 LiveData와는 다르게 View가 stop 되었을 때 자동으로 관찰을 멈추지 않아
  repeatOnLifeCycle {} 혹은 flowWithLifecycle.collect{} 을 통해 값을 수집해야 합니다.

 

• repeatOnLifeCycle{} 은 여러 개의 Flow를 수집할 때 사용하며
  flowWithLifecycle.collect {}는 하나의 Flow만 수집할 때 사용합니다.

 

 

지금부터는 이전 포스팅에 이어 LiveData를 Flow로 변경하는 작업에 대해서 말씀드리겠습니다.

 

[MyViewModel.kt] 네트워크 통신 결과를 관찰하던 LiveData를 stateFlow로 변경해주었습니다.

 

기존

@HiltViewModel
class MyViewModel @Inject constructor(
    private val getBeachCongestionList: GetBeachCongestionList
) : ViewModel(){
    private val _networkResult = MutableLiveData<NetworkResult<BeachCongestionList>>()
    val networkResult : LiveData<NetworkResult<BeachCongestionList>>
    get() = _networkResult

    private val _beachCongestionList = MutableLiveData<BeachCongestionList>()
    val beachCongestionList : LiveData<BeachCongestionList>
    get() = _beachCongestionList
    fun setBeachCongestionList(beachCongestionList: BeachCongestionList){
        _beachCongestionList.value = beachCongestionList
    }

    private val _toastMessage = MutableLiveData<String>()
    val toastMessage : LiveData<String>
    get() = _toastMessage

    fun getBeachInfo(){
        viewModelScope.launch {
            getBeachCongestionList.invoke().collect{ result ->
                _networkResult.value = result
            }
        }
    }

    fun onError(message : String) {
        _toastMessage.value = message
    }
}

 

변경 후

@HiltViewModel
class MyViewModel @Inject constructor(
    private val getBeachCongestionList: GetBeachCongestionList
) : ViewModel(){
    private val _networkResult = MutableStateFlow<NetworkResult<BeachCongestionList>>(NetworkResult.Success(BeachCongestionList(arrayListOf())))
    val networkResult : StateFlow<NetworkResult<BeachCongestionList>>
    get() = _networkResult

    private val _beachCongestionList =  MutableLiveData<BeachCongestionList>()
    val beachCongestionList : LiveData<BeachCongestionList>
    get() = _beachCongestionList
    fun setBeachCongestionList(beachCongestionList: BeachCongestionList){
        _beachCongestionList.value = beachCongestionList
    }

    private val _toastMessage = MutableLiveData<String>()
    val toastMessage : LiveData<String>
    get() = _toastMessage

    fun getBeachInfo(){
        viewModelScope.launch {
            getBeachCongestionList.invoke().collect{ result ->
                _networkResult.value = result
            }
        }
    }

    fun onError(message : String) {
        _toastMessage.value = message
    }
}

 

[MainActivity.kt] 전달받은 값을 collect 하여 값을 관찰한다.

 

기존

private const val TAG = "MainActivity"

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    private lateinit var binding : ActivityMainBinding
    private val viewModel : MyViewModel by viewModels()
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater).also {
            setContentView(it.root)
        }
        observeData()
    }

    override fun onResume() {
        super.onResume()
        viewModel.getBeachInfo()
    }

    private fun observeData() {
        with(viewModel){
            networkResult.observe(this@MainActivity){ result ->
                when(result){
                    is NetworkResult.Success -> setBeachCongestionList(result.data) // 성공시
                    is NetworkResult.Failure -> onError(result.code.toString()) // 실패시
                    is NetworkResult.Exception -> onError(result.errorMessage) // 예외 발생시
                    is NetworkResult.Loading -> { // 통신중
                        // 현재 프로젝트에서는 할일이 없음
                    }
                }
            }

            beachCongestionList.observe(this@MainActivity){
                Log.d(TAG, "observeData: $it")
            }
            toastMessage.observe(this@MainActivity){
                Toast.makeText(this@MainActivity , it , Toast.LENGTH_SHORT).show()
            }
        }
    }
}

 

변경 후 ( flowWithLifecycle.collect {}를 사용한 방법 )

private const val TAG = "MainActivity"

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    private lateinit var binding : ActivityMainBinding
    private val viewModel : MyViewModel by viewModels()
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater).also {
            setContentView(it.root)
        }
        observeData()
    }

    override fun onResume() {
        super.onResume()
        viewModel.getBeachInfo()
    }

    private fun observeData() {
        with(viewModel){
            lifecycleScope.launch{
                networkResult.flowWithLifecycle(lifecycle , Lifecycle.State.STARTED).collect{ result -> // 하나의 Flow만 collect할때 사용
                    when(result){
                        is NetworkResult.Success -> setBeachCongestionList(result.data)
                        is NetworkResult.Failure -> onError(result.code.toString())
                        is NetworkResult.Exception -> onError(result.errorMessage)
                        is NetworkResult.Loading -> {
                            // Noting to do
                        }
                    }
                }
            }

            beachCongestionList.observe(this@MainActivity){ list ->
                Log.d(TAG, "observeData: $list")
            }

            toastMessage.observe(this@MainActivity){ message ->
                Log.d(TAG, "observeData: $message")
            }
        }
    }
}

 

변경 후 ( repeatOnLifecycle {}을 사용한 방법 )

private const val TAG = "MainActivity"

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    private lateinit var binding : ActivityMainBinding
    private val viewModel : MyViewModel by viewModels()
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater).also {
            setContentView(it.root)
        }
        observeData()
    }

    override fun onResume() {
        super.onResume()
        viewModel.getBeachInfo()
    }

    private fun observeData() {
        with(viewModel){
            lifecycleScope.launch{
                repeatOnLifecycle(Lifecycle.State.STARTED){ // 여러개의 Flow를 collect 할때 사용
                    launch {
                        networkResult.collect{ result ->
                            when(result){
                                is NetworkResult.Success -> setBeachCongestionList(result.data)
                                is NetworkResult.Failure -> onError(result.code.toString())
                                is NetworkResult.Exception -> onError(result.errorMessage)
                                is NetworkResult.Loading -> {
                                    // Noting to do
                                }
                            }
                        }
                    }
                    
                    launch{
                        // 다른 Flow
                    }
                }
            }

            beachCongestionList.observe(this@MainActivity){ list ->
                Log.d(TAG, "observeData: $list")
            }

            toastMessage.observe(this@MainActivity){ message ->
                Log.d(TAG, "observeData: $message")
            }
        }
    }
}

 

(위 코드를 보면 모든 LiveData를 StateFlow로 변경시키지는 않았는데 다른 LiveData 또한 StateFlow로 변경해도 무관합니다.)

 

이렇게 LiveData와 Flow의 차이점 및 StateFlow를 통해 LiveData를 Flow로 이전하는 방법까지 모두 살펴보았습니다.

 

StateFlow가 등장하면서 현재 많은 API가 개발되고 있는 것 같은데요

나중에는 Kotlin기반 앱에서는 LiveData대신 Flow를 주로 사용하게 되지 않을까 생각해 봅니다. 🤔

 

여러분들도 LiveData를 사용하던 프로젝트를 StateFlow로 이전해 보는 건 어떨까요?

 

긴 글 읽어주셔서 감사드리며

이상 포스팅을 마치겠습니다.

 

오늘도 즐코하세요 :)