تزریق وابستگی دستی (Views)

مفاهیم و پیاده‌سازی Jetpack Compose

معماری پیشنهادی اندروید برای اپلیکیشن‌ها، تقسیم کد به کلاس‌ها را توصیه می‌کند تا از جداسازی وظایف (separation of concerns) بهره‌مند شوید. این اصل در سلسله مراتب کد، مسئولیت تعریف‌شده‌ی واحدی را بر عهده دارد. این امر منجر به ایجاد کلاس‌های کوچک‌تر و بیشتری می‌شود که برای انجام وظایفشان به یکدیگر نیاز به اتصال دارند.

برنامه‌های اندروید معمولاً از کلاس‌های زیادی تشکیل شده‌اند و برخی از آنها به یکدیگر وابسته هستند.
شکل ۱. مدلی از گراف برنامه اندروید

وابستگی‌های بین کلاس‌ها را می‌توان به صورت یک گراف نمایش داد که در آن هر کلاس به کلاس‌هایی که به آنها وابسته است متصل است. نمایش تمام کلاس‌های شما و وابستگی‌های آنها، گراف برنامه را تشکیل می‌دهد. در شکل 1، می‌توانید انتزاعی از گراف برنامه را مشاهده کنید. وقتی کلاس A ( ViewModel ) به کلاس B ( Repository ) وابسته است، خطی وجود دارد که از A به B اشاره می‌کند و آن وابستگی را نشان می‌دهد.

تزریق وابستگی به ایجاد این ارتباطات کمک می‌کند و به شما امکان می‌دهد پیاده‌سازی‌ها را برای آزمایش تغییر دهید. برای مثال، هنگام آزمایش یک ViewModel که به یک مخزن وابسته است، می‌توانید پیاده‌سازی‌های مختلف Repository را با fakes یا mocks ارسال کنید تا موارد مختلف را آزمایش کنید.

اصول اولیه تزریق وابستگی دستی

این بخش نحوه اعمال تزریق وابستگی دستی در یک سناریوی واقعی برنامه اندروید را پوشش می‌دهد. این بخش یک رویکرد تکراری را در مورد نحوه شروع استفاده از تزریق وابستگی در برنامه شما شرح می‌دهد. این رویکرد تا زمانی که به نقطه‌ای بسیار شبیه به آنچه Dagger به طور خودکار برای شما تولید می‌کند، بهبود می‌یابد. برای اطلاعات بیشتر در مورد Dagger، اصول اولیه Dagger را مطالعه کنید.

یک جریان را به عنوان گروهی از صفحات در برنامه خود در نظر بگیرید که مربوط به یک ویژگی هستند. ورود، ثبت نام و پرداخت، همگی نمونه‌هایی از جریان‌ها هستند.

هنگام پوشش جریان ورود به سیستم برای یک برنامه معمولی اندروید، LoginActivity به LoginViewModel بستگی دارد که به نوبه خود به UserRepository وابسته است. سپس UserRepository به UserLocalDataSource و UserRemoteDataSource وابسته است که به نوبه خود به یک سرویس Retrofit وابسته است.

LoginActivity نقطه ورود به جریان ورود است و کاربر با activity تعامل دارد. بنابراین، LoginActivity باید LoginViewModel را با تمام وابستگی‌های آن ایجاد کند.

کلاس‌های Repository و DataSource مربوط به این جریان به شکل زیر هستند:

کاتلین

class UserRepository(
   private val localDataSource: UserLocalDataSource,
   private val remoteDataSource: UserRemoteDataSource
) { ... }

class UserLocalDataSource { ... }
class UserRemoteDataSource(
   private val loginService: LoginRetrofitService
) { ... }

جاوا

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 را مشاهده می‌کنید:

کاتلین

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)
   }
}

جاوا

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 در چندین ویژگی استفاده مجدد کنید، باید آن را از الگوی singleton پیروی کنید. الگوی singleton آزمایش را دشوارتر می‌کند زیرا همه آزمایش‌ها یک نمونه singleton یکسان را به اشتراک می‌گذارند.

مدیریت وابستگی‌ها با یک کانتینر

