تضمين التبعية يدويًا (طرق العرض)

مفاهيم وتنفيذ في Jetpack Compose

تشجّع بنية التطبيقات المقترَحة في Android على تقسيم الرموز البرمجية إلى فئات للاستفادة من مبدأ فصل المخاوف، حيث تكون لكل فئة من التسلسل الهرمي مسؤولية واحدة محدّدة. يؤدي ذلك إلى إنشاء المزيد من الفئات الأصغر حجمًا التي يجب ربطها لتلبية التبعيات المتبادلة.

تتألف تطبيقات Android عادةً من العديد من الفئات، ويعتمد بعضها على بعض.
الشكل 1 نموذج لبيان تطبيق Android graph

يمكن تمثيل التبعيات بين الفئات على شكل بيان، حيث تكون كل فئة مرتبطة بالفئات التي تعتمد عليها. ويشكّل تمثيل جميع الفئات والتبعيات بيان التطبيق. في الشكل 1، يمكنك الاطّلاع على تجريد لبيان التطبيق. عندما تعتمد الفئة A (ViewModel) على الفئة B (Repository)، يكون هناك خط يشير من A إلى B يمثّل هذه التبعية.

يساعدك إدراج التبعية في إنشاء هذه الروابط ويسمح لك باستبدال عمليات التنفيذ لأغراض الاختبار. على سبيل المثال، عند اختبار ViewModel يعتمد على مستودع، يمكنك تمرير عمليات تنفيذ مختلفة لـ Repository باستخدام بيانات وهمية أو نماذج أولية لاختبار الحالات المختلفة.

أساسيات إدراج التبعية يدويًا

يتناول هذا القسم كيفية تطبيق إدراج التبعية يدويًا في سيناريو تطبيق 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. هناك الكثير من رموز النصوص النموذجية. إذا أردت إنشاء مثيل آخر من LoginViewModel في جزء آخر من الرمز البرمجي، سيتم تكرار الرمز البرمجي.

  2. يجب الإعلان عن التبعيات بالترتيب. عليك إنشاء مثيل من UserRepository قبل LoginViewModel لإنشائه.

  3. يصعب إعادة استخدام الكائنات. إذا أردت إعادة استخدام UserRepository في ميزات متعددة، عليك جعله يتبع نمط سينغلتون. يجعل نمط الكائن الوحيد الاختبار أكثر صعوبة لأنّ جميع الاختبارات تشارك مثيل الكائن الوحيد نفسه.

إدارة التبعيات باستخدام حاوية

لحلّ مشكلة إعادة استخدام الكائنات، يمكنك إنشاء فئة حاوية التبعيات الخاصة بك التي تستخدمها للحصول على التبعيات. يمكن أن تكون جميع المثيلات التي توفّرها هذه الحاوية علنية. في المثال، بما أنّك تحتاج فقط إلى مثيل من 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 إلى الحاوية وتوفير كائنات جديدة من هذا النوع باستخدام مصنع. يبدو الرمز البرمجي لـ 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. لا يزال هناك الكثير من رموز النصوص النموذجية. عليك إنشاء المصانع أو المعلّمات يدويًا حسب ما إذا كنت تريد إعادة استخدام كائن أم لا.

إدارة التبعيات في مسارات التطبيق

يصبح AppContainer معقّدًا عندما تريد تضمين المزيد من الوظائف في المشروع. عندما يصبح تطبيقك أكبر وتبدأ في تقديم مسارات ميزات مختلفة، تظهر المزيد من المشاكل:

  1. عندما يكون لديك مسارات مختلفة، قد تريد أن تكون الكائنات متاحة فقط في نطاق هذا المسار. على سبيل المثال، عند إنشاء LoginUserData (الذي قد يتألف من اسم المستخدم وكلمة المرور اللذين يتم استخدامهما فقط في مسار تسجيل الدخول)، لا تريد الاحتفاظ بالبيانات من مسار تسجيل دخول قديم من مستخدم مختلف. تريد مثيلاً جديدًا لكل مسار جديد. يمكنك تحقيق ذلك من خلال إنشاء كائنات FlowContainer داخل AppContainer كما هو موضّح في مثال الرمز البرمجي التالي.
  2. قد يكون تحسين بيان التطبيق وحاويات المسارات صعبًا أيضًا. عليك تذكُّر حذف المثيلات التي لا تحتاج إليها، حسب المسار الذي تستخدمه.

لنفترض أنّ لديك مسار تسجيل دخول يتألف من نشاط واحد (LoginActivity) وعدة أجزاء (LoginUsernameFragment وLoginPasswordFragment). تريد طرق العرض هذه تنفيذ ما يلي:

  1. الوصول إلى مثيل LoginUserData نفسه الذي يجب مشاركته إلى أن ينتهي مسار تسجيل الدخول.
  2. إنشاء مثيل جديد من LoginUserData عند بدء المسار مرة أخرى.

يمكنك تحقيق ذلك باستخدام حاوية مسار تسجيل الدخول. يجب إنشاء هذه الحاوية عند بدء مسار تسجيل الدخول وإزالتها من الذاكرة عند انتهاء المسار.

لنضِف LoginContainer إلى مثال الرمز البرمجي. نريد أن نتمكّن من إنشاء مثيلات متعددة من LoginContainer في التطبيق، لذا بدلاً من جعله سينغلتون، اجعله فئة تحتوي على التبعيات التي يحتاجها مسار تسجيل الدخول من 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 المشترَك.

بما أنّك تتعامل في هذه الحالة مع منطق دورة حياة طريقة العرض، من المنطقي استخدام مراقبة دورة الحياة.