Android MVVMViewModelでコンテキストを取得する方法

AndroidアプリにMVVMパターンを実装しようとしています。ViewModelsには（テストを簡単にするために）Android固有のコードを含めるべきではないことを読みましたが、さまざまなこと（xmlからのリソースの取得、設定の初期化など）にコンテキストを使用する必要があります。これを行うための最良の方法は何ですか？AndroidViewModelアプリケーションコンテキストへの参照があるのを見ましたが、Android固有のコードが含まれているため、ViewModelに含める必要があるかどうかはわかりません。また、これらはアクティビティライフサイクルイベントに関連付けられていますが、コンポーネントのスコープを管理するために短剣を使用しているため、それがどのように影響するかはわかりません。私はMVVMパターンとDaggerを初めて使用するので、助けていただければ幸いです。

Applicationによって提供されるコンテキストを使用できます。これは、参照を含む単純なaをAndroidViewModel拡張する必要がAndroidViewModelあります。ViewModelApplication

Androidアーキテクチャコンポーネントのビューモデルの場合、

メモリリークとして、アクティビティコンテキストをアクティビティのViewModelに渡すことはお勧めできません。

したがって、ViewModelでコンテキストを取得するには、ViewModelクラスでAndroid ViewModelクラスを拡張する必要があります。そうすれば、以下のサンプルコードに示すようなコンテキストを取得できます。

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

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

    //... ViewModel methods 

}

テストを容易にするのは抽象化であるため、ViewModelsにテストを容易にするためのAndroid固有のコードを含めるべきではないというわけではありません。

ViewModelsにContextのインスタンスや、ViewsやContextを保持する他のオブジェクトのようなものを含めるべきではない理由は、それがアクティビティやフラグメントとは別のライフサイクルを持っているためです。

これが意味するのは、アプリで回転の変更を行ったとしましょう。これにより、アクティビティとフラグメントがそれ自体を破壊し、それ自体を再作成します。ViewModelはこの状態の間も存続することを目的としているため、破棄されたアクティビティのビューまたはコンテキストを保持していると、クラッシュやその他の例外が発生する可能性があります。

やりたいことをどのように行うべきかについては、MVVMとViewModelはJetPackのデータバインディングコンポーネントと非常にうまく機能します。通常、String、intなどを格納するほとんどの場合、データバインディングを使用してビューに直接表示させることができるため、ViewModel内に値を格納する必要はありません。

ただし、データバインディングが必要ない場合でも、コンストラクターまたはメソッド内でコンテキストを渡してリソースにアクセスできます。ViewModel内にそのコンテキストのインスタンスを保持しないでください。

簡単な答え-これをしないでください

どうして ？

ビューモデルの目的全体を無効にします

ビューモデルで実行できるほとんどすべてのことは、LiveDataインスタンスやその他のさまざまな推奨アプローチを使用して、アクティビティ/フラグメントで実行できます。

ViewModelに直接Contextを含める代わりに、最終的には、必要なリソースを提供するResourceProviderなどのプロバイダークラスを作成し、それらのプロバイダークラスをViewModelに挿入しました。

TL; DR：ViewModelのDaggerを介してアプリケーションのコンテキストを挿入し、それを使用してリソースをロードします。画像をロードする必要がある場合は、データバインディングメソッドからの引数を介してViewインスタンスを渡し、そのViewコンテキストを使用します。

MVVMは優れたアーキテクチャであり、Android開発の未来であることは間違いありませんが、まだ環境に配慮していることがいくつかあります。MVVMアーキテクチャのレイヤー通信を例にとると、さまざまな開発者（非常によく知られている開発者）がLiveDataを使用してさまざまな方法でさまざまなレイヤーを通信しているのを見てきました。それらのいくつかは、LiveDataを使用してViewModelをUIと通信しますが、コールバックインターフェイスを使用してリポジトリと通信するか、Interactors / UseCasesを使用して、LiveDataを使用してそれらと通信します。ここでのポイントは、すべてがまだ100％定義されているわけではないということです。

そうは言っても、特定の問題に対する私のアプローチは、DIを介してアプリケーションのコンテキストを利用可能にしてViewModelsで使用し、strings.xmlからStringなどを取得することです。

