הזרקת תלות ידנית (תצוגות)

מושגים ויישום ב-Jetpack פיתוח נייטיב

ארכיטקטורת האפליקציות המומלצת של Android מעודדת חלוקה של הקוד למחלקות כדי ליהנות מהפרדה בין נושאים, עיקרון שבו לכל מחלקה בהיררכיה יש אחריות מוגדרת אחת. כך נוצרים יותר מחלקות קטנות יותר שצריך לקשר ביניהן כדי למלא את התלות של כל אחת מהן.

אפליקציות ל-Android מורכבות בדרך כלל ממחלקות רבות, וחלק מהן תלויות זו בזו.
איור 1. מודל של גרף האפליקציה של אפליקציית Android

אפשר לייצג את התלות בין הכיתות כגרף, שבו כל כיתה מחוברת לכיתות שהיא תלויה בהן. הייצוג של כל המחלקות והתלויות שלהן יוצר את גרף האפליקציה. באיור 1 אפשר לראות הפשטה של גרף האפליקציה. אם מחלקה A‏ (ViewModel) תלויה במחלקה B‏ (Repository), יש קו שמצביע מ-A ל-B ומייצג את התלות הזו.

הזרקת תלות עוזרת ליצור את החיבורים האלה ומאפשרת להחליף יישומים לצורך בדיקה. לדוגמה, כשבודקים ViewModel שתלויה במאגר, אפשר להעביר הטמעות שונות של Repository עם fakes או mocks כדי לבדוק את המקרים השונים.

יסודות של הזרקת תלות ידנית

בקטע הזה נסביר איך להשתמש בהזרקת תלות ידנית בתרחיש אמיתי של אפליקציית Android. המאמר מתאר גישה איטרטיבית להטמעת הזרקת תלות באפליקציה. הגישה משתפרת עד שהיא מגיעה לנקודה שדומה מאוד למה ש-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);
   }
}

יש כמה בעיות בגישה הזו:

  1. יש הרבה קוד שחוזר על עצמו (boilerplate). אם רוצים ליצור עוד מופע של LoginViewModel בחלק אחר של הקוד, יהיה כפילות בקוד.

  2. צריך להצהיר על יחסי התלות בסדר מסוים. כדי ליצור את UserRepository, צריך ליצור מופע שלו לפני LoginViewModel.

  3. קשה לעשות שימוש חוזר באובייקטים. אם רוצים להשתמש מחדש ב-UserRepository בכמה תכונות, צריך להגדיר אותו לפי תבנית singleton. הדפוס singleton מקשה על הבדיקה כי כל הבדיקות חולקות את אותו מופע singleton.

ניהול יחסי תלות באמצעות קונטיינר

כדי לפתור את הבעיה של שימוש חוזר באובייקטים, אפשר ליצור מחלקה משלכם של מאגר תלויות שמשמשת לקבלת תלויות. כל המופעים שסופקו על ידי מאגר התגים הזה יכולים להיות ציבוריים. בדוגמה, מכיוון שצריך רק מופע של 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 לצרוך אותו:

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();
   }
}

הגישה הזו טובה יותר מהגישה הקודמת, אבל עדיין יש כמה אתגרים שצריך לקחת בחשבון:

  1. אתם צריכים לנהל את AppContainer בעצמכם, וליצור מופעים לכל התלות באופן ידני.
  2. עדיין יש הרבה קוד שחוזר על עצמו (boilerplate). צריך ליצור מפעלים או פרמטרים באופן ידני, בהתאם לשאלה אם רוצים לעשות שימוש חוזר באובייקט או לא.

ניהול יחסי תלות בתהליכי עבודה של אפליקציות

השימוש ב-AppContainer מסתבך כשרוצים לכלול בפרויקט פונקציונליות נוספת. כשהאפליקציה גדלה ומתחילים להוסיף לה תהליכים שונים של תכונות, מתעוררות עוד בעיות:

  1. אם יש לכם כמה תהליכים, יכול להיות שתרצו שהאובייקטים יהיו רק בהיקף של התהליך הזה. לדוגמה, כשיוצרים LoginUserData (שעשוי לכלול את שם המשתמש והסיסמה שמשמשים רק בתהליך הכניסה), לא רוצים לשמור נתונים מתהליך כניסה ישן של משתמש אחר. אתם רוצים ליצור מופע חדש לכל תהליך חדש. כדי לעשות את זה, יוצרים אובייקטים של FlowContainer בתוך AppContainer, כמו בדוגמת הקוד הבאה.
  2. יכול להיות שיהיה קשה גם לבצע אופטימיזציה של גרף האפליקציה ושל קונטיינרים של זרימות. בהתאם לתהליך שבו אתם נמצאים, חשוב לזכור למחוק מקרים שבהם אין לכם צורך.

נניח שיש לכם תהליך כניסה שכולל פעילות אחת (LoginActivity) ומספר מקטעים (LoginUsernameFragment ו-LoginPasswordFragment). התצוגות האלה רוצות:

  1. צריך לגשת לאותו מופע של LoginUserData שרוצים לשתף עד שתהליך הכניסה יסתיים.
  2. יוצרים מופע חדש של LoginUserData כשהתהליך מתחיל מחדש.

אפשר לעשות את זה באמצעות קונטיינר של תהליך כניסה. צריך ליצור את המאגר הזה כשמתחיל תהליך הכניסה ולהסיר אותו מהזיכרון כשהתהליך מסתיים.

נוסיף LoginContainer לקוד לדוגמה. אתם רוצים ליצור כמה מופעים של LoginContainer באפליקציה, ולכן במקום להגדיר אותו כ-singleton, אתם מגדירים אותו כמחלקה עם התלות שנדרשת לתהליך הכניסה מ-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.

במקרה הזה, אתם עובדים עם לוגיקה של מחזור החיים של התצוגה, ולכן הגיוני להשתמש ב-lifecycle observation.