Databinding與LiveData的合做

背景

在谷歌官方的最新框架中咱們能夠學到的一個新組件就是LiveData,可以監聽生命週期的變化而且在適當的生命週期中回調方法,有效的解決了以前須要處理回調中View消失的問題。在使用層面上利用LiveData可以消除掉以前MVP中關於View的生命週期控制等相似的問題。html

可是在使用的過程當中,會發現一個弊端就是當你使用LiveData控制的數據,須要展現到界面上時,你須要將一個LiveData數據變成Observable類型的數據,而後經過Databinding進行綁定。雖然他們是內容是相同的,可是仍須要作一層轉化。java

這裏說一下各自的優勢,簡單的歸納一下:android

  • LiveData:與生命週期關聯,可以實如今特定的生命週期中進行回調。
  • Observable:可以與UI進行雙向綁定。

從最開始使用LiveData時,就在思考一個問題,有沒有方法可以消除掉這一層的轉化,或者說有沒有一種新的數據類型,既能與生命週期關聯,又能與UI進行雙向綁定。慚愧的說嘗試一番,無果。在學習LiveData的過程當中,在官方的issue中看到做者正在着手解決這個痛點,不過一直都沒有最新的消息。直到這個新年的第一個工做日。git

最新進展

新年第一天上班,打開電腦,習慣性的把平常的Android站點都逛一遍,就發現了一篇新的文章介紹說官方已經在最新的Androdi Studio 3.1 canary6預覽版中加入了LiveDataDatabinding的處理,不用再進行轉換才能響應到UI上了,文章還給了一個小的例子。那個文章的地址會放在爲文末,還有對應的github地址。看到這個,我立刻就嘗試了一下,下面就都是流水帳了。github

下載最新預覽版Studio

預覽版地址
安裝和建立一個普通的項目這裏都不說了。而後就是添加依賴:api

dependencies {
 	...
    implementation 'android.arch.lifecycle:extensions:1.0.0'
    annotationProcessor 'android.arch.lifecycle:compiler:1.0.0'
    ...
}
複製代碼

這裏就引用最基本的一個extension就能夠了。在添加這兩個依賴的時候操做起來特別的卡,不知道是我電腦的問題仍是最新的這個Studio的問題。數組

寫個小例子

這裏我建立了一個MainViewModel,用於測試,直接上代碼,基本都沒有難度:bash

public class MainViewModel extends ViewModel {

    public final MutableLiveData<String> input = new MutableLiveData<>();
    public final MutableLiveData<String> include_string = new MutableLiveData<>();
    Handler handler;

    public MainViewModel() {
        input.setValue("test");
        include_string.setValue("include_string");
        handler = new Handler();
    }

    public void onClick() {
        Random random = new Random();
        input.setValue(random.nextInt(100) + "");
        include_string.setValue(random.nextInt(100) + "");
    }

    public void onAsyncClick() {
        final Random random = new Random();

        handler.postDelayed(new Runnable() {
            @Override
            public void run() {
                input.setValue(random.nextInt(100) + "async");
                include_string.setValue(random.nextInt(100) + "async");
            }
        }, 5000);
    }
    
}
複製代碼

這裏有兩個string,分別對應兩個EditText,一個是正常界面裏的,一個是include進來的。兩個點擊事件,一個是正常的,一個是異步的。框架

看一下MainActivity:dom

