मैन्युअल डिपेंडेंसी इंजेक्शन

Android के सुझाए गए ऐप्लिकेशन आर्किटेक्चर में, अपने कोड को क्लास में बांटने का सुझाव दिया जाता है, ताकि अलग-अलग कामों को अलग-अलग किया जा सके. यह एक ऐसा सिद्धांत है जिसमें हैरारकी की हर क्लास की एक तय ज़िम्मेदारी होती है. इससे, एक-दूसरे की डिपेंडेंसी को पूरा करने के लिए, एक-दूसरे से कनेक्ट की जाने वाली छोटी क्लास की संख्या बढ़ जाती है.

आम तौर पर, Android ऐप्लिकेशन कई क्लास से बने होते हैं और उनमें से कुछ एक-दूसरे पर निर्भर होते हैं.
पहली इमेज. Android ऐप्लिकेशन के ऐप्लिकेशन ग्राफ़ का मॉडल

क्लास के बीच की डिपेंडेंसी को ग्राफ़ के तौर पर दिखाया जा सकता है. इसमें हर क्लास, उन क्लास से जुड़ी होती है जिन पर वह निर्भर करती है. आपकी सभी क्लास और उनकी डिपेंडेंसी को दिखाने से, ऐप्लिकेशन ग्राफ़ बनता है. पहले चित्र में, ऐप्लिकेशन ग्राफ़ का एक एब्स्ट्रैक्शन देखा जा सकता है. जब क्लास A (ViewModel) क्लास B (Repository) पर निर्भर करती है, तो एक लाइन होती है जो A से B तक जाती है और उस डिपेंडेंसी को दिखाती है.

डिपेंडेंसी इंजेक्शन की मदद से, ये कनेक्शन बनाए जा सकते हैं. साथ ही, जांच के लिए लागू किए गए तरीकों को बदला जा सकता है. उदाहरण के लिए, किसी ViewModel की जांच करते समय, अलग-अलग मामलों की जांच करने के लिए, Repository के अलग-अलग लागू किए गए वर्शन को नकली या मॉक के साथ पास किया जा सकता है.

मैन्युअल डिपेंडेंसी इंजेक्शन के बारे में बुनियादी जानकारी

इस सेक्शन में, किसी Android ऐप्लिकेशन के मामले में, मैन्युअल डिपेंडेंसी इंजेक्शन लागू करने का तरीका बताया गया है. इसमें, अपने ऐप्लिकेशन में डिपेंडेंसी इंजेक्शन का इस्तेमाल शुरू करने के तरीके के बारे में बताया गया है. यह तरीका तब तक बेहतर होता रहता है, जब तक वह उस पॉइंट तक नहीं पहुंच जाता जो Dagger आपके लिए अपने-आप जनरेट करेगा. Dagger के बारे में ज़्यादा जानने के लिए, Dagger की बुनियादी बातें पढ़ें.

फ़्लो को अपने ऐप्लिकेशन में मौजूद स्क्रीन का ऐसा ग्रुप मानें जो किसी सुविधा से जुड़ा हो. लॉगिन, रजिस्ट्रेशन, और चेकआउट, सभी फ़्लो के उदाहरण हैं.

किसी सामान्य Android ऐप्लिकेशन के लॉगिन फ़्लो को कवर करते समय, LoginActivity LoginViewModel पर निर्भर करता है. LoginViewModel, UserRepository पर निर्भर करता है. इसके बाद, UserRepository, UserLocalDataSource और UserRemoteDataSource पर निर्भर करता है. 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. डिपेंडेंसी को क्रम से घोषित करना होगा. LoginViewModel बनाने के लिए, आपको UserRepository से पहले उसका उदाहरण देना होगा.

  3. ऑब्जेक्ट का फिर से इस्तेमाल करना मुश्किल होता है. अगर आपको UserRepository को कई सुविधाओं में फिर से इस्तेमाल करना है, तो आपको इसे सिंगलटन पैटर्न के मुताबिक बनाना होगा. सिंगलटन पैटर्न की वजह से टेस्टिंग करना ज़्यादा मुश्किल हो जाता है, क्योंकि सभी टेस्ट एक ही सिंगलटन इंस्टेंस शेयर करते हैं.

कंटेनर की मदद से डिपेंडेंसी मैनेज करना

ऑब्जेक्ट का फिर से इस्तेमाल करने से जुड़ी समस्या को हल करने के लिए, अपनी डिपेंडेंसी कंटेनर क्लास बनाई जा सकती है. इसका इस्तेमाल, डिपेंडेंसी पाने के लिए किया जाता है. इस कंटेनर से उपलब्ध कराए गए सभी इंस्टेंस सार्वजनिक हो सकते हैं. उदाहरण में, आपको सिर्फ़ 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);
    }
}

AppContainer में LoginViewModelFactory को शामिल किया जा सकता है और 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 बनाते समय (इसमें सिर्फ़ लॉगिन फ़्लो में इस्तेमाल किया गया उपयोगकर्ता नाम और पासवर्ड हो सकता है), आपको किसी दूसरे उपयोगकर्ता के पुराने लॉगिन फ़्लो का डेटा सेव नहीं करना है. आपको हर नए फ़्लो के लिए एक नया इंस्टेंस चाहिए. ऐसा करने के लिए, AppContainer के अंदर FlowContainer ऑब्जेक्ट बनाएं. इसका उदाहरण अगले कोड में दिया गया है.

  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 की तरह, लॉगिन फ़्रैगमेंट भी AppContainer से LoginContainer को ऐक्सेस कर सकते हैं और शेयर किए गए LoginUserData इंस्टेंस का इस्तेमाल कर सकते हैं.

इस मामले में, आपको व्यू के लाइफ़साइकल लॉजिक से निपटना पड़ता है. इसलिए, लाइफ़साइकल के बारे में जानकारी का इस्तेमाल करना सही रहता है.

नतीजा

डिपेंडेंसी इंजेक्शन, स्केलेबल और जांचे जा सकने वाले Android ऐप्लिकेशन बनाने के लिए एक अच्छी तकनीक है. कंटेनर का इस्तेमाल करके, अपने ऐप्लिकेशन के अलग-अलग हिस्सों में क्लास के इंस्टेंस शेयर करें. साथ ही, फ़ैक्ट्री का इस्तेमाल करके क्लास के इंस्टेंस बनाने के लिए, एक ही जगह पर कंटेनर का इस्तेमाल करें.

जब आपका ऐप्लिकेशन बड़ा हो जाता है, तो आपको पता चलता है कि आपने फ़ैक्ट्री जैसे बहुत सारे बोइलरप्लेट कोड लिखे हैं. इनमें गड़बड़ियां हो सकती हैं. आपको खुद ही कंटेनर के दायरे और लाइफ़साइकल को मैनेज करना होगा. साथ ही, मेमोरी खाली करने के लिए, उन कंटेनर को ऑप्टिमाइज़ करना और छोड़ना होगा जिनकी अब ज़रूरत नहीं है. ऐसा गलत तरीके से करने पर, आपके ऐप्लिकेशन में छोटे-मोटे गड़बड़ियां और मेमोरी लीक हो सकती हैं.

Dagger सेक्शन में, आपको यह जानकारी मिलेगी कि इस प्रोसेस को ऑटोमेट करने के लिए, Dagger का इस्तेमाल कैसे किया जा सकता है. साथ ही, उसी कोड को जनरेट करने का तरीका भी बताया जाएगा जिसे आपको मैन्युअल तरीके से लिखना पड़ता.