android - 使い方 - 新しいアーキテクチャコンポーネントViewModelを使用してフラグメント間でデータを共有する




viewmodelproviders (4)

GoogleはLast Google IOで、いくつかの新しいarchコンポーネントのプレビューをリリースしました。そのうちの1つはViewModelです。

docs Googleはこのコンポーネントの可能な用途の1つを示しています:

アクティビティ内の2つ以上のフラグメントが互いに通信する必要があることは非常に一般的です。 両方のフラグメントが何らかのインターフェース記述を定義する必要があるため、これは決して些細なことではありません。所有者アクティビティは2つを結合する必要があります。 さらに、両方のフラグメントは、他のフラグメントがまだ作成されていないか、表示されていない場合を処理する必要があります。

この一般的な問題点は、ViewModelオブジェクトを使用して対処できます。 ユーザーがリストからアイテムを選択するフラグメントと、選択したアイテムのコンテンツを表示する別のフラグメントがある、マスター/ディテールフラグメントの一般的なケースを想像してください。

これらのフラグメントは、アクティビティスコープを使用してこの通信を処理するViewModelを共有できます。

実装例を示します。

public class SharedViewModel extends ViewModel {
    private final MutableLiveData<Item> selected = new MutableLiveData<Item>();

    public void select(Item item) {
        selected.setValue(item);
    }

    public LiveData<Item> getSelected() {
        return selected;
    }
}

public class MasterFragment extends Fragment {
    private SharedViewModel model;
    public void onActivityCreated() {
        model = ViewModelProviders.of(getActivity()).get(SharedViewModel.class);
        itemSelector.setOnClickListener(item -> {
            model.select(item);
        });
    }
}

public class DetailFragment extends LifecycleFragment {
    public void onActivityCreated() {
        SharedViewModel model = ViewModelProviders.of(getActivity()).get(SharedViewModel.class);
        model.getSelected().observe(this, { item ->
           // update UI
        });
    }
}

フラグメントを介してアクティビティを介して通信するためにこれらのインターフェイスを使用する必要がない可能性に非常に興奮していました。

しかし、Googleの例は、マスターから詳細フラグメントをどのように呼び出すかを正確に示していません。

fragmentManager.replace(...)を呼び出すアクティビティによって実装される インターフェイス を使用する必要が あります か、または新しいアーキテクチャを使用してそれを行う別の方法がありますか?


Google Codelabsの example よると、他のソリューションと同様のソリューションが見つかりました。 2つのフラグメントがあり、片方がもう一方のオブジェクトの変更を待機し、更新されたオブジェクトを使用してプロセスを続行します。

このアプローチでは、次のようなViewModelクラスが必要です。

import android.arch.lifecycle.MutableLiveData;
import android.arch.lifecycle.ViewModel;
import yourPackage.YourObjectModel;

public class SharedViewModel extends ViewModel {

   public MutableLiveData<YourObjectModel> item = new MutableLiveData<>();

   public YourObjectModel getItem() {
      return item.getValue();
   }

   public void setItem(YourObjectModel item) {
      this.item.setValue(item);
   }

}

リスナーフラグメントは次のようになります。

public class ListenerFragment extends Fragment{
   private SharedViewModel model;
  @Override
  public void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    model = ViewModelProviders.of(getActivity()).get(SharedViewModel.class);

    model.item.observe(getActivity(), new Observer<YourObjectModel>(){

        @Override
        public void onChanged(@Nullable YourObjectModel updatedObject) {
            Log.i(TAG, "onChanged: recieved freshObject");
            if (updatedObject != null) {
                // Do what you want with your updated object here. 
            }
        }
    });
}
}

最後に、アップデータフラグメントは次のようになります。

public class UpdaterFragment extends DialogFragment{
    private SharedViewModel model;
    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       model = ViewModelProviders.of(getActivity()).get(SharedViewModel.class);
   }
   // Call this method where it is necessary
   private void updateViewModel(YourObjectModel yourItem){
      model.setItem(yourItem);
   }
}

アップデータフラグメントは任意の形式のフラグメント(DialogFragmentのみではない)であり、これらのアーキテクチャコンポーネントを使用するには、アプリのbuild.gradleファイルにこれらのコード行を含める必要があります。 source

dependencies {
  def lifecycle_version = "1.1.1"
  implementation "android.arch.lifecycle:extensions:$lifecycle_version"
}

このように、詳細フラグメントからマスターフラグメントに値を設定できます。

model.selected.setValue(item)

最終的に、独自のViewModelを使用して、Activityメソッドをトリガーするリスナーを保持します。 古い方法に 似てい ます が、私が言ったように、フラグメントではなくViewModelにリスナーを渡します。 したがって、私のViewModelは次のようになりました。