public class MainActivity extends AppCompatActivity {
    ActivityMainBinding mBinding;
    MainViewModel mainViewModel;
    String TAG = "TAG";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);
        mainViewModel = ViewModelProviders.of(this, new ViewModelProvider.NewInstanceFactory()).get(MainViewModel.class);
        mBinding.setViewModel(mainViewModel);
        mBinding.setLifecycleOwner(this);
        mBinding.input.addTextChangedListener(new TextWatcher() {
            @Override
            public void beforeTextChanged(CharSequence s, int start, int count, int after) {
                Log.d(TAG, "beforeTextChanged: ");
            }

            @Override
            public void onTextChanged(CharSequence s, int start, int before, int count) {
                Log.d(TAG, "onTextChanged: ");
            }

            @Override
            public void afterTextChanged(Editable s) {
                if (s != null) {
                    Log.d("TAG", "afterTextChanged: " + s.toString());
                } else {
                    Log.d("TAG", "afterTextChanged: " + "null");
                }
                Log.d(TAG, "afterTextChanged: " + mainViewModel.input.getValue());
            }
        });
        mBinding.includeView.setLifecycleOwner(this);
        mBinding.includeView.setViewModel(mainViewModel);
    }
}

複製代碼

先是綁定下佈局,而後建立個MainViewModel,以後就是將ViewModel綁定到View上,而後就是新的API了, 也是最爲重要的方法,給當前的Databinding添加生命週期的擁有者,而後我給當前界面的EditText添加了一個監聽。關於include的一會再聊,跑一下以後,你就會發現項目正常運行,而且當MainViewModel中數據改變,UI也會跟着改變。

這裏須要給以前不是特別熟悉LiveDataDatabinding的小夥伴們說一下,一般狀況下,Databinding可以通知到Ui的數據,必須得是繼承自BaseObsevable的。可是上面的例子中並無,那麼是若是進行通知的那?

原始後代碼解讀

先從setLifecycleOwner()開始:

@MainThread
    public void setLifecycleOwner(@Nullable LifecycleOwner lifecycleOwner) {
    	 //先判斷當前mLifecycleOwner相同,相同返回
        if (mLifecycleOwner == lifecycleOwner) {
            return;
        }
        //當前有,可是不一致的話先將先前的LifecycleObserver移除
        if (mLifecycleOwner != null) {
            mLifecycleOwner.getLifecycle().removeObserver(mOnStartListener);
        }
        //賦新值
        mLifecycleOwner = lifecycleOwner;
        if (lifecycleOwner != null) {
        	//從新添加LifecycleObserver,若是以前有就添加以前的,沒有就新建立一個。
            if (mOnStartListener == null) {
                mOnStartListener = new OnStartListener();
            }
            lifecycleOwner.getLifecycle().addObserver(mOnStartListener);
        }
        //將全部的註冊的UI變化須要響應監聽對象都設置當前的lifecycleOwner。
        for (WeakListener<?> weakListener : mLocalFieldObservers) {
            if (weakListener != null) {
                weakListener.setLifecycleOwner(lifecycleOwner);
            }
        }
    }
複製代碼

我的對Databinding不是特別熟悉,不過這個方法的主要目的仍是給當前的lifecycleOwner,添加一個生命週期的觀察者,而後將全部的須要進行響應的都註冊到這個lifecycleOwner上。看一下OnStartListener 這個監聽。

public class OnStartListener implements LifecycleObserver {
        private OnStartListener() {
        }

        @OnLifecycleEvent(Lifecycle.Event.ON_START)
        public void onStart() {
            executePendingBindings();
        }
    }
複製代碼

能夠看到只有一個ON_START的生命週期事件,當上面的lifecycleOwnerON_START的時候會調用到executePendingBindings()方法;

這裏原始代碼層面的就沒有了,新添加了一個方法,用於設置當前的生命週期持有者,而後給這個持有者添加一個只接收ON_START事件的生命週期觀察者,當生命週期可用的時候刷新當前頁面的數據。

編譯後代碼解讀

在上面的例子中使用LiveData通知到View上有兩種狀況:

  1. 在當前的View是可用的狀況下,更新數據,直接修改UI。
  2. 在當前的View是不可用的狀況下,更新數據,等待View是可用的,而後修改UI。

第二種狀況中判斷Ui是不是可用的,而後調用刷新數據的就是上文的OnStartListener

針對第一種狀況,思考一下,是如何作到的當LiveData數據修改的時候,可以通知DataBinding 刷新對應的UI的呢?