برای حل مشکل استفاده مجدد از اشیاء، می‌توانید کلاس کانتینر وابستگی‌های خودتان را ایجاد کنید که برای دریافت وابستگی‌ها از آن استفاده کنید. تمام نمونه‌های ارائه شده توسط این کانتینر می‌توانند عمومی باشند. در این مثال، از آنجایی که شما فقط به یک نمونه از UserRepository نیاز دارید، می‌توانید وابستگی‌های آن را خصوصی کنید و در صورت نیاز به ارائه، آنها را در آینده عمومی کنید:

کاتلین

// 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)
}

جاوا

// 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 باشد.

کاتلین

// 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()
}

جاوا

// 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 را به دست آورید:

کاتلین

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)
   }
}

جاوا

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 را به کانتینر منتقل کنید و اشیاء جدیدی از آن نوع را با یک factory ارائه دهید. کد LoginViewModelFactory به این شکل است:

کاتلین

// 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)
   }
}

جاوا

// 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 وادار به مصرف آن کنید:

کاتلین

// 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()
   }
}

جاوا

// 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. هنوز کدهای تکراری زیادی وجود دارد. بسته به اینکه می‌خواهید از یک شیء دوباره استفاده کنید یا نه، باید factoryها یا پارامترها را به صورت دستی ایجاد کنید.

مدیریت وابستگی‌ها در جریان‌های برنامه

وقتی می‌خواهید قابلیت‌های بیشتری را در پروژه بگنجانید، AppContainer پیچیده می‌شود. وقتی برنامه شما بزرگتر می‌شود و شروع به معرفی جریان‌های ویژگی مختلف می‌کنید، مشکلات بیشتری نیز ایجاد می‌شوند:

  1. وقتی جریان‌های مختلفی دارید، ممکن است بخواهید اشیاء فقط در محدوده آن جریان قرار بگیرند. برای مثال، هنگام ایجاد LoginUserData (که ممکن است شامل نام کاربری و رمز عبوری باشد که فقط در جریان ورود استفاده می‌شود) نمی‌خواهید داده‌های یک جریان ورود قدیمی از یک کاربر دیگر را حفظ کنید. شما برای هر جریان جدید یک نمونه جدید می‌خواهید. می‌توانید با ایجاد اشیاء FlowContainer درون AppContainer ، همانطور که در مثال کد بعدی نشان داده شده است، به این هدف برسید.
  2. بهینه‌سازی گراف برنامه و کانتینرهای جریان نیز می‌تواند دشوار باشد. باید به خاطر داشته باشید که بسته به جریانی که در آن هستید، مواردی را که نیازی ندارید حذف کنید.

تصور کنید که یک جریان ورود به سیستم دارید که شامل یک فعالیت ( LoginActivity ) و چندین قطعه ( LoginUsernameFragment و LoginPasswordFragment ) است. این نماها می‌خواهند:

  1. به همان نمونه‌ی LoginUserData که باید تا پایان فرآیند ورود به سیستم به اشتراک گذاشته شود، دسترسی پیدا کنید.
  2. وقتی جریان دوباره شروع شد، یک نمونه جدید از LoginUserData ایجاد کنید.

شما می‌توانید این کار را با یک محفظه‌ی جریان ورود به سیستم انجام دهید. این محفظه باید هنگام شروع جریان ورود به سیستم ایجاد شود و با پایان یافتن جریان از حافظه حذف شود.

بیایید یک LoginContainer به کد مثال اضافه کنیم. شما می‌خواهید بتوانید چندین نمونه از LoginContainer را در برنامه ایجاد کنید، بنابراین به جای اینکه آن را به صورت تک‌گانی (singleton) بسازید، آن را به یک کلاس با وابستگی‌هایی که جریان ورود به سیستم از AppContainer نیاز دارد، تبدیل کنید.

کاتلین

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
}

جاوا

// 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 حذف کند.

کاتلین

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()
   }
}

جاوا

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 استفاده کنند.

از آنجا که در این حالت شما با منطق چرخه حیات view سر و کار دارید، استفاده از مشاهده چرخه حیات منطقی است.