public class SharedViewModel<T> extends ViewModel {

    private final MutableLiveData<T> selected = new MutableLiveData<>();
    private OnSelectListener<T> listener = item -> {};

    public interface OnSelectListener <T> {
        void selected (T item);
    }


    public void setListener(OnSelectListener<T> listener) {
        this.listener = listener;
    }

    public void select(T item) {
        selected.setValue(item);
        listener.selected(item);
    }

    public LiveData<T> getSelected() {
        return selected;
    }

}

StepMasterActivityで、ViewModelを取得し、リスナーとして設定します。

StepMasterActivity.class:

SharedViewModel stepViewModel = ViewModelProviders.of(this).get("step", SharedViewModel.class);
stepViewModel.setListener(this);

...

@Override
public void selected(Step item) {
    Log.d(TAG, "selected: "+item);
}

...

フラグメントでは、ViewModelを取得するだけです

stepViewModel = ViewModelProviders.of(getActivity()).get("step", SharedViewModel.class);

そして電話:

stepViewModel.select(step);

私はそれを表面的にテストし、機能しました。 これに関連する他の機能を実装しようとすると、発生する可能性のある問題を認識します。


私はあなたが望むものに似たものを実装しました、私のビューモデルには列挙状態を含むLiveDataオブジェクトが含まれており、フラグメントをマスターから詳細に(または逆に)変更したい場合、livedata値を変更するViewModel関数を呼び出し、アクティビティはlivedataオブジェクトを監視しているため、フラグメントを変更します。

TestViewModel:

public class TestViewModel extends ViewModel {
    private MutableLiveData<Enums.state> mState;

    public TestViewModel() {
        mState=new MutableLiveData<>();
        mState.setValue(Enums.state.Master);
    }

    public void onDetail() {
        mState.setValue(Enums.state.Detail);
    }

    public void onMaster() {
        mState.setValue(Enums.state.Master);
    }

    public LiveData<Enums.state> getState() {

        return mState;
    }
}

列挙型:

public class Enums {
    public enum state {
        Master,
        Detail
    }
}

TestActivity:

public class TestActivity extends LifecycleActivity {
    private ActivityTestBinding mBinding;
    private TestViewModel mViewModel;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mBinding=DataBindingUtil.setContentView(this, R.layout.activity_test);
        mViewModel=ViewModelProviders.of(this).get(TestViewModel.class);
        mViewModel.getState().observe(this, new Observer<Enums.state>() {
            @Override
            public void onChanged(@Nullable Enums.state state) {
                switch(state) {
                    case Master:
                        setMasterFragment();
                        break;
                    case Detail:
                        setDetailFragment();
                        break;
                }
            }
        });
    }

    private void setMasterFragment() {
        MasterFragment masterFragment=MasterFragment.newInstance();
        getSupportFragmentManager().beginTransaction().replace(R.id.frame_layout, masterFragment,"MasterTag").commit();
    }

    private void setDetailFragment() {
        DetailFragment detailFragment=DetailFragment.newInstance();
        getSupportFragmentManager().beginTransaction().replace(R.id.frame_layout, detailFragment,"DetailTag").commit();
    }

    @Override
    public void onBackPressed() {
        switch(mViewModel.getState().getValue()) {
            case Master:
                super.onBackPressed();
                break;
            case Detail:
                mViewModel.onMaster();
                break;
        }
    }
}

MasterFragment:

public class MasterFragment extends Fragment {
    private FragmentMasterBinding mBinding;


    public static MasterFragment newInstance() {
        MasterFragment fragment=new MasterFragment();
        return fragment;
    }

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        mBinding=DataBindingUtil.inflate(inflater,R.layout.fragment_master, container, false);
        mBinding.btnDetail.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                final TestViewModel viewModel=ViewModelProviders.of(getActivity()).get(TestViewModel.class);
                viewModel.onDetail();
            }
        });

        return mBinding.getRoot();
    }
}

DetailFragment:

public class DetailFragment extends Fragment {
    private FragmentDetailBinding mBinding;

    public static DetailFragment newInstance() {
        DetailFragment fragment=new DetailFragment();
        return fragment;
    }

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        mBinding=DataBindingUtil.inflate(inflater,R.layout.fragment_detail, container, false);
        mBinding.btnMaster.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                final TestViewModel viewModel=ViewModelProviders.of(getActivity()).get(TestViewModel.class);
                viewModel.onMaster();
            }
        });
        return mBinding.getRoot();
    }
}




android-architecture-components