إدخال الاعتمادية اليدوية

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

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

يمكن تمثيل التبعيات بين الفئات كرسم بياني، يكون فيه كل صف مرتبطًا بالفئات التي يعتمد عليها. يشكّل تمثيل جميع فئاتك وتبعياتها مخطّط التطبيق. في الشكل 1، يمكنك الاطّلاع على ملخّص للرسم البياني للتطبيق. عندما تعتمد الفئة "أ" (ViewModel) على الفئة "ب" (Repository)، يظهر خط يشير من "أ" إلى "ب" يمثّل هذا الاعتماد.

يساعد حقن التبعيات في إجراء هذه الربطات ويتيح لك تبديل عمليات التنفيذ للاختبار. على سبيل المثال، عند اختبار 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 {
    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 {

    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 المشترَك.

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

الخاتمة

إنّ ميزة "حقن التبعيات" هي أسلوب جيد لإنشاء تطبيقات Android قابلة للتوسيع والاختبار. استخدِم الحاويات كطريقة لمشاركة نُسخ من الصفوف في أجزاء مختلفة من تطبيقك وكمكان مركزي لإنشاء نُسخ من الصفوف باستخدام المصانع.

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

في قسم Dagger، ستعرِض عليك كيفية استخدام Dagger لبرمجة هذه العملية وإنشاء الرمز نفسه الذي كنت ستكتبه يدويًا بخلاف ذلك.