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

कॉन्सेप्ट और Jetpack Compose को लागू करने का तरीका

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

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

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

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

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

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

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

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

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

इस मामले में, व्यू लाइफ़साइकल लॉजिक का इस्तेमाल किया जा रहा है. इसलिए, लाइफ़साइकल ऑब्ज़र्वेशन का इस्तेमाल करना सही है.