Android体系架构组件: 绑定到ViewModel

Question

我对使用新的架构组件进行数据绑定的工作原理感到有些困惑。

假设我有一个简单的Activity，其中包含一个列表、一个ProgressBar和一个TextView。Activity应该负责控制所有视图的状态，而ViewModel应该持有数据和逻辑。 例如，我的Activity现在看起来像这样:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    binding = DataBindingUtil.setContentView(this, R.layout.activity_main);

    listViewModel = ViewModelProviders.of(this).get(ListViewModel.class);

    binding.setViewModel(listViewModel);

    list = findViewById(R.id.games_list);

    listViewModel.getList().observeForever(new Observer<List<Game>>() {
        @Override
        public void onChanged(@Nullable List<Game> items) {
            setUpList(items);
        }
    });

    listViewModel.loadGames();
}

private void setUpList(List<Game> items){
    list.setLayoutManager(new LinearLayoutManager(this));
    GameAdapter adapter = new GameAdapter();
    adapter.setList(items);
    list.setAdapter(adapter);
}

ViewModel 负责加载数据，并在列表准备好时通知 Activity，以便它可以准备适配器并显示数据：

public int progressVisibility = View.VISIBLE;

private MutableLiveData<List<Game>> list;

public void loadGames(){

    Retrofit retrofit = GamesAPI.create();

    GameService service = retrofit.create(GameService.class);

    Call<GamesResponse> call = service.fetchGames();

    call.enqueue(this);
}


@Override
public void onResponse(Call<GamesResponse> call, Response<GamesResponse> response) {
    if(response.body().response.equals("success")){
        setList(response.body().data);

    }
}

@Override
public void onFailure(Call<GamesResponse> call, Throwable t) {

}

public MutableLiveData<List<Game>> getList() {
    if(list == null)
        list = new MutableLiveData<>();
    if(list.getValue() == null)
        list.setValue(new ArrayList<Game>());
    return list;
}

public void setList(List<Game> list) {
    this.list.postValue(list);
}

我的问题是：如何正确地显示/隐藏列表、进度条和错误文本？

我应该在ViewModel中为每个视图添加一个整数，使其控制视图，然后像这样使用它：

<TextView
    android:id="@+id/main_list_error"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="@{viewModel.error}"
    android:visibility="@{viewModel.errorVisibility}" />

或者应该让ViewModel为每个属性实例化一个LiveData对象：

private MutableLiveData<Integer> progressVisibility = new MutableLiveData<>();
private MutableLiveData<Integer> listVisibility = new MutableLiveData<>();
    private MutableLiveData<Integer> errorVisibility = new MutableLiveData<>();

在需要时更新它们的值，并使Activity观察它们的值？

viewModel.getProgressVisibility().observeForever(new Observer<Integer>() {
    @Override
    public void onChanged(@Nullable Integer visibility) {
        progress.setVisibility(visibility);
    }
});

viewModel.getListVisibility().observeForever(new Observer<Integer>() {
    @Override
    public void onChanged(@Nullable Integer visibility) {
        list.setVisibility(visibility);
    }
});

viewModel.getErrorVisibility().observeForever(new Observer<Integer>() {
    @Override
    public void onChanged(@Nullable Integer visibility) {
        error.setVisibility(visibility);
    }
});

我真的很难理解这个。如果有人可以澄清一下，那就太好了。

谢谢

- jack_the_beast

---

好问题..我也有同样的困惑... - iMDroid

Answer 1

以下是简单的步骤：

public class MainViewModel extends ViewModel {

    MutableLiveData<ArrayList<Game>> gamesLiveData = new MutableLiveData<>();
    // ObservableBoolean or ObservableField are classes from  
    // databinding library (android.databinding.ObservableBoolean)

    public ObservableBoolean progressVisibile = new ObservableBoolean();
    public ObservableBoolean listVisibile = new ObservableBoolean();
    public ObservableBoolean errorVisibile = new ObservableBoolean();
    public ObservableField<String> error = new ObservableField<String>();

    // ...


    // For example we want to change list and progress visibility
    // We should just change ObservableBoolean property
    // databinding knows how to bind view to changed of field

    public void loadGames(){
        GamesAPI.create().create(GameService.class)
            .fetchGames().enqueue(this);

        listVisibile.set(false); 
        progressVisibile.set(true);
    }

    @Override
    public void onResponse(Call<GamesResponse> call, Response<GamesResponse> response) {
        if(response.body().response.equals("success")){
            gamesLiveData.setValue(response.body().data);

            listVisibile.set(true);
            progressVisibile.set(false);
        }
    }

}

然后

<data>
    <import type="android.view.View"/>

    <variable
        name="viewModel"
        type="MainViewModel"/>
</data>

...

<ProgressBar
    android:layout_width="32dp"
    android:layout_height="32dp"
    android:visibility="@{viewModel.progressVisibile ? View.VISIBLE : View.GONE}"/>

<ListView
    android:layout_width="32dp"
    android:layout_height="32dp"
    android:visibility="@{viewModel.listVisibile ? View.VISIBLE : View.GONE}"/>

<TextView
    android:id="@+id/main_list_error"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="@{viewModel.error}"
    android:visibility="@{viewModel.errorVisibile ? View.VISIBLE : View.GONE}"/>

请注意，让视图观察并非强制要求，这是由您自行决定的。

ObservableBoolean : false / true 
    // or
ObservableInt : View.VISIBLE / View.INVISIBLE / View.GONE

但对于 ViewModel 测试来说，ObservableBoolean 更好。

此外，考虑到生命周期，您应该观察 LiveData：

@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    listViewModel.getList().observe((LifecycleOwner) this, new Observer<List<Game>>() {
        @Override
        public void onChanged(@Nullable List<Game> items) {
            setUpList(items);
        }
    });
}

- Yurii Kot

---

谢谢您的回答，我会尽快尝试。在我尝试之前，我将把它标记为已接受。我还有一个问题：这会使视图模型直接控制视图，这不应该发生，对吧？ - jack_the_beast

不完全是。ViewModel 只描述逻辑，而 View 观察所有需要的内容。一旦 View 不存在，就不会抛出 NPE。我理解你的问题了吗？哦，我在代码中犯了一个错误，它不应该包含 setList() 调用，而只需在 ViewModel 中更新 LiveData，然后活动观察 LiveData 并调用 setList 方法。 - Yurii Kot

大致上是的。仍然需要努力更好地理解一切 :) - jack_the_beast

onResponse函数从哪里来？如果您能详细说明一下这个函数，那就太好了。 - David

@David 这个方法是提问者的方法。 - Yurii Kot

Answer 2

这里是实现你的目标的简单步骤。

首先，让你的ViewModel公开一个LiveData对象，并且你可以用空值开始LiveData。

private MutableLiveData<List<Game>> list = new MutableLiveData<>();

public MutableLiveData<List<Game>> getList() {
    return list;
}

其次，让您的视图（活动/片段）观察该LiveData并相应地更改UI。

listViewModel = ViewModelProviders.of(this).get(ListViewModel.class);
listViewModel.data.observe(this, new Observer<List<Game>>() {
    @Override
    public void onChanged(@Nullable final List<Game> games) {
        setUpList(games);
    }
});

在这里，重要的是使用observe（LifecycleOwner，Observer）变量，以便您的观察者在LifecycleOwner不再处于活动状态后不会接收事件，基本上，这意味着当您的活动或片段不再处于活动状态时，您不会泄漏该侦听器。

第三，由于数据变得可用，您需要更新LiveData对象。

@Override
public void onResponse(Call<GamesResponse> call, Response<GamesResponse> response) {
    if(response.body().response.equals("success")){
        List<Game> newGames = response.body().data; // Assuming this is a list
        list.setValue(newGames); // Update your LiveData object by calling setValue
    }
}

通过在您的LiveData上调用setValue()，这将导致视图侦听器上的onChanged被调用，并且您的UI应该自动更新。

- elmorabea

---

但是那不使用数据绑定，我错了吗？其实，问题是：我如何在架构组件中使用数据绑定？ - jack_the_beast

如果你想使用数据绑定，也许可以使用ObservableField而不是LiveData，但我不认为将它们结合起来会有什么价值，因为它们基本上做的是相同的事情。LiveData具有生命周期感知的优势，我想。 - elmorabea