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

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