แนวคิดและการติดตั้งใช้งาน Jetpack Compose
สถาปัตยกรรมแอปที่แนะนำของ Android สนับสนุนให้แบ่งโค้ดออกเป็นคลาสต่างๆ เพื่อให้ได้รับประโยชน์จากการแยกความกังวล ซึ่งเป็นหลักการที่แต่ละคลาสของลำดับชั้นมีหน้าที่รับผิดชอบที่กำหนดไว้เพียงอย่างเดียว ซึ่งจะทำให้มีคลาสขนาดเล็กมากขึ้น ที่ต้องเชื่อมต่อกันเพื่อตอบสนองการขึ้นต่อกันของแต่ละคลาส
การขึ้นต่อกันระหว่างคลาสสามารถแสดงเป็นกราฟได้ โดยแต่ละคลาสจะเชื่อมต่อกับคลาสที่ขึ้นต่อกัน การแสดงคลาสทั้งหมดและการขึ้นต่อกันจะประกอบกันเป็นกราฟแอปพลิเคชัน ในรูปที่ 1
คุณจะเห็นการแยกส่วนของกราฟแอปพลิเคชัน เมื่อคลาส A (ViewModel) ขึ้นอยู่กับคลาส B (Repository) จะมีเส้นที่ชี้จาก A ไปยัง B ซึ่งแสดงถึงการอ้างอิงนั้น
การแทรกการอ้างอิงช่วยสร้างการเชื่อมต่อเหล่านี้และช่วยให้คุณสลับการใช้งานสำหรับการทดสอบได้ เช่น เมื่อทดสอบ ViewModel ที่
ขึ้นอยู่กับที่เก็บ คุณจะส่งการติดตั้งใช้งานที่แตกต่างกันของ Repository
ด้วยการจำลองหรือการจำลองวัตถุเพื่อทดสอบกรณีต่างๆ ได้
พื้นฐานของการแทรกทรัพยากร Dependency ด้วยตนเอง
ส่วนนี้จะอธิบายวิธีใช้การแทรกทรัพยากร Dependency ด้วยตนเองในสถานการณ์แอป Android จริง โดยจะอธิบายแนวทางที่ทำซ้ำเกี่ยวกับวิธีที่คุณอาจเริ่มใช้การแทรกทรัพยากร Dependency ในแอป แนวทางนี้จะได้รับการปรับปรุงจนถึงจุดที่คล้ายกับสิ่งที่ Dagger จะสร้างให้คุณโดยอัตโนมัติเป็นอย่างมาก ดูข้อมูลเพิ่มเติมเกี่ยวกับ Dagger ได้ที่ข้อมูลเบื้องต้นเกี่ยวกับ Dagger
พิจารณาว่าโฟลว์คือกลุ่มหน้าจอในแอปที่สอดคล้องกับฟีเจอร์ การเข้าสู่ระบบ การลงทะเบียน และการชำระเงินเป็นตัวอย่างของโฟลว์
เมื่อครอบคลุมขั้นตอนการเข้าสู่ระบบสำหรับแอป Android ทั่วไป LoginActivity
จะขึ้นอยู่กับ LoginViewModel ซึ่งขึ้นอยู่กับ UserRepository จากนั้น UserRepository จะขึ้นอยู่กับ UserLocalDataSource และ
UserRemoteDataSource ซึ่งจะขึ้นอยู่กับบริการ Retrofit อีกที
LoginActivity เป็นจุดแรกเข้าของขั้นตอนการเข้าสู่ระบบ และผู้ใช้โต้ตอบ
กับกิจกรรม ดังนั้น LoginActivity จึงต้องสร้าง LoginViewModel
พร้อมกับการขึ้นต่อกันทั้งหมด
คลาส Repository และ DataSource ของโฟลว์มีลักษณะดังนี้
Kotlin
class UserRepository(
private val localDataSource: UserLocalDataSource,
private val remoteDataSource: UserRemoteDataSource
) { ... }
class UserLocalDataSource { ... }
class UserRemoteDataSource(
private val loginService: LoginRetrofitService
) { ... }
Java
class UserLocalDataSource {
public UserLocalDataSource() { }
...
}
class UserRemoteDataSource {
private final Retrofit retrofit;
public UserRemoteDataSource(Retrofit retrofit) {
this.retrofit = retrofit;
}
...
}
class UserRepository {
private final UserLocalDataSource userLocalDataSource;
private final UserRemoteDataSource userRemoteDataSource;
public UserRepository(UserLocalDataSource userLocalDataSource, UserRemoteDataSource userRemoteDataSource) {
this.userLocalDataSource = userLocalDataSource;
this.userRemoteDataSource = userRemoteDataSource;
}
...
}
LoginActivity มีลักษณะดังนี้
Kotlin
class LoginActivity: Activity() {
private lateinit var loginViewModel: LoginViewModel
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// In order to satisfy the dependencies of LoginViewModel, you have to also
// satisfy the dependencies of all of its dependencies recursively.
// First, create retrofit which is the dependency of UserRemoteDataSource
val retrofit = Retrofit.Builder()
.baseUrl("https://example.com")
.build()
.create(LoginService::class.java)
// Then, satisfy the dependencies of UserRepository
val remoteDataSource = UserRemoteDataSource(retrofit)
val localDataSource = UserLocalDataSource()
// Now you can create an instance of UserRepository that LoginViewModel needs
val userRepository = UserRepository(localDataSource, remoteDataSource)
// Lastly, create an instance of LoginViewModel with userRepository
loginViewModel = LoginViewModel(userRepository)
}
}
Java
public class MainActivity extends Activity {
private LoginViewModel loginViewModel;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// In order to satisfy the dependencies of LoginViewModel, you have to also
// satisfy the dependencies of all of its dependencies recursively.
// First, create retrofit which is the dependency of UserRemoteDataSource
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://example.com")
.build()
.create(LoginService.class);
// Then, satisfy the dependencies of UserRepository
UserRemoteDataSource remoteDataSource = new UserRemoteDataSource(retrofit);
UserLocalDataSource localDataSource = new UserLocalDataSource();
// Now you can create an instance of UserRepository that LoginViewModel needs
UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);
// Lastly, create an instance of LoginViewModel with userRepository
loginViewModel = new LoginViewModel(userRepository);
}
}
แนวทางนี้มีปัญหาดังนี้
มีโค้ด Boilerplate จำนวนมาก หากต้องการสร้างอินสแตนซ์อื่น ของ
LoginViewModelในส่วนอื่นของโค้ด คุณจะต้องทำซ้ำโค้ดต้องประกาศการขึ้นต่อกันตามลำดับ คุณต้องสร้างอินสแตนซ์ของ
UserRepositoryก่อนLoginViewModelจึงจะสร้างได้นำออบเจ็กต์กลับมาใช้ใหม่ได้ยาก หากต้องการนำ
UserRepositoryไปใช้ซ้ำในฟีเจอร์ต่างๆ คุณจะต้องทำให้เป็นไปตามรูปแบบ Singleton รูปแบบ Singleton ทำให้การทดสอบยากขึ้นเนื่องจาก การทดสอบทั้งหมดใช้ Singleton อินสแตนซ์เดียวกัน
การจัดการทรัพยากร Dependency ด้วยคอนเทนเนอร์
หากต้องการแก้ปัญหาการนำออบเจ็กต์กลับมาใช้ซ้ำ คุณสามารถสร้างคลาสคอนเทนเนอร์ทรัพยากร Dependencyของคุณเองเพื่อใช้รับทรัพยากร Dependency ได้ อินสแตนซ์ทั้งหมดที่คอนเทนเนอร์นี้จัดเตรียมให้สามารถเป็นแบบสาธารณะได้ ในตัวอย่างนี้ เนื่องจากคุณต้องการเพียงอินสแตนซ์ของ UserRepository คุณจึงทำให้การอ้างอิงเป็นแบบส่วนตัวได้โดยมีตัวเลือกในการทำให้เป็นแบบสาธารณะในอนาคตหากจำเป็นต้องระบุ
Kotlin
// Container of objects shared across the whole app
class AppContainer {
// Since you want to expose userRepository out of the container, you need to satisfy
// its dependencies as you did before
private val retrofit = Retrofit.Builder()
.baseUrl("https://example.com")
.build()
.create(LoginService::class.java)
private val remoteDataSource = UserRemoteDataSource(retrofit)
private val localDataSource = UserLocalDataSource()
// userRepository is not private; it'll be exposed
val userRepository = UserRepository(localDataSource, remoteDataSource)
}
Java
// Container of objects shared across the whole app
public class AppContainer {
// Since you want to expose userRepository out of the container, you need to satisfy
// its dependencies as you did before
private Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://example.com")
.build()
.create(LoginService.class);
private UserRemoteDataSource remoteDataSource = new UserRemoteDataSource(retrofit);
private UserLocalDataSource localDataSource = new UserLocalDataSource();
// userRepository is not private; it'll be exposed
public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);
}
เนื่องจากมีการใช้การอ้างอิงเหล่านี้ในทั้งแอปพลิเคชัน จึงต้องวางไว้ในที่ที่กิจกรรมทั้งหมดใช้ร่วมกันได้ นั่นคือคลาส Application
สร้างApplicationคลาสที่กำหนดเองซึ่งมีอินสแตนซ์AppContainer
Kotlin
// 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()
}
Java
// Custom Application class that needs to be specified
// in the AndroidManifest.xml file
public class MyApplication extends Application {
// Instance of AppContainer that will be used by all the Activities of the app
public AppContainer appContainer = new AppContainer();
}
ตอนนี้คุณสามารถรับอินสแตนซ์ของ AppContainer จากแอปพลิเคชันและรับอินสแตนซ์ UserRepository ที่แชร์ได้แล้วโดยทำดังนี้
Kotlin
class LoginActivity: Activity() {
private lateinit var loginViewModel: LoginViewModel
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Gets userRepository from the instance of AppContainer in Application
val appContainer = (application as MyApplication).appContainer
loginViewModel = LoginViewModel(appContainer.userRepository)
}
}
Java
public class MainActivity extends Activity {
private LoginViewModel loginViewModel;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// Gets userRepository from the instance of AppContainer in Application
AppContainer appContainer = ((MyApplication) getApplication()).appContainer;
loginViewModel = new LoginViewModel(appContainer.userRepository);
}
}
ด้วยวิธีนี้ คุณจึงไม่มีซิงเกิลตัน UserRepository แต่คุณมี
AppContainerที่แชร์ในกิจกรรมทั้งหมดซึ่งมีออบเจ็กต์จากกราฟ
และสร้างอินสแตนซ์ของออบเจ็กต์เหล่านั้นที่คลาสอื่นๆ ใช้ได้
หากต้องการใช้ LoginViewModel ในที่อื่นๆ ในแอปพลิเคชัน การมี
ตำแหน่งส่วนกลางที่คุณสร้างอินสแตนซ์ของ LoginViewModel ก็เป็นเรื่องสมเหตุสมผล
คุณย้ายการสร้าง LoginViewModel ไปยังคอนเทนเนอร์และระบุออบเจ็กต์ใหม่
ของประเภทนั้นด้วย Factory ได้ โค้ดสำหรับ LoginViewModelFactory
มีลักษณะดังนี้
Kotlin
// 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)
}
}
Java
// Definition of a Factory interface with a function to create objects of a type
public interface Factory<T> {
T create();
}
// 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 implements Factory<LoginViewModel> {
private final UserRepository userRepository;
public LoginViewModelFactory(UserRepository userRepository) {
this.userRepository = userRepository;
}
@Override
public LoginViewModel create() {
return new LoginViewModel(userRepository);
}
}
คุณสามารถใส่ LoginViewModelFactory ใน AppContainer และทำให้ LoginActivity ใช้ LoginViewModelFactory ได้โดยทำดังนี้
Kotlin
// AppContainer can now provide instances of LoginViewModel with LoginViewModelFactory
class AppContainer {
...
val userRepository = UserRepository(localDataSource, remoteDataSource)
val loginViewModelFactory = LoginViewModelFactory(userRepository)
}
class LoginActivity: Activity() {
private lateinit var loginViewModel: LoginViewModel
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Gets LoginViewModelFactory from the application instance of AppContainer
// to create a new LoginViewModel instance
val appContainer = (application as MyApplication).appContainer
loginViewModel = appContainer.loginViewModelFactory.create()
}
}
Java
// AppContainer can now provide instances of LoginViewModel with LoginViewModelFactory
public class AppContainer {
...
public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);
public LoginViewModelFactory loginViewModelFactory = new LoginViewModelFactory(userRepository);
}
public class MainActivity extends Activity {
private LoginViewModel loginViewModel;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// Gets LoginViewModelFactory from the application instance of AppContainer
// to create a new LoginViewModel instance
AppContainer appContainer = ((MyApplication) getApplication()).appContainer;
loginViewModel = appContainer.loginViewModelFactory.create();
}
}
วิธีนี้ดีกว่าวิธีเดิม แต่ก็ยังมีสิ่งที่ควรพิจารณาอยู่บ้าง
- คุณต้องจัดการ
AppContainerด้วยตนเองโดยสร้างอินสแตนซ์สำหรับ การขึ้นต่อกันทั้งหมดด้วยตนเอง - ยังมีโค้ด Boilerplate จำนวนมาก คุณต้องสร้าง Factory หรือ พารามิเตอร์ด้วยตนเอง ทั้งนี้ขึ้นอยู่กับว่าต้องการนำออบเจ็กต์กลับมาใช้ซ้ำหรือไม่
การจัดการทรัพยากร Dependency ในโฟลว์ของแอปพลิเคชัน
AppContainer จะซับซ้อนขึ้นเมื่อคุณต้องการรวมฟังก์ชันการทำงานเพิ่มเติมใน
โปรเจ็กต์ เมื่อแอปมีขนาดใหญ่ขึ้นและคุณเริ่มนำเสนอโฟลว์ฟีเจอร์ที่แตกต่างกัน ปัญหาที่เกิดขึ้นก็จะยิ่งมากขึ้น
- เมื่อมีโฟลว์ที่แตกต่างกัน คุณอาจต้องการให้ออบเจ็กต์อยู่ในขอบเขตของโฟลว์นั้นๆ เท่านั้น
เช่น เมื่อสร้าง
LoginUserData(ซึ่งอาจประกอบด้วยชื่อผู้ใช้และรหัสผ่านที่ใช้เฉพาะในขั้นตอนการเข้าสู่ระบบ) คุณไม่ต้องการเก็บข้อมูลจากขั้นตอนการเข้าสู่ระบบแบบเดิมจากผู้ใช้รายอื่น คุณต้องการ อินสแตนซ์ใหม่สำหรับทุกโฟลว์ใหม่ คุณทำได้โดยสร้างออบเจ็กต์FlowContainerภายในAppContainerดังที่แสดงในตัวอย่างโค้ดถัดไป - การเพิ่มประสิทธิภาพกราฟแอปพลิเคชันและคอนเทนเนอร์โฟลว์ก็อาจเป็นเรื่องยากเช่นกัน คุณต้องอย่าลืมลบอินสแตนซ์ที่ไม่ต้องการออก ทั้งนี้ขึ้นอยู่กับ ขั้นตอนที่คุณกำลังดำเนินการอยู่
ลองนึกภาพว่าคุณมีโฟลว์การเข้าสู่ระบบที่ประกอบด้วยกิจกรรม 1 รายการ (LoginActivity)
และ Fragment หลายรายการ (LoginUsernameFragment และ LoginPasswordFragment)
มุมมองเหล่านี้ต้องการทำสิ่งต่อไปนี้
- เข้าถึงอินสแตนซ์
LoginUserDataเดียวกันที่ต้องแชร์จนกว่าโฟลว์การเข้าสู่ระบบจะเสร็จสิ้น - สร้างอินสแตนซ์ใหม่ของ
LoginUserDataเมื่อโฟลว์เริ่มอีกครั้ง
คุณทำได้โดยใช้คอนเทนเนอร์โฟลว์การเข้าสู่ระบบ ต้องสร้างคอนเทนเนอร์นี้เมื่อโฟลว์การเข้าสู่ระบบเริ่มต้น และนำออกจากหน่วยความจำเมื่อโฟลว์สิ้นสุด
มาเพิ่ม LoginContainer ในโค้ดตัวอย่างกัน คุณต้องการสร้างอินสแตนซ์หลายรายการของ LoginContainer ในแอป ดังนั้นแทนที่จะสร้างเป็น Singleton ให้สร้างเป็นคลาสที่มีทรัพยากร Dependency ที่โฟลว์การเข้าสู่ระบบต้องการจาก AppContainer
Kotlin
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
}
Java
// Container with Login-specific dependencies
class LoginContainer {
private final UserRepository userRepository;
public LoginContainer(UserRepository userRepository) {
this.userRepository = userRepository;
loginViewModelFactory = new LoginViewModelFactory(userRepository);
}
public LoginUserData loginData = new LoginUserData();
public LoginViewModelFactory loginViewModelFactory;
}
// AppContainer contains LoginContainer now
public class AppContainer {
...
public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);
// LoginContainer will be null when the user is NOT in the login flow
public LoginContainer loginContainer;
}
เมื่อมีคอนเทนเนอร์ที่เฉพาะเจาะจงสำหรับโฟลว์แล้ว คุณจะต้องตัดสินใจว่าจะสร้าง
และลบอินสแตนซ์คอนเทนเนอร์เมื่อใด เนื่องจากโฟลว์การเข้าสู่ระบบของคุณอยู่ใน
กิจกรรม (LoginActivity) กิจกรรมจึงเป็นตัวจัดการวงจรของ
คอนเทนเนอร์นั้น LoginActivity สามารถสร้างอินสแตนซ์ใน onCreate และลบ
อินสแตนซ์ใน onDestroy
Kotlin
class LoginActivity: Activity() {
private lateinit var loginViewModel: LoginViewModel
private lateinit var loginData: LoginUserData
private lateinit var appContainer: AppContainer
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
appContainer = (application as MyApplication).appContainer
// Login flow has started. Populate loginContainer in AppContainer
appContainer.loginContainer = LoginContainer(appContainer.userRepository)
loginViewModel = appContainer.loginContainer.loginViewModelFactory.create()
loginData = appContainer.loginContainer.loginData
}
override fun onDestroy() {
// Login flow is finishing
// Removing the instance of loginContainer in the AppContainer
appContainer.loginContainer = null
super.onDestroy()
}
}
Java
public class LoginActivity extends Activity {
private LoginViewModel loginViewModel;
private LoginData loginData;
private AppContainer appContainer;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
appContainer = ((MyApplication) getApplication()).appContainer;
// Login flow has started. Populate loginContainer in AppContainer
appContainer.loginContainer = new LoginContainer(appContainer.userRepository);
loginViewModel = appContainer.loginContainer.loginViewModelFactory.create();
loginData = appContainer.loginContainer.loginData;
}
@Override
protected void onDestroy() {
// Login flow is finishing
// Removing the instance of loginContainer in the AppContainer
appContainer.loginContainer = null;
super.onDestroy();
}
}
เช่นเดียวกับ LoginActivity ฟร็อกเมนต์การเข้าสู่ระบบสามารถเข้าถึง LoginContainer จาก
AppContainer และใช้อินสแตนซ์ LoginUserData ที่แชร์ได้
เนื่องจากในกรณีนี้คุณกำลังจัดการกับตรรกะวงจรของ View การใช้ lifecycle observation จึงสมเหตุสมผล