這裏先看一個DataBinding的核心函數:

@Override
    protected void executeBindings() {
        long dirtyFlags = 0;
        synchronized(this) {
            dirtyFlags = mDirtyFlags;
            mDirtyFlags = 0;
        }
        java.lang.String viewModelInputGetValue = null;
        android.arch.lifecycle.MutableLiveData<java.lang.String> viewModelInput = null;
        com.example.huangbaole.databindinglivedata.MainViewModel viewModel = mViewModel;

        if ((dirtyFlags & 0xdL) != 0) {



                if (viewModel != null) {
                    // read viewModel.input
                    viewModelInput = viewModel.input;
                }
                //*******
                updateLiveDataRegistration(0, viewModelInput);


                if (viewModelInput != null) {
                    // read viewModel.input.getValue()
                    viewModelInputGetValue = viewModelInput.getValue();
                }
        }
        // batch finished
        if ((dirtyFlags & 0xcL) != 0) {
            // api target 1

            this.includeView.setViewModel(viewModel);
        }
        if ((dirtyFlags & 0xdL) != 0) {
            // api target 1

            android.databinding.adapters.TextViewBindingAdapter.setText(this.input, viewModelInputGetValue);
        }
        if ((dirtyFlags & 0x8L) != 0) {
            // api target 1

            android.databinding.adapters.TextViewBindingAdapter.setTextWatcher(this.input, (android.databinding.adapters.TextViewBindingAdapter.BeforeTextChanged)null, (android.databinding.adapters.TextViewBindingAdapter.OnTextChanged)null, (android.databinding.adapters.TextViewBindingAdapter.AfterTextChanged)null, inputandroidTextAttrChanged);
            this.mboundView2.setOnClickListener(mCallback1);
            this.mboundView3.setOnClickListener(mCallback2);
        }
        executeBindingsOn(includeView);
    }
複製代碼

有了解過DataBinding編譯後代碼的小夥伴們都應該熟悉這個函數,與以前有些不一樣的是,當你在XML中綁定的數據是LiveData類型的時候,它對應的UpDate方法是updateLiveDataRegistration(),看一下這個方法都作了什麼?

protected boolean updateLiveDataRegistration(int localFieldId, LiveData<?> observable) {
        return updateRegistration(localFieldId, observable, CREATE_LIVE_DATA_LISTENER);
    }
複製代碼

內部調用了updateRegistration()方法,這個方式是全部的可以通知到UI的數據類型都會調用的(目前有Observable,ObservableList,ObservableMap,LiveData),這裏的主要區別是CreateWeakListener,不一樣的類型對應的生成弱引用監聽者的類型不一致。這裏使用的是CREATE_LIVE_DATA_LISTENER會建立一個LiveDataListener而後獲取持有的弱引用返回。

private boolean updateRegistration(int localFieldId, Object observable,
            CreateWeakListener listenerCreator) {
        if (observable == null) {
            return unregisterFrom(localFieldId);
        }
        WeakListener listener = mLocalFieldObservers[localFieldId];
        if (listener == null) {
        	//若是當前的fieldID沒有對應的監聽的話,那麼會調用註冊的方法
            registerTo(localFieldId, observable, listenerCreator);
            return true;
        }
        if (listener.getTarget() == observable) {
            return false;//nothing to do, same object
        }
        unregisterFrom(localFieldId);
        registerTo(localFieldId, observable, listenerCreator);
        return true;
    }
    
      protected void registerTo(int localFieldId, Object observable,
            CreateWeakListener listenerCreator) {
        if (observable == null) {
            return;
        }
        WeakListener listener = mLocalFieldObservers[localFieldId];
        if (listener == null) {
        	//使用listenerCreator建立一個當前與fieldId對應的Listener
            listener = listenerCreator.create(this, localFieldId);
            mLocalFieldObservers[localFieldId] = listener;
            if (mLifecycleOwner != null) {
            		//調用這個Listener的setLifecycleOwner方法。
                listener.setLifecycleOwner(mLifecycleOwner);
            }
        }
        listener.setTarget(observable);
    }
