Як отримати контекст в Android MVVM ViewModel

Я намагаюся застосувати шаблон MVVM у своєму додатку для Android. Я читав, що ViewModels не повинен містити спеціального коду для Android (щоб полегшити тестування), однак мені потрібно використовувати контекст для різних речей (отримання ресурсів з xml, ініціалізація налаштувань тощо). Який найкращий спосіб це зробити? Я побачив, що у AndroidViewModelньому є посилання на контекст програми, однак він містить специфічний код для Android, тому я не впевнений, чи має це бути у ViewModel. Також вони пов’язані з подіями життєвого циклу Activity, але я використовую кинджал для управління сферою компонентів, тому я не впевнений, як це може вплинути на це. Я новачок у шаблоні MVVM та Кинджалі, тому будь-яка допомога буде вдячна!

Ви можете використовувати Applicationконтекст, який надається AndroidViewModel, ви повинні розширити, AndroidViewModelякий просто ViewModelвключає Applicationпосилання.

Для моделі архітектури компонентів Android,

Передавати контекст активності у ViewModel Activity не є доброю практикою, оскільки це витік пам’яті.

Отже, щоб отримати контекст у вашому ViewModel, клас ViewModel повинен розширити клас Android View Model . Таким чином ви можете отримати контекст, як показано в прикладі коду нижче.

class ActivityViewModel(application: Application) : AndroidViewModel(application) {

    private val context = getApplication<Application>().applicationContext

    //... ViewModel methods 

}

Це не те, що ViewModels не повинні містити спеціальний код для Android, щоб полегшити тестування, оскільки саме абстракція полегшує тестування.

Причина, чому ViewModels не повинна містити екземпляр контексту або щось подібне до подань або інших об'єктів, що містять контекст, полягає в тому, що він має окремий життєвий цикл, ніж "Дії" та "Фрагменти".

Що я маю на увазі під цим, скажімо, ви змінюєте обертання у своєму додатку. Це призводить до того, що ваша активність і фрагмент знищуються, тому вони відтворюються. ViewModel призначений для збереження під час цього стану, тому є ймовірність аварійного завершення роботи та інших винятків, якщо він все ще містить перегляд або контекст знищеної активності.

Що стосується того, як вам слід робити те, що ви хочете зробити, MVVM і ViewModel дуже добре працюють з компонентом Databinding JetPack. Для більшості речей, для яких ти зазвичай зберігаєш String, int або ін., Ти можеш використовувати Databinding, щоб змусити подання відображати його безпосередньо, тому не потрібно зберігати значення всередині ViewModel.

Але якщо ви не хочете прив'язки даних, ви все одно можете передати контекст всередині конструктора або методів доступу до ресурсів. Просто не тримайте екземпляр цього контексту всередині вашого ViewModel.

Коротка відповідь - не робіть цього

Чому?

Це перешкоджає усьому призначенню моделей перегляду

Майже все, що ви можете зробити в моделі перегляду, можна зробити у дії / фрагменті, використовуючи екземпляри LiveData та різні інші рекомендовані підходи.

Що я в підсумку робив замість того, щоб мати контекст безпосередньо в ViewModel, я створив класи провайдерів, такі як ResourceProvider, які давали б мені потрібні ресурси, і ці класи провайдерів мені вводили у мій ViewModel

TL; DR: Внесіть контекст Програми через Кинджал у ваші ViewModels і використовуйте його для завантаження ресурсів. Якщо вам потрібно завантажити зображення, передайте екземпляр View через аргументи методів Databinding і використовуйте цей контекст View.

MVVM - це хороша архітектура, і це, безумовно, майбутнє розробки Android, але є кілька речей, які все ще залишаються зеленими. Візьмемо для прикладу зв'язок шарів в архітектурі MVVM, я бачив, як різні розробники (дуже відомі розробники) використовують LiveData для зв'язку різних рівнів різними способами. Деякі з них використовують LiveData для зв'язку ViewModel з інтерфейсом користувача, але потім вони використовують інтерфейси зворотного виклику для зв'язку зі сховищами, або вони мають Interactors / UseCases, і вони використовують LiveData для зв'язку з ними. Точка тут, є те , що не всі 100% визначити ще .

З огляду на це, мій підхід до вашої конкретної проблеми полягає в тому, щоб контекст програми був доступний через DI для використання у моїх ViewModels для отримання таких речей, як String з мого strings.xml

Якщо я маю справу із завантаженням зображень, я намагаюся передати об'єкти View з методів адаптера прив'язки даних і використовую контекст View для завантаження зображень. Чому? оскільки деякі технології (наприклад, Glide) можуть зіткнутися з проблемами, якщо ви використовуєте контекст Програми для завантаження зображень.

Сподіваюся, це допоможе!

