Android ViewModel & Navigation

koin-android Gradle 모듈은 single 및 factory를 보완하는 새로운 viewModel DSL 키워드를 도입하여 ViewModel 컴포넌트를 선언하고 Android 컴포넌트의 라이프사이클에 바인딩할 수 있도록 합니다. viewModelOf 키워드를 사용하여 생성자와 함께 ViewModel을 선언할 수도 있습니다.

val appModule = module {

    // ViewModel for Detail View
    viewModel { DetailViewModel(get(), get()) }

    // or directly with constructor
    viewModelOf(::DetailViewModel)

}

선언된 컴포넌트는 최소한 android.arch.lifecycle.ViewModel 클래스를 확장해야 합니다. 클래스의 *생성자(constructor)*를 주입하는 방법을 지정하고 get() 함수를 사용하여 의존성을 주입할 수 있습니다.

정보

viewModel/viewModelOf 키워드는 ViewModel의 팩토리 인스턴스를 선언하는 데 도움이 됩니다. 이 인스턴스는 내부 ViewModelFactory에 의해 처리되고 필요한 경우 ViewModel 인스턴스를 다시 연결합니다. 또한 파라미터를 주입할 수 있습니다.

ViewModel 주입하기

Activity, Fragment 또는 Service에서 ViewModel을 주입하려면 다음을 사용하십시오.

• by viewModel() - ViewModel을 속성에 주입하는 lazy delegate 속성
• getViewModel() - ViewModel 인스턴스를 직접 가져옵니다.

class DetailActivity : AppCompatActivity() {

    // Lazy inject ViewModel
    val detailViewModel: DetailViewModel by viewModel()
}

노트

ViewModel 키는 Key 및/또는 Qualifier에 대해 계산됩니다.

Activity 공유 ViewModel

하나의 ViewModel 인스턴스를 Fragments와 해당 호스트 Activity 간에 공유할 수 있습니다.

Fragment에서 공유된(shared) ViewModel을 주입하려면 다음을 사용하십시오.

• by activityViewModel() - 공유 ViewModel 인스턴스를 속성에 주입하는 lazy delegate 속성
• getActivityViewModel() - 공유 ViewModel 인스턴스를 직접 가져옵니다.

노트

sharedViewModel은 activityViewModel() 함수 대신 사용되지 않습니다. 이 마지막 함수의 이름이 더 명확합니다.

ViewModel을 한 번만 선언하십시오.

val weatherAppModule = module {

    // WeatherViewModel declaration for Weather View components
    viewModel { WeatherViewModel(get(), get()) }
}

참고: ViewModel에 대한 Qualifier는 ViewModel의 태그로 처리됩니다.

Activity 및 Fragments에서 재사용하십시오.

class WeatherActivity : AppCompatActivity() {

    /*
     * Declare WeatherViewModel with Koin and allow constructor dependency injection
     */
    private val weatherViewModel by viewModel<WeatherViewModel>()
}

class WeatherHeaderFragment : Fragment() {

    /*
     * Declare shared WeatherViewModel with WeatherActivity
     */
    private val weatherViewModel by activityViewModel<WeatherViewModel>()
}

class WeatherListFragment : Fragment() {

    /*
     * Declare shared WeatherViewModel with WeatherActivity
     */
    private val weatherViewModel by activityViewModel<WeatherViewModel>()
}

생성자에 파라미터 전달하기

viewModel 키워드와 주입 API는 주입 파라미터와 호환됩니다.

모듈에서:

val appModule = module {

    // ViewModel for Detail View with id as parameter injection
    viewModel { parameters -> DetailViewModel(id = parameters.get(), get(), get()) }
    // ViewModel for Detail View with id as parameter injection, resolved from graph
    viewModel { DetailViewModel(get(), get(), get()) }
    // or Constructor DSL
    viewModelOf(::DetailViewModel)
}

주입 호출 위치에서:

class DetailActivity : AppCompatActivity() {

    val id : String // id of the view

    // Lazy inject ViewModel with id parameter
    val detailViewModel: DetailViewModel by viewModel{ parametersOf(id)}
}

SavedStateHandle 주입 (3.3.0)

ViewModel 상태를 처리하기 위해 SavedStateHandle 유형의 새 속성을 생성자에 추가하십시오.

class MyStateVM(val handle: SavedStateHandle, val myService : MyService) : ViewModel()

Koin 모듈에서 get() 또는 파라미터로 해결하십시오.

viewModel { MyStateVM(get(), get()) }

또는 Constructor DSL을 사용하십시오.

viewModelOf(::MyStateVM)

Activity, Fragment에서 state ViewModel을 주입하려면 다음을 사용하십시오.

• by viewModel() - state ViewModel 인스턴스를 속성에 주입하는 lazy delegate 속성
• getViewModel() - state ViewModel 인스턴스를 직접 가져옵니다.

class DetailActivity : AppCompatActivity() {

    // MyStateVM viewModel injected with SavedStateHandle
    val myStateVM: MyStateVM by viewModel()
}

정보

모든 stateViewModel 함수는 사용되지 않습니다. 일반 viewModel 함수를 사용하여 SavedStateHandle을 주입 할 수 있습니다.

Navigation Graph ViewModel

ViewModel 인스턴스를 Navigation 그래프에 범위 지정할 수 있습니다. by koinNavGraphViewModel()로 검색하십시오. 그래프 ID만 있으면 됩니다.

class NavFragment : Fragment() {

    val mainViewModel: NavViewModel by koinNavGraphViewModel(R.id.my_graph)

}

ViewModel Scope API

ViewModel 및 Scopes에 사용되는 모든 API를 참조하십시오. ViewModel Scope

ViewModel Generic API

Koin은 ViewModel 인스턴스를 직접 조정하기 위한 몇 가지 "under the hood" API를 제공합니다. 사용 가능한 함수는 ComponentActivity 및 Fragment에 대한 viewModelForClass입니다.

ComponentActivity.viewModelForClass(
    clazz: KClass<T>,
    qualifier: Qualifier? = null,
    owner: ViewModelStoreOwner = this,
    state: BundleDefinition? = null,
    key: String? = null,
    parameters: ParametersDefinition? = null,
): Lazy<T>

노트

이 함수는 여전히 state: BundleDefinition을 사용하지만 CreationExtras로 변환합니다.

어디서든 호출 가능한 최상위 함수에 액세스할 수 있습니다.

fun <T : ViewModel> getLazyViewModelForClass(
    clazz: KClass<T>,
    owner: ViewModelStoreOwner,
    scope: Scope = GlobalContext.get().scopeRegistry.rootScope,
    qualifier: Qualifier? = null,
    state: BundleDefinition? = null,
    key: String? = null,
    parameters: ParametersDefinition? = null,
): Lazy<T>

ViewModel API - Java 호환성

Java 호환성을 종속성에 추가해야 합니다.

// Java Compatibility
implementation "io.insert-koin:koin-android-compat:$koin_version"

ViewModelCompat에서 viewModel() 또는 getViewModel() 정적 함수를 사용하여 Java 코드베이스에 ViewModel 인스턴스를 주입할 수 있습니다.

@JvmOverloads
@JvmStatic
@MainThread
fun <T : ViewModel> getViewModel(
    owner: ViewModelStoreOwner,
    clazz: Class<T>,
    qualifier: Qualifier? = null,
    parameters: ParametersDefinition? = null
)