Merge pull request #5 from YAPP-Github/feature/NDGL-12

mj010504 · web-flow · commit b5ee9d5cfe05 · 2026-01-24T14:48:21.000+09:00
[NDGL-12] MVI 아키텍처 구조 설정
diff --git a/build-logic/src/main/kotlin/NDGLAndroidLibraryPlugin.kt b/build-logic/src/main/kotlin/NDGLAndroidLibraryPlugin.kt
@@ -1,4 +1,3 @@
-
 import convention.configureComposeAndroid
 import convention.configureFirebase
 import extensions.configureAndroidLibrary
@@ -18,9 +17,7 @@ class NDGLAndroidLibraryPlugin : Plugin<Project> {
         configureFirebase()
         configureComposeAndroid()
 
-
         dependencies {
-            "implementation"(libs.findLibrary("lifecycle-runtime-compose").get())
             "implementation"(libs.findLibrary("kotlinx-immutable").get())
         }
     }
diff --git a/build-logic/src/main/kotlin/NDGLFeaturePlugin.kt b/build-logic/src/main/kotlin/NDGLFeaturePlugin.kt
@@ -21,7 +21,6 @@ class NDGLFeaturePlugin : Plugin<Project> {
         configureComposeAndroid()
         configureCoroutineAndroid()
 
-
         dependencies {
             "implementation"(project(":navigation"))
             "implementation"(project(":core:ui"))
@@ -31,7 +30,6 @@ class NDGLFeaturePlugin : Plugin<Project> {
             "implementation"(libs.findLibrary("navigation-compose").get())
             "implementation"(libs.findLibrary("lifecycle-viewmodel-compose").get())
             "implementation"(libs.findLibrary("lifecycle-runtime-compose").get())
-            "implementation"(libs.findLibrary("kotlinx-immutable").get())
             "implementation"(libs.findLibrary("androidx-navigation3-runtime").get())
         }
     }
diff --git a/core/ui/build.gradle.kts b/core/ui/build.gradle.kts
@@ -8,4 +8,5 @@ android {
 
 dependencies {
     implementation(libs.androidx.core.ktx)
+    implementation(libs.kotlinx.coroutines.core)
 }
diff --git a/core/ui/src/main/java/com/yapp/ui/base/BaseContract.kt b/core/ui/src/main/java/com/yapp/ui/base/BaseContract.kt
@@ -0,0 +1,7 @@
+package com.yapp.ui.base
+
+interface UiState
+
+interface UiIntent
+
+interface UiSideEffect
diff --git a/core/ui/src/main/java/com/yapp/ui/base/BaseViewModel.kt b/core/ui/src/main/java/com/yapp/ui/base/BaseViewModel.kt
@@ -0,0 +1,72 @@
+package com.yapp.ui.base
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.State
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.rememberUpdatedState
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.compose.LocalLifecycleOwner
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import androidx.lifecycle.repeatOnLifecycle
+import androidx.lifecycle.viewModelScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.channels.Channel
+import kotlinx.coroutines.channels.Channel.Factory.BUFFERED
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.receiveAsFlow
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.flow.update
+import kotlinx.coroutines.withContext
+
+abstract class BaseViewModel<S : UiState, I : UiIntent, SE : UiSideEffect>(
+    initialState: S,
+) : ViewModel() {
+    private val _state = MutableStateFlow(initialState)
+    protected val state = _state.asStateFlow()
+
+    private val _sideEffect: Channel<SE> = Channel(BUFFERED)
+    protected val sideEffect = _sideEffect.receiveAsFlow()
+
+    fun onIntent(intent: I) =
+        viewModelScope.launch {
+            handleIntent(intent)
+        }
+
+    protected abstract suspend fun handleIntent(intent: I)
+
+    protected fun reduce(block: S.() -> S) =
+        viewModelScope.launch {
+            _state.update { it.block() }
+        }
+
+    protected fun postSideEffect(effect: SE) =
+        viewModelScope.launch { _sideEffect.send(effect) }
+
+    @Composable
+    fun collectAsState(
+        lifecycleState: Lifecycle.State = Lifecycle.State.STARTED,
+    ): State<S> {
+        return state.collectAsStateWithLifecycle(minActiveState = lifecycleState)
+    }
+
+    @Composable
+    fun collectSideEffect(
+        sideEffect: (suspend (sideEffect: SE) -> Unit),
+    ) {
+        val sideEffectFlow = this.sideEffect
+        val lifecycleOwner = LocalLifecycleOwner.current
+
+        val callback by rememberUpdatedState(newValue = sideEffect)
+
+        LaunchedEffect(sideEffectFlow, lifecycleOwner) {
+            lifecycleOwner.lifecycle.repeatOnLifecycle(Lifecycle.State.STARTED) {
+                withContext(Dispatchers.Main.immediate) {
+                    sideEffectFlow.collect { callback(it) }
+                }
+            }
+        }
+    }
+}
diff --git a/core/util/build.gradle.kts b/core/util/build.gradle.kts
@@ -3,6 +3,5 @@ plugins {
 }
 
 dependencies {
-    // Coroutines
     implementation(libs.kotlinx.coroutines.core)
 }
diff --git a/feature/auth/src/main/java/com/yapp/ndgl/feature/auth/AuthScreen.kt b/feature/auth/src/main/java/com/yapp/ndgl/feature/auth/AuthScreen.kt
@@ -21,7 +21,7 @@ fun AuthRoute(
 }
 
 @Composable
-internal fun AuthScreen(
+private fun AuthScreen(
 ) {
     LazyColumn(
         modifier = Modifier.fillMaxSize(),
@@ -36,6 +36,6 @@ internal fun AuthScreen(
 
 @Preview(showBackground = true)
 @Composable
-fun AuthScreenPreview() {
+private fun AuthScreenPreview() {
     AuthScreen()
-}
+}
diff --git a/feature/home/src/main/java/com/yapp/ndgl/feature/home/HomeScreen.kt b/feature/home/src/main/java/com/yapp/ndgl/feature/home/HomeScreen.kt
@@ -20,7 +20,7 @@ internal fun HomeRoute(
 }
 
 @Composable
-internal fun HomeScreen(
+private fun HomeScreen(
 ) {
     LazyColumn(
         modifier = Modifier.fillMaxSize(),
@@ -35,6 +35,6 @@ internal fun HomeScreen(
 
 @Preview(showBackground = true)
 @Composable
-fun HomeScreenPreview() {
+private fun HomeScreenPreview() {
     HomeScreen()
-}
+}
diff --git a/feature/travel-helper/src/main/java/com/yapp/ndgl/feature/travelhelper/TravelHelperScreen.kt b/feature/travel-helper/src/main/java/com/yapp/ndgl/feature/travelhelper/TravelHelperScreen.kt
@@ -19,7 +19,7 @@ internal fun TravelHelperRoute(
 }
 
 @Composable
-internal fun TravelHelperScreen(
+private fun TravelHelperScreen(
 ) {
     LazyColumn(
         modifier = Modifier.fillMaxSize(),
@@ -34,6 +34,6 @@ internal fun TravelHelperScreen(
 
 @Preview(showBackground = true)
 @Composable
-fun TravelHelperScreenPreview() {
+private fun TravelHelperScreenPreview() {
     TravelHelperScreen()
 }
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelContract.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelContract.kt
@@ -0,0 +1,18 @@
+package com.yapp.ndgl.feature.travel
+
+import com.yapp.ui.base.UiIntent
+import com.yapp.ui.base.UiSideEffect
+import com.yapp.ui.base.UiState
+
+data class TravelState(
+    val displayText: String = "초기 상태"
+) : UiState
+
+
+sealed interface TravelIntent : UiIntent {
+    data class ClickTravel(val travelId: Int) : TravelIntent
+}
+
+sealed interface TravelSideEffect : UiSideEffect {
+    data class NavigateToDetail(val travelId: Int) : TravelSideEffect
+}
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelScreen.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelScreen.kt
@@ -6,25 +6,34 @@ import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.material3.Button
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.hilt.lifecycle.viewmodel.compose.hiltViewModel
 
 @Composable
 internal fun TravelRoute(
-    onNavigateToDetail: (String) -> Unit,
+    navigateToDetail: (Int) -> Unit,
     viewModel: TravelViewModel = hiltViewModel(),
 ) {
+    val state by viewModel.collectAsState()
 
     TravelScreen(
-        onNavigateToDetail = onNavigateToDetail
-    )
+        state = state,
+        clickTravel = { id -> viewModel.onIntent(TravelIntent.ClickTravel(id)) })
+
+    viewModel.collectSideEffect { sideEffect ->
+        when (sideEffect) {
+            is TravelSideEffect.NavigateToDetail -> navigateToDetail(sideEffect.travelId)
+        }
+    }
 }
 
 @Composable
-internal fun TravelScreen(
-    onNavigateToDetail: (String) -> Unit = {},
+private fun TravelScreen(
+    state: TravelState = TravelState(),
+    clickTravel: (Int) -> Unit = {},
 ) {
     LazyColumn(
         modifier = Modifier.fillMaxSize(),
@@ -35,15 +44,21 @@ internal fun TravelScreen(
             Text(text = "Travel Screen")
         }
         item {
-            Button(onClick = { onNavigateToDetail("travel-123") }) {
+            Text(text = state.displayText)
+        }
+        item {
+            Button(onClick = {
+                clickTravel(123)
+            }) {
                 Text(text = "Go to Travel Detail")
             }
         }
     }
 }
 
+
 @Preview(showBackground = true)
 @Composable
-fun TravelScreenPreview() {
+private fun TravelScreenPreview() {
     TravelScreen()
-}
+}
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelViewModel.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/TravelViewModel.kt
@@ -1,10 +1,24 @@
 package com.yapp.ndgl.feature.travel
 
-import androidx.lifecycle.ViewModel
+import com.yapp.ui.base.BaseViewModel
 import dagger.hilt.android.lifecycle.HiltViewModel
 import javax.inject.Inject
 
 @HiltViewModel
-class TravelViewModel @Inject constructor() : ViewModel() {
+class TravelViewModel @Inject constructor() : BaseViewModel<TravelState, TravelIntent, TravelSideEffect>(
+    initialState = TravelState()
+) {
+    override suspend fun handleIntent(intent: TravelIntent) {
+        when (intent) {
+            is TravelIntent.ClickTravel -> {
+                clickTravel(intent.travelId)
+            }
+        }
+    }
+
+    private fun clickTravel(travelId: Int) {
+        reduce { copy(displayText = "클릭된 id: ${travelId}") }
+        postSideEffect(TravelSideEffect.NavigateToDetail(travelId))
+    }
+}
 
-}
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/detail/TravelDetailScreen.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/detail/TravelDetailScreen.kt
@@ -24,19 +24,13 @@ internal fun TravelDetailRoute(
 
 @Composable
 internal fun TravelDetailScreen(
-    travelId: String,
+    travelId: Int,
 ) {
     LazyColumn(
         modifier = Modifier.fillMaxSize(),
         verticalArrangement = Arrangement.Center,
         horizontalAlignment = Alignment.CenterHorizontally
     ) {
-        item {
-            Text(
-                text = "Travel Detail Screen",
-                fontSize = 24.sp
-            )
-        }
         item {
             Text(
                 text = "Travel ID: $travelId",
@@ -49,5 +43,5 @@ internal fun TravelDetailScreen(
 @Preview(showBackground = true)
 @Composable
 fun TravelDetailScreenPreview() {
-    TravelDetailScreen(travelId = "12345")
+    TravelDetailScreen(travelId = 45)
 }
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/detail/TravelDetailViewModel.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/detail/TravelDetailViewModel.kt
@@ -11,14 +11,14 @@ import kotlinx.coroutines.flow.asStateFlow
 
 @HiltViewModel(assistedFactory = TravelDetailViewModel.Factory::class)
 class TravelDetailViewModel @AssistedInject constructor(
-    @Assisted travelId: String,
+    @Assisted travelId: Int,
 ) : ViewModel() {
 
     private val _travelId = MutableStateFlow(travelId)
-    val travelId: StateFlow<String> = _travelId.asStateFlow()
+    val travelId: StateFlow<Int> = _travelId.asStateFlow()
 
     @AssistedFactory
     interface Factory {
-        fun create(travelId: String): TravelDetailViewModel
+        fun create(travelId: Int): TravelDetailViewModel
     }
 }
diff --git a/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/navigation/TravelEntry.kt b/feature/travel/src/main/java/com/yapp/ndgl/feature/travel/navigation/TravelEntry.kt
@@ -11,14 +11,16 @@ import com.yapp.ndgl.feature.travel.TravelRoute
 
 fun EntryProviderScope<NavKey>.travelEntry(navigator: Navigator) {
     entry<Route.Travel> {
-        TravelRoute(onNavigateToDetail = { travelId ->
-            navigator.navigate(Route.TravelDetail(travelId))
-        })
+        TravelRoute(
+            navigateToDetail = { travelId ->
+                navigator.navigate(Route.TravelDetail(travelId))
+            })
     }
     entry<Route.TravelDetail> { route ->
-        val viewModel = hiltViewModel<TravelDetailViewModel, TravelDetailViewModel.Factory> { factory ->
-            factory.create(travelId = route.travelId)
-        }
+        val viewModel =
+            hiltViewModel<TravelDetailViewModel, TravelDetailViewModel.Factory> { factory ->
+                factory.create(travelId = route.travelId)
+            }
         TravelDetailRoute(viewModel = viewModel)
     }
 }
diff --git a/navigation/src/main/java/com/yapp/ndgl/navigation/Route.kt b/navigation/src/main/java/com/yapp/ndgl/navigation/Route.kt
@@ -15,7 +15,7 @@ sealed interface Route : NavKey {
     data object Travel : Route
 
     @Serializable
-    data class TravelDetail(val travelId: String) : Route
+    data class TravelDetail(val travelId: Int) : Route
 
     @Serializable
     data object TravelHelper : Route

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`import convention.configureComposeAndroid`
`3`	`2`	`import convention.configureFirebase`
`4`	`3`	`import extensions.configureAndroidLibrary`
`@@ -18,9 +17,7 @@ class NDGLAndroidLibraryPlugin : Plugin<Project> {`
`18`	`17`	`configureFirebase()`
`19`	`18`	`configureComposeAndroid()`
`20`	`19`
`21`		`-`
`22`	`20`	`dependencies {`
`23`		`- "implementation"(libs.findLibrary("lifecycle-runtime-compose").get())`
`24`	`21`	`"implementation"(libs.findLibrary("kotlinx-immutable").get())`
`25`	`22`	`}`
`26`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,6 @@ class NDGLFeaturePlugin : Plugin<Project> {`
`21`	`21`	`configureComposeAndroid()`
`22`	`22`	`configureCoroutineAndroid()`
`23`	`23`
`24`		`-`
`25`	`24`	`dependencies {`
`26`	`25`	`"implementation"(project(":navigation"))`
`27`	`26`	`"implementation"(project(":core:ui"))`
`@@ -31,7 +30,6 @@ class NDGLFeaturePlugin : Plugin<Project> {`
`31`	`30`	`"implementation"(libs.findLibrary("navigation-compose").get())`
`32`	`31`	`"implementation"(libs.findLibrary("lifecycle-viewmodel-compose").get())`
`33`	`32`	`"implementation"(libs.findLibrary("lifecycle-runtime-compose").get())`
`34`		`- "implementation"(libs.findLibrary("kotlinx-immutable").get())`
`35`	`33`	`"implementation"(libs.findLibrary("androidx-navigation3-runtime").get())`
`36`	`34`	`}`
`37`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,5 @@ android {`
`8`	`8`
`9`	`9`	`dependencies {`
`10`	`10`	`implementation(libs.androidx.core.ktx)`
	`11`	`+ implementation(libs.kotlinx.coroutines.core)`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,5 @@ plugins {`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`dependencies {`
`6`		`- // Coroutines`
`7`	`6`	`implementation(libs.kotlinx.coroutines.core)`
`8`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ internal fun TravelHelperRoute(`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`@Composable`
`22`		`-internal fun TravelHelperScreen(`
	`22`	`+private fun TravelHelperScreen(`
`23`	`23`	`) {`
`24`	`24`	`LazyColumn(`
`25`	`25`	`modifier = Modifier.fillMaxSize(),`
`@@ -34,6 +34,6 @@ internal fun TravelHelperScreen(`
`34`	`34`
`35`	`35`	`@Preview(showBackground = true)`
`36`	`36`	`@Composable`
`37`		`-fun TravelHelperScreenPreview() {`
	`37`	`+private fun TravelHelperScreenPreview() {`
`38`	`38`	`TravelHelperScreen()`
`39`	`39`	`}`