Android의 권장 앱 아키텍처는 코드를 클래스로 분할하여 관심사 분리의 이점을 누리길 권장합니다. 관심사 분리는 정의된 단일 책임이 계층 구조의 각 클래스에 있는 원칙입니다. 이로 인해 서로의 종속 항목을 충족하기 위해 연결해야 하는 더 작고 많은 클래스가 생성됩니다.
클래스 간 종속성은 그래프로 표시할 수 있고 그래프에서 각 클래스는 종속된 클래스에 연결됩니다. 모든 클래스와 서로의 종속성을 표시하면 애플리케이션 그래프 가 구성됩니다. 그림 1은 애플리케이션 그래프의 추상적 개념을 보여줍니다. 클래스 A (ViewModel)가 클래스 B (Repository)에 종속되면 A에서 B로 향하는 선이 종속 항목을 나타냅니다.
종속 항목 삽입을 사용하면 클래스를 쉽게 연결할 수 있고 테스트를 위해 구현을 교체할 수 있습니다. 예를 들어 저장소에 종속된 ViewModel을 테스트할 때 가짜 또는 모의 구현과 함께 Repository의 다른 구현을 전달하여 다른 사례를 테스트할 수 있습니다.
수동 종속 항목 삽입의 기본사항
이 섹션에서는 실제 Android 앱 시나리오에서 수동 종속 항목 삽입을 적용하는 방법을 다룹니다. 앱에서 종속성 삽입을 어떻게 사용할 수 있는지 반복되는 접근 방식을 안내합니다. 이 접근 방식은 Dagger에서 자동으로 생성하는 것과 아주 유사해지는 지점에 도달할 때까지 계속 개선됩니다. Dagger에 관한 자세한 내용은 Dagger 기본사항을 참고하세요.
흐름 은 앱에서 기능에 상응하는 화면 그룹이라고 간주합니다. 로그인, 등록, 결제가 모두 흐름의 예입니다.
일반적인 Android 앱의 로그인 흐름을 다룰 때 LoginActivity는 LoginViewModel에 종속되고 LoginViewModel은 UserRepository에 종속됩니다. 그런 다음
UserRepository는 UserLocalDataSource 및
UserRemoteDataSource에 종속되고, 이는 Retrofit 서비스에 종속됩니다.
LoginActivity 는 로그인 흐름의 진입점이며 사용자는 이 활동과 상호작용합니다. 따라서 LoginActivity는 모든 종속 항목과 함께 LoginViewModel을 만들어야 합니다.
흐름의 Repository 및 DataSource 클래스는 다음과 같습니다.
class UserRepository(
private val localDataSource: UserLocalDataSource,
private val remoteDataSource: UserRemoteDataSource
) { ... }
class UserLocalDataSource { ... }
class UserRemoteDataSource(
private val loginService: LoginRetrofitService
) { ... }
Compose에서 ComponentActivity는 진입점입니다. 종속 항목 연결은 onCreate에서 한 번 발생하며 UI는 setContent에서 호출되는 컴포저블로 설명됩니다.
class ApiService {
/* Your API implementation here */
}
class UserRepository(private val apiService: ApiService) {
/* Your implementation here */
}
class LoginActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Satisfy the dependencies of LoginViewModel recursively,
// then pass what the UI needs into setContent.
val apiService = ApiService()
val userRepository = UserRepository(apiService)
setContent {
LoginScreen(userRepository)
}
}
}
@Composable
fun LoginScreen(userRepository: UserRepository) {
val viewModel: LoginViewModel = viewModel(
factory = LoginViewModelFactory(userRepository)
)
// ...
}
이 접근 방식은 다음과 같은 문제가 있습니다.
- 종속 항목은 순서대로 선언해야 합니다.
UserRepository를 만들려면LoginViewModel전에 인스턴스화해야 합니다. - 객체를 재사용하기가 어렵습니다. 여러 기능에 걸쳐
UserRepository를 재사용하려면 싱글톤 패턴을 따르게 해야 합니다. 모든 테스트가 동일한 싱글톤 인스턴스를 공유하므로 싱글톤 패턴을 사용하면 테스트가 더 어려워집니다.
컨테이너로 종속 항목 관리
객체 재사용 문제를 해결하려면 종속 항목을 가져오는 데 사용하는 자체 종속 항목 컨테이너 클래스를 만들면 됩니다. 이 컨테이너에서 제공하는 모든 인스턴스는 공개될 수 있습니다. 이 예에서는 UserRepository의 인스턴스만 필요하므로 종속 항목을 비공개로 만들 수 있으며, 제공해야 하는 경우 나중에 공개할 수 있습니다.
// Container of objects shared across the whole app
class AppContainer {
// apiService and userRepository aren't private and will be exposed
val apiService = ApiService()
val userRepository = UserRepository(apiService)
}
이러한 종속 항목은 전체 애플리케이션에서 사용되므로 모든 활동에서 사용할 수 있는 공통된 위치인
Application
클래스에 배치해야 합니다. AppContainer 인스턴스가 포함된 맞춤 Application 클래스를 만듭니다.
// Custom Application class that needs to be specified
// in the AndroidManifest.xml file
class MyApplication : Application() {
// Instance of AppContainer that will be used by all the Activities of the app
val appContainer = AppContainer()
}
Compose를 사용하면 동일한 AppContainer가 Application 하위 클래스에서 계속 생성됩니다. setContent를 호출하기 전에 활동에서 또는 LocalContext를 사용하여 컴포저블 내에서 액세스합니다.
class LoginActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val appContainer = (application as MyApplication).appContainer
setContent {
LoginScreen(appContainer.userRepository)
}
}
}
// Alternatively, read AppContainer from inside a composable:
@Composable
fun LoginScreen() {
val context = LocalContext.current
val appContainer = (context.applicationContext as MyApplication).appContainer
val viewModel: LoginViewModel = viewModel(
factory = LoginViewModelFactory(appContainer.userRepository)
)
// ...
}
트리 깊숙한 곳에서 LocalContext에 도달하는 것보다 컴포저블 매개변수로 종속 항목을 전달하는 것이 좋습니다. 이렇게 하면 컴포저블을 테스트할 수 있고 입력이 명시적으로 유지됩니다. 화면 루트에서 컨테이너를 한 번 확인하고 필요한 항목을 아래로 전달합니다.
이런 식으로는 싱글톤 UserRepository를 얻지 못합니다. 대신 그래프의 객체가 포함된 모든 활동에서 공유된 AppContainer가 있고 다른 클래스에서 사용할 수 있는 이러한 객체의 인스턴스를 만듭니다.
애플리케이션의 더 많은 위치에서 LoginViewModel이 필요한 경우 LoginViewModel의 인스턴스를 만드는 중앙 집중식 위치를 두는 것이 좋습니다.
LoginViewModel 만든 을 컨테이너로 이동하고 그 유형의 새 객체에 팩토리를 제공할 수 있습니다. LoginViewModelFactory의 코드는 다음과 같습니다.
// Definition of a Factory interface with a function to create objects of a type
interface Factory<T> {
fun create(): T
}
// Factory for LoginViewModel.
// Since LoginViewModel depends on UserRepository, in order to create instances of
// LoginViewModel, you need an instance of UserRepository that you pass as a parameter.
class LoginViewModelFactory(private val userRepository: UserRepository) : Factory<LoginViewModel> {
override fun create(): LoginViewModel {
return LoginViewModel(userRepository)
}
}
Compose를 사용하면 AppContainer 업데이트가 계속 팩토리를 노출합니다. 그러면 팩토리를 viewModel 컴포저블에서 사용하므로 ViewModel이 가장 가까운 ViewModelStoreOwner (일반적으로 호스트 활동 또는 Navigation Compose를 사용하는 경우 탐색 항목)으로 범위가 지정됩니다.
// AppContainer exposing the factory (unchanged from the snippet above)
class AppContainer {
// ...
val userRepository = UserRepository(localDataSource, remoteDataSource)
val loginViewModelFactory = LoginViewModelFactory(userRepository)
}
// Compose entry point + screen composable
class LoginActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val appContainer = (application as MyApplication).appContainer
setContent {
LoginScreen(appContainer.loginViewModelFactory)
}
}
}
@Composable
fun LoginScreen(factory: LoginViewModelFactory) {
val viewModel: LoginViewModel = viewModel(factory = factory)
// ...
}
이 접근 방식은 이전 방식보다 좋지만 여전히 다음과 같은 문제를 고려해야 합니다.
AppContainer를 직접 관리하여 모든 종속 항목의 인스턴스를 수동으로 만들어야 합니다.여전히 상용구 코드가 많습니다. 객체의 재사용 여부에 따라 수동으로 팩토리나 매개변수를 만들어야 합니다.
애플리케이션 흐름에서 종속 항목 관리
프로젝트에 기능을 더 많이 포함하려 할 때 AppContainer는 복잡해집니다. 앱이 커지고 다양한 기능 흐름을 도입하기 시작하면 더 많은 문제가 발생합니다.
흐름이 다양하면 객체가 해당 흐름의 범위에만 있기를 원할 수 있습니다. 예를 들어
LoginUserData(로그인 흐름에서만 사용되는 사용자 이름과 비밀번호로 구성될 수 있는)를 만들 때, 다른 사용자의 이전 로그인 흐름의 데이터를 유지하지 않고 개발자는 모든 새 흐름에 새 인스턴스를 원합니다. 다음 코드 예와 같이AppContainer내에FlowContainer객체를 만들면 가능합니다.애플리케이션 그래프와 흐름 컨테이너를 최적화하는 것도 어려울 수 있습니다. 흐름에 따라 필요하지 않은 인스턴스를 삭제해야 합니다.
코드 예에 LoginContainer를 추가해보겠습니다. 앱에서 LoginContainer 인스턴스를 여러 개 만들 수 있으려면 싱글톤으로 만들지 말고 로그인 흐름에 필요한 AppContainer의 종속 항목이 있는 클래스로 만듭니다.
class LoginContainer(val userRepository: UserRepository) {
val loginData = LoginUserData()
val loginViewModelFactory = LoginViewModelFactory(userRepository)
}
// AppContainer contains LoginContainer now
class AppContainer {
...
val userRepository = UserRepository(localDataSource, remoteDataSource)
// LoginContainer will be null when the user is NOT in the login flow
var loginContainer: LoginContainer? = null
}
Compose에서 흐름 컨테이너의 수명은 호스트 Activity가 아닌 컴포지션에 연결됩니다. 컴포저블은 종속 항목을 매개변수로 받거나 호이스트된 ViewModel에서 읽으므로 공유된 AppContainer.loginContainer를 변경할 필요가 없습니다. 다음과 같은 두 가지 옵션이 있습니다.
- Navigation Compose 중첩 그래프 (다중 화면 흐름에 권장).
로그인 흐름의 모든 화면을 중첩된 탐색 그래프 아래에 배치하고 컨테이너의 범위를 해당 그래프의
NavBackStackEntry로 지정합니다. 컨테이너는 사용자가 흐름에 들어갈 때 생성되고 백 스택 항목이 팝될 때 지워지며 수동 수명 주기 호출이 필요하지 않습니다. 자세한 내용은 탐색 그래프 설계 를 참고하세요. - 화면 루트의
remember(단일 화면 플로우 또는 Navigation Compose를 사용하지 않는 경우). 컴포지션에 진입할 때마다 한 번 생성되고 컴포저블이 종료될 때 가비지 컬렉션되도록remember내에 컨테이너를 구성합니다.
@Composable
fun LoginFlow(appContainer: AppContainer) {
val loginContainer = remember(appContainer) {
LoginContainer(appContainer.userRepository)
}
val viewModel: LoginViewModel = viewModel(
factory = loginContainer.loginViewModelFactory
)
// Render the login flow using loginContainer.loginData and viewModel.
}
결론
종속 항목 삽입은 확장 및 테스트 가능한 Android 앱을 만드는 데 유용한 기법입니다. 컨테이너를 사용하여 앱의 다양한 부분에서 클래스 인스턴스를 공유하고 한곳에서 팩토리를 사용하는 클래스 인스턴스를 만드세요.
애플리케이션이 커지면 상용구 코드 (예: 팩토리)를 많이 작성하게 되고 상용구 코드는 오류가 발생하기 쉽습니다. 컨테이너의 범위와 수명 주기를 직접 관리하여 메모리를 확보하기 위해 더 이상 필요하지 않은 컨테이너를 최적화 및 삭제해야 합니다. 이 작업을 잘못하면 앱에서 미묘한 버그와 메모리 누수가 발생할 수 있습니다.
Dagger 섹션에서 Dagger를 사용하여 이 프로세스를 자동화하고, 다른 경우 수동으로 작성했을 동일한 코드를 생성하는 방법을 알아봅니다.