画像の読み込みを扱っている場合は、データバインディングアダプターメソッドからViewオブジェクトをパススルーし、Viewのコンテキストを使用して画像を読み込みます。どうして？アプリケーションのコンテキストを使用して画像を読み込むと、一部のテクノロジー（Glideなど）で問題が発生する可能性があるためです。

それが役に立てば幸い！

他の人がAndroidViewModel言ったように、アプリを入手するために導き出すことができるものがありますContextが、私がコメントで集めたものから、あなたは目的のMVVMを打ち負かす@drawableあなたの内部からsを操作しようとしてViewModelいます。

一般的には、持っている必要がContextあなたにViewModelほとんど一般には、あなたがあなたの間の論理分割の仕方を再考検討すべき示唆View秒とViewModels。

ViewModelドローアブルを解決してアクティビティ/フラグメントにフィードする代わりに、フラグメント/アクティビティに、が所有するデータに基づいてドローアブルをジャグリングさせることを検討してくださいViewModel。たとえば、オン/オフ状態のビューに表示するさまざまなドローアブルが必要です。これViewModelは（おそらくブール値の）状態を保持する必要がありViewますが、それに応じてドローアブルを選択するのはビジネスです。

DataBindingを使用すると非常に簡単に実行できます。

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

より多くの状態とドローアブルがある場合、レイアウトファイルの扱いにくいロジックを回避するために、たとえば値を（カードスーツなど）に変換するカスタムBindingAdapterを作成できます。EnumR.drawable.*

または、Context内部で使用するコンポーネントが必要な場合もあります。ViewModel次に、外部でコンポーネントを作成してViewModel渡します。DIまたはシングルトンを使用するかContext、ViewModelin Fragment/を初期化する直前に依存コンポーネントを作成できますActivity。

なぜわざわざ：ContextAndroid固有のものであり、ViewModelsのそれらに依存することは悪い習慣です：それらはユニットテストの邪魔になります。一方、独自のコンポーネント/サービスインターフェイスは完全に制御できるため、テスト用に簡単にモックすることができます。

アプリケーションコンテキストへの参照がありますが、Android固有のコードが含まれています

朗報Mockito.mock(Context.class)です。テストで必要なものを使用してコンテキストを返すことができます。

したがってViewModel、通常どおりにを使用し、通常どおりにViewModelProviders.Factoryを介してApplicationContextを指定します。

getApplication().getApplicationContext()ViewModel内からアプリケーションコンテキストにアクセスできます。これは、リソースや設定などにアクセスするために必要なものです。

ViewModelを使用する動機はJavaコードとAndroidコードを分離することであるため、ViewModelで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...
}

ViewModelにコンテキストを挿入する際の問題は、画面の回転、ナイトモード、またはシステム言語に応じて、コンテキストがいつでも変更される可能性があり、それに応じて返されるリソースが変更される可能性があることです。単純なリソースIDを返すと、getString置換などの追加パラメーターで問題が発生します。高レベルの結果を返し、レンダリングロジックをアクティビティに移動すると、テストが難しくなります。

私の解決策は、ViewModelに関数を生成して返すようにすることです。この関数は、後でアクティビティのコンテキストを介して実行されます。Kotlinの構文糖衣構文により、これは非常に簡単になります。

ViewModel.kt:

// connectedStatus holds a function that calls Context methods
// `this` can be elided
val connectedStatus = MutableLiveData<Context.() -> String> {
  // initial value
  this.getString(R.string.connectionStatusWaiting)
}
connectedStatus.postValue {
  this.getString(R.string.connectionStatusConnected, brand)
}

Activity.kt  // is a Context

override fun onCreate(_: Bundle?) {
  connectionViewModel.connectedStatus.observe(this) { it ->
   // runs the posted value with the given Context receiver
   txtConnectionStatus.text = this.run(it)
  }
}

これにより、ViewModelは、ユニットテストによって検証された、表示された情報を計算するためのすべてのロジックを保持できます。アクティビティは、バグを隠すための内部ロジックのない非常に単純な表現です。