Як вже згадували інші, AndroidViewModelви можете отримати висновок, щоб отримати програму, Contextале з того, що я збираю в коментарях, ви намагаєтесь маніпулювати @drawables з вашогоViewModel що перемагає мету MVVM.

Загалом, потреба мати Contextв собі ViewModelмайже повсюдно наводить на думку, що вам слід подумати про переосмислення того, як ви розподіляєте логіку між своїми Viewі ViewModels.

Замість того, щоб ViewModelвирішувати малюнки та подавати їх до Activity / Fragment, подумайте про те, щоб Fragment / Activity жонглювали малюнки на основі даних, якими володіє ViewModel. Скажімо, вам потрібні різні малюнки, які відображатимуться у поданні для стану увімкнення / вимкнення - це те, ViewModelщо повинно містити (можливо, логічне) стан, але справа в тому View, щоб вибрати відповідний малюнок.

Це можна зробити досить просто за допомогою DataBinding :

<ImageView
...
app:src="@{viewModel.isOn ? @drawable/switch_on : @drawable/switch_off}"
/>

Якщо у вас більше станів і малюнків, щоб уникнути громіздкої логіки у файлі макета, ви можете написати власний BindingAdapter, який переводить, скажімо, Enumзначення уR.drawable.* (наприклад, масті карт)

Або, можливо, вам потрібен Contextдля якогось компонента, який ви використовуєте у вашому ViewModel- тоді створіть компонент за межами ViewModelта передайте його. Ви можете використовувати DI, або одиночні, або створити Context-залежний компонент безпосередньо перед ініціалізацією ViewModelin Fragment/ Activity.

Навіщо турбуватися: Contextце специфічна для Android річ, і залежно від тих, хто в ViewModelних, це погана практика: вони заважають модульному тестуванню. З іншого боку, ваші власні інтерфейси компонентів / служб повністю під вашим контролем, тому ви можете легко знущатись над ними для тестування.

має посилання на контекст програми, однак містить специфічний для Android код

Хороші новини, ви можете використовувати Mockito.mock(Context.class) і змусити контекст повертати все, що завгодно в тестах!

Тож просто використовуйте ViewModelяк зазвичай, і надайте йому ApplicationContext через ViewModelProviders.Factory, як зазвичай.

Ви можете отримати доступ до контексту програми із getApplication().getApplicationContext()ViewModel. Це те, що вам потрібно для доступу до ресурсів, уподобань тощо.

Ви не повинні використовувати об’єкти, пов’язані з Android, у своєму ViewModel, оскільки мотивом використання ViewModel є розділення Java-коду та Android-коду, щоб ви могли перевірити свою ділову логіку окремо, і ви отримаєте окремий шар компонентів Android та свою бізнес-логіку та даних, Ви не повинні мати контексту у ViewModel, оскільки це може призвести до збоїв

У мене були проблеми з отриманням SharedPreferencesпід час використання ViewModelкласу, тому я скористався порадами з наведених вище відповідей і зробив наступне AndroidViewModel. Зараз все виглядає чудово

Для AndroidViewModel

import android.app.Application;
import android.content.Context;
import android.content.SharedPreferences;

import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;
import androidx.preference.PreferenceManager;

public class HomeViewModel extends AndroidViewModel {

    private MutableLiveData<String> some_string;

    public HomeViewModel(Application application) {
        super(application);
        some_string = new MutableLiveData<>();
        Context context = getApplication().getApplicationContext();
        SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
        some_string.setValue("<your value here>"));
    }

}

І в Fragment

import android.os.Bundle;
import android.util.Log;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import androidx.lifecycle.Observer;
import androidx.lifecycle.ViewModelProviders;


public class HomeFragment extends Fragment {


    public View onCreateView(@NonNull LayoutInflater inflater,
                             ViewGroup container, Bundle savedInstanceState) {
        final View root = inflater.inflate(R.layout.fragment_home, container, false);
        HomeViewModel homeViewModel = ViewModelProviders.of(this).get(HomeViewModel.class);
        homeViewModel.getAddress().observe(getViewLifecycleOwner(), new Observer<String>() {
            @Override
            public void onChanged(@Nullable String address) {


            }
        });
        return root;
    }
}

Я створив це так:

@Module
public class ContextModule {

    @Singleton
    @Provides
    @Named("AppContext")
    public Context provideContext(Application application) {
        return application.getApplicationContext();
    }
}

А потім я просто додав в AppComponent ContextModule.class:

@Component(
       modules = {
                ...
               ContextModule.class
       }
)
public interface AppComponent extends AndroidInjector<BaseApplication> {
.....
}

А потім я ввів контекст у свій ViewModel:

@Inject
@Named("AppContext")
Context context;

Використовуйте такий шаблон:

class NameViewModel(
val variable:Class,application: Application):AndroidViewModel(application){
   body...
}