複製代碼

這裏跟以前的舊版本基本是一直的,只是多了一個listener.setLifecycleOwner(mLifecycleOwner);方法,在以前的listener中是沒有setLifecycleOwner這個方法的。而且也只有LiveDataListener須要這個方法,其餘的都是空實現。這裏估計後面會從新優化一下吧。

接下來就是重點了,也是LiveData可以通知UI更新的關鍵,LiveDataListener:

private static class LiveDataListener implements Observer,
            ObservableReference<LiveData<?>> {
        final WeakListener<LiveData<?>> mListener;
        LifecycleOwner mLifecycleOwner;

        public LiveDataListener(ViewDataBinding binder, int localFieldId) {
            mListener = new WeakListener(binder, localFieldId, this);
        }

        @Override
        public void setLifecycleOwner(LifecycleOwner lifecycleOwner) {
            LifecycleOwner owner = (LifecycleOwner) lifecycleOwner;
            LiveData<?> liveData = mListener.getTarget();
            if (liveData != null) {
                if (mLifecycleOwner != null) {
                    liveData.removeObserver(this);
                }
                if (lifecycleOwner != null) {
                		//這裏就是LiveDatag觀察生命週期的地方。owner是以前的mLifecycleOwner,this則是對應的響應,這是是當前類自己,回調是onChanged()
                    liveData.observe(owner, this);
                }
            }
            mLifecycleOwner = owner;
        }

        @Override
        public WeakListener<LiveData<?>> getListener() {
            return mListener;
        }

        @Override
        public void addListener(LiveData<?> target) {
            if (mLifecycleOwner != null) {
                target.observe(mLifecycleOwner, this);
            }
        }

        @Override
        public void removeListener(LiveData<?> target) {
            target.removeObserver(this);
        }

        @Override
        public void onChanged(@Nullable Object o) {
        		//這裏是LiveData觀察LifecycleOwner對應的響應,調用當前的fieldId刷新。
            ViewDataBinding binder = mListener.getBinder();
            binder.handleFieldChange(mListener.mLocalFieldId, mListener.getTarget(), 0);
        }
    }
複製代碼

目前就這麼多吧,有一個總體的輪廓。簡單總結一下

總結

當使用LiveData進行更新數據的時候,會建立一個LiveDataListener添加的當前binding的數組中 針對上文的兩種更新數據的狀況:

第一種:當LiveData更新的時候,會調用LiveDataListener中的onChange方法,而後binding會刷新對應FieldID的UI。

第二種:View從不可用到可用,調用onStart生命週期函數的時候,會調用onStartListener的onStart方法,會刷新全部的bind數據。同時因爲當前的LiveDataListener中也將LifecycleOwner訂閱到LiveData上了,因此,第一種方案應該也是會執行的,也就是說會出現重複賦值的狀況(這裏是猜想,目前沒有進行驗證)。

關於include的使用

這裏說一下include中使用LiveData的影響,默認的狀況下,我覺得只須要綁定下ViewModel就能夠,其實不是,這裏須要給include的binding 也要設置LifecycleOwner。就如我上面例子寫的那樣,估計這裏之後也可能會優化,畢竟include的View 應該會和當前的View擁有相同的LifecycleOwner吧。

收穫

對DataBinding的原理應該是更熟悉了一些吧,而後LiveData的使用應該更加的靈活,而不只僅的就是一個有用生命週期的數據,經過Lifecycle,咱們可以實現任何和生命週期相關的東西,而不只僅就是數據。做爲新年你的第一篇文章,有點水,也有些倉促,有好幾個關鍵的點,沒有進行驗證和測試,不過目前的版本不會是最終的版本,等有正式版的時候會從新寫一篇正式一點的。

相關地址

國外文章

國外文章項目地址

本文的項目地址

相關文章
相關標籤/搜索