Android ViewModel 创建实例 android viewmodel入门

官方链接：

来一波预览使用: Android 开发者 | Android Developers - 这个方法创建方法略过时，最新的是这个：ViewModel Overview | Android Developers

集成方式: Lifecycle | Android 开发者 | Android Developers

FragmentContainerView替换到了FragmentLayout来添加碎片...FragmentContainerView | Android 开发者 | Android Developers的优势在于

它带来的好处是改进了对fragment z-ordering的处理。
这个是他们使用是例子，这意味着两个fragment之前的退出和进入过渡不会互相重叠。
使用FragmentContainerView将先开启退出动画然后才是进入动画。

简单看来这些个知识，就可以照着开干了。网上很多入门文章，大部分都是来自或者说翻译自官方文档:

1. 引入下依赖

def lifecycle_version = "2.2.0"
    def fragment_version = "1.2.1"

    // ViewModel
    implementation "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version"
    // Fragment
    implementation "androidx.fragment:fragment:$fragment_version"

2. 定义实体类，继承MyViewModel

MyViewModel.java

import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;
import androidx.lifecycle.ViewModel;

public class MyViewModel extends ViewModel {
    private MutableLiveData<String> name;

    public LiveData<String> getName() {
        if (null == name) {
            name = new MutableLiveData<>();
            loadName();
        }
        return name;
    }

    private void loadName() {
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(5000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                // 子线程调用
                name.postValue("小臭臭!");
                // 只能在主线程/UI线程中使用
                // name.setValue("小臭臭!");
            }
        }).start();
    }

    /**
     * 外部设置数据啦 - 支持子线程中使用
     * @param _name
     */
    public void setName(String _name) {
        name.postValue(_name);
    }
}

说明，其实关键点就在于postValue/setValue,一旦数据发送改变，就会通知所有的订阅者。一会我们可以瞅瞅几个源码的关键点。

布局/界面走起:

activity_viewmodel.xml - 暂时不涉及到Databingding绑定数据

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">

    <!--<data>-->

    <!--<variable-->
    <!--name="myviewmodel"-->
    <!--type="com.lieyun.test.databinding.MyViewModel" />-->
    <!--</data>-->

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".databinding.ViewModelActivity">

        <TextView
            android:id="@+id/avd_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="哈哈，ViewModel"
            android:textSize="28sp"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

        <androidx.fragment.app.FragmentContainerView
            android:id="@+id/avd_fv"
            android:layout_width="match_parent"
            android:layout_height="0dp"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintTop_toBottomOf="@+id/avd_name" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

ViewModelActivity.java

import android.os.Bundle;

import androidx.appcompat.app.AppCompatActivity;
import androidx.databinding.DataBindingUtil;
import androidx.lifecycle.Observer;
import androidx.lifecycle.ViewModelProvider;

import com.lieyun.test.R;

public class ViewModelActivity extends AppCompatActivity {
    ActivityViewmodelBinding activityViewmodelBinding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //        setContentView(R.layout.activity_data_binding);
        activityViewmodelBinding = DataBindingUtil.setContentView(this, R.layout.activity_viewmodel);

        // Create a ViewModel the first time the system calls an activity's onCreate() method.
        // Re-created activities receive the same MyViewModel instance created by the first activity.
        // 当第一次调用oncreate的时候创建这个ViewModel，之后多次调用也不会创建（数据会持久保存)
        MyViewModel myViewModel = new ViewModelProvider(this).get(MyViewModel.class);
        myViewModel.getName().observe(this, new Observer<String>() {
            @Override
            public void onChanged(String s) {
                // 当Model里面异步请求成功之后，会调用name.postValue("小臭臭!")设置并通知到这里
                // 同时其他地方如果改变了这个值，这里也会更新
                activityViewmodelBinding.avdName.setText(s);
            }
        });

        // 添加碎片
        getSupportFragmentManager().beginTransaction()
                .add(R.id.avd_fv, ViewModelShareFragment.newInstance("a", "b"))
                .commit();
    }
}

碎片也一起定义：- 布局就是鼠标右键创建空碎片的时候默认的，那个不用粘贴了。。。

ViewModelShareFragment.java

import android.content.Context;
import android.os.Bundle;

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

import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Toast;

import com.lieyun.test.R;

/**
 * A simple {@link Fragment} subclass.
 * Activities that contain this fragment must implement the
 * to handle interaction events.
 * Use the {@link ViewModelShareFragment#newInstance} factory method to
 * create an instance of this fragment.
 */
public class ViewModelShareFragment extends Fragment {
    // TODO: Rename parameter arguments, choose names that match
    // the fragment initialization parameters, e.g. ARG_ITEM_NUMBER
    private static final String ARG_PARAM1 = "param1";
    private static final String ARG_PARAM2 = "param2";

    // TODO: Rename and change types of parameters
    private String mParam1;
    private String mParam2;

    public ViewModelShareFragment() {
        // Required empty public constructor
    }

    /**
     * Use this factory method to create a new instance of
     * this fragment using the provided parameters.
     *
     * @param param1 Parameter 1.
     * @param param2 Parameter 2.
     * @return A new instance of fragment ViewModelShareFragment.
     */
    // TODO: Rename and change types and number of parameters
    public static ViewModelShareFragment newInstance(String param1, String param2) {
        ViewModelShareFragment fragment = new ViewModelShareFragment();
        Bundle args = new Bundle();
        args.putString(ARG_PARAM1, param1);
        args.putString(ARG_PARAM2, param2);
        fragment.setArguments(args);
        return fragment;
    }

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        if (getArguments() != null) {
            mParam1 = getArguments().getString(ARG_PARAM1);
            mParam2 = getArguments().getString(ARG_PARAM2);
        }
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        // Inflate the layout for this fragment
        return inflater.inflate(R.layout.fragment_view_model_share, container, false);
    }

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        final MyViewModel myViewModel = new ViewModelProvider(requireActivity()).get(MyViewModel.class);
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(6000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                myViewModel.setName("我是碎片1，我设置了数据!");
            }
        }).start();
        myViewModel.getName().observe(getViewLifecycleOwner(), new Observer<String>() {
            @Override
            public void onChanged(String s) {
                Toast.makeText(requireActivity(), "如果这是碎片2，我就可以获取到碎片1的更新通知", Toast.LENGTH_LONG).show();
            }
        });
    }

    @Override
    public void onAttach(Context context) {
        super.onAttach(context);
    }

    @Override
    public void onDetach() {
        super.onDetach();
    }
}

上面部分代码就是fragment碎片官方案例改后实践...

4. 下面我们一起去简单跟一下ViewModelProvider的流程:

简单初步自我认为的总结：

其实就是维护了一个全局HashMap，负责存储所有继承ViewModel并调用new ViewModelProvider(this).get(MyViewModel.class)创建的实体Bean，而这个Bean只有一份，因此官方文档说的不管onCreate走多少次，都只会创建一个，也许就是这样的吧。然后其中定义的MutableLiveData变量添加了观察者，一旦数据调用了set/post_value的话，就会通知所有的观察者，并回调其对应类型的参数。

一下是主要流程，具体如何轮询，没细跟。。有机会可以自行封装一个lifecycle来体会一些方面的东西。

其实我突然发现LiveData LiveData Overview | Android Developers 好像已经一起实践完了。哈哈。再来比较可以的总结。

LiveData

abstract LivaData是一个可以在lifeCycle中监听的dataHolder。
注册的LifecycleOwner,active时才会更新数据，Livecycle.State.STARED,Livecycle.State.RESUMED。或者所有状态都更新observeForever(Observer)，然后手动调用removeObserver(Observer)。
Lifecycle.State.DESTROY时自动反注册，防止泄露。
onActive,onInActive
LiveData中的方法，监听是否在监听中

ViewModel
LiveData保存了ViewModel中的数据，也可以在不同的ViewModel中共享数据。
abstract ViewModel用来为Activity和Fragment准备和管理数据，管理Activity和Fragment与其它业务逻辑的交互。
Activity方向变化，新建后会重新retain旧的ViewModel
ViewModel是用来获取和保存Activity或者Fragment的信息。
ViewModel通常是通过LiveData或者AndroidDataBinding来暴露数据
ViewModel是为Ui管理数据，不应该持有UI信息。
ViewModel可以用于Activity中多个Fragment的数据共享。
      public void onStart() {
         UserModel userModel = ViewModelProviders.of(getActivity()).get(UserModel.class);
     }

MutableLiveData
可以修改的LiveData，包含setValue和poistValue，LiveData也包含，只是LiveData是abstract的。

你、我还可以再深入，只要有时间....

附加说明：

（译）Fragment 1.2 新特性