Android 車載應(yīng)用開發(fā)與分析 (3)- 構(gòu)建 MVVM 架構(gòu)(Java版)

前言

在大多數(shù)車載系統(tǒng)應(yīng)用架構(gòu)中,一個完整的應(yīng)用往往會包含三層:

  • HMI
    Human Machine Interface,顯示UI信息,進行人機交互。

  • Service
    在系統(tǒng)后臺進行數(shù)據(jù)處理,監(jiān)控數(shù)據(jù)狀態(tài)。

  • SDK
    根據(jù)業(yè)務(wù)邏輯Service對外暴露的通信接口,其他模塊通過它來完成IPC通信。

當(dāng)然并不是所有的應(yīng)用都需要Service,只有不能長久的駐留在內(nèi)存中,且需要監(jiān)控系統(tǒng)數(shù)據(jù)和行為的應(yīng)用才需要Service

舉個例子,系統(tǒng)的OTA需要一個Service在IVI的后臺監(jiān)控云服務(wù)或SOA接口的消息,然后完成升級包的下載等。也需要一個HMI顯示升級的Release Note、確認用戶是否同意升級等,這個HMI往往會被歸納在系統(tǒng)設(shè)置中。ServiceHMI之間的IPC通信,則需要暴露一個SDK來完成,這個其他模塊的HMI也可以通過這個SDK完成與Service的IPC通信。

反例則是,Launcher 可以長久的駐留在內(nèi)存,所以它也就不需要ServiceSDK

本篇文章主要講解,如在HMI層中構(gòu)建一個適合車載系統(tǒng)應(yīng)用的MVVM架構(gòu)。本文涉及的源碼:https://github.com/linux-link/CarMvvmArch

MVVM 架構(gòu)分層邏輯

MVVM 架構(gòu)的原理以及與MVC&MVP的區(qū)別,網(wǎng)上已經(jīng)有很多相關(guān)的優(yōu)秀文章,這里就不再贅述,本篇文章將聚焦如何車載應(yīng)用中利用Jetpack組件將 MVVM 架構(gòu)真正落地實現(xiàn)。

圖-1 MVVM架構(gòu)圖

當(dāng)前的Android應(yīng)用的MVVM架構(gòu)分層邏輯,都源自圖-2 Android官方給出的指導(dǎo)建議,我們也同樣基于這套邏輯來實現(xiàn)MVVM架構(gòu)。

圖-2 Android官方推薦的APP架構(gòu)設(shè)計圖

封裝適合車載應(yīng)用 MVVM 框架

車載應(yīng)用相對于手機應(yīng)用來說開發(fā)周期和復(fù)雜度都要小很多,所以我們封裝的重點是View層,ViewModel 層和 Model 層的封裝則會相對簡單一些。

封裝 Model 層

一般來說我們會把訪問網(wǎng)絡(luò)的工具類封裝在Model層,但是車載系統(tǒng)應(yīng)用的 HMI 層通常沒有訪問網(wǎng)絡(luò)的功能,所以 Model 層我們直接留空即可。

public abstract class BaseRepository {

}

封裝 ViewModel 層

VideModel 層的封裝很簡單,只需要將Model的實例傳入,方便 ViewModel 的實現(xiàn)類調(diào)用即可。

封裝 ViewModel

public abstract class BaseViewModel<M extends BaseRepository> extends ViewModel {

    protected M mRepository;

    public BaseViewModel(M repository) {
        mRepository = repository;
    }

    public M getRepository() {
        return mRepository;
    }
}

封裝 AndroidViewModel

public abstract class BaseAndroidViewModel<M extends BaseRepository> extends AndroidViewModel {

    protected M mRepository;

    public BaseAndroidViewModel(Application application, @Nullable M repository) {
        super(application);
        mRepository = repository;
    }

    public M getRepository() {
        return mRepository;
    }
}

封裝 View 層

在 View 層中我們需要引入DatabindingViewModel,并且定義出 View 的一些實現(xiàn)規(guī)范。

在實際使用中,并不是每一個界面都需要使用MVVM架構(gòu), 所以需要額外封裝一個只引入DatabindingFrangmentActivity

基于 DataBinding 封裝 Fragment

public abstract class BaseBindingFragment<V extends ViewDataBinding> extends BaseFragment {

    private static final String TAG = TAG_FWK + BaseBindingFragment.class.getSimpleName();

    protected V mBinding;

    @Nullable
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater,
                             @Nullable ViewGroup container,
                             @Nullable Bundle savedInstanceState) {
        LogUtils.logV(TAG, "[onCreateView]");
        if (getLayoutId() == 0) {
            throw new RuntimeException("getLayout() must be not null");
        }
        mBinding = DataBindingUtil.inflate(inflater, getLayoutId(), container, false);
        mBinding.setLifecycleOwner(this);
        mBinding.executePendingBindings();
        initView();
        return mBinding.getRoot();
    }

    protected abstract void initView();

    @LayoutRes
    protected abstract int getLayoutId();

    public V getBinding() {
        return mBinding;
    }
}

BindingFragment 的基礎(chǔ)上添加 ViewModel

public abstract class BaseMvvmFragment<Vm extends BaseViewModel, V extends ViewDataBinding> extends BaseBindingFragment<V> {

    protected Vm mViewModel;

    @Nullable
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        initViewModel();
        View view = super.onCreateView(inflater, container, savedInstanceState);
        initObservable(mViewModel);
        if (getViewModelVariable() != 0) {
            mBinding.setVariable(getViewModelVariable(), mViewModel);
        }
        return view;
    }

    @Override
    public void onStart() {
        super.onStart();
        loadData(getViewModel());
    }

    private void initViewModel() {
        Class<Vm> modelClass;
        Type type = getClass().getGenericSuperclass();
        if (type instanceof ParameterizedType) {
            modelClass = (Class<Vm>) ((ParameterizedType) type).getActualTypeArguments()[0];
        } else {
            modelClass = (Class<Vm>) BaseViewModel.class;
        }
        Object  object = getViewModelOrFactory();
        if (object instanceof ViewModel){
            mViewModel = (Vm) object;
        }else if (object instanceof ViewModelProvider.Factory){
            mViewModel = new ViewModelProvider(this, (ViewModelProvider.Factory) object)
                    .get(modelClass);
        }else {
            mViewModel = new ViewModelProvider(this,
                    new ViewModelProvider.NewInstanceFactory()).get(modelClass);
        }
    }

    protected abstract Object getViewModelOrFactory();

    protected abstract int getViewModelVariable();

    protected abstract void initObservable(Vm viewModel);

    protected abstract void loadData(Vm viewModel);

    protected Vm getViewModel() {
        return mViewModel;
    }
}

基于 DataBinding 封裝 Activity

public abstract class BaseBindingActivity<V extends ViewDataBinding> extends BaseActivity {

    protected V mBinding;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        if (getLayoutId() == 0) {
            throw new RuntimeException("getLayout() must be not null");
        }
        mBinding = DataBindingUtil.setContentView(this, getLayoutId());
        mBinding.setLifecycleOwner(this);
        mBinding.executePendingBindings();
        initView();
    }

    @LayoutRes
    protected abstract int getLayoutId();

    public V getBinding() {
        return mBinding;
    }

    protected abstract void initView();
}

在 BindingActivity 的基礎(chǔ)上添加 ViewModel

public abstract class BaseMvvmActivity<Vm extends BaseViewModel, V extends ViewDataBinding> extends BaseBindingActivity<V> {

    protected Vm mViewModel;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        initViewModel();
        super.onCreate(savedInstanceState);
        if (getViewModelVariable() != 0) {
            mBinding.setVariable(getViewModelVariable(), mViewModel);
        }
        mBinding.executePendingBindings();
        initObservable(mViewModel);
    }

    @Override
    protected void onStart() {
        super.onStart();
        loadData(mViewModel);
    }

    private void initViewModel() {
        Class<Vm> modelClass;
        Type type = getClass().getGenericSuperclass();
        if (type instanceof ParameterizedType) {
            modelClass = (Class<Vm>) ((ParameterizedType) type).getActualTypeArguments()[0];
        } else {
            modelClass = (Class<Vm>) BaseViewModel.class;
        }
        Object  object = getViewModelOrFactory();
        if (object instanceof BaseViewModel){
            mViewModel = (Vm) object;
        }else if (object instanceof ViewModelProvider.Factory){
            mViewModel = new ViewModelProvider(this, (ViewModelProvider.Factory) object)
                    .get(modelClass);
        }else {
            mViewModel = new ViewModelProvider(this,
                    new ViewModelProvider.NewInstanceFactory()).get(modelClass);
        }
    }

    protected abstract Object getViewModelOrFactory();

    protected abstract int getViewModelVariable();

    protected abstract void initObservable(Vm viewModel);

    protected abstract void loadData(Vm viewModel);

    protected Vm getViewModel() {
        return mViewModel;
    }
}

重點解釋一下幾個abstract的方法

  • Object getViewModelOrFactory()

返回ViewModel的實例或ViewModelFactory實例

  • int getViewModelVariable()

返回XML中ViewModel的Variable****Id。例如:BR.viewModel.

  • void initObservable(Vm viewModel)

在此處操作ViewModel中LiveData的。例如:下面這類方法,都應(yīng)該寫在這個方法體里面。目的是為了便于維護

viewModel.getTempLive().observe(this, new Observer<String>() {
    @Override
    public void onChanged(String temp) {
        LogUtils.logI(TAG, "[onChanged] " + temp);
    }
});

  • void initView()

在此處進行初始化UI的操作。例如:初始化RecyclerView,設(shè)定ClickListener等等。

  • void loadData(Vm viewModel)

在此處使用ViewModel進行請求用于初始化UI的數(shù)據(jù)。

基于框架實現(xiàn)MVVM架構(gòu)

接下來我們基于上面封裝的 MVVM 框架,來實現(xiàn)一個最基礎(chǔ)的 MVVM 架構(gòu)下的demo。

定義公共組件

創(chuàng)建 ViewModelFactory

定義ViewModel的實例化方式,單一Module下ViewModel的創(chuàng)建應(yīng)該集中在一個ViewModelFactory

// default 權(quán)限,不對外部公開此類
class AppViewModelFactory implements ViewModelProvider.Factory {

    // 創(chuàng)建 viewModel 實例
    @NonNull
    @Override
    public <T extends ViewModel> T create(@NonNull Class<T> modelClass) {
        try {
            if (modelClass == HvacViewModel.class) {
                return modelClass.getConstructor(HvacRepository.class, AppExecutors.class)
                        .newInstance(AppInjection.getHvacRepository(), AppExecutors.get());
            } else {
                throw new RuntimeException(modelClass.getSimpleName() + "create failed");
            }
        } catch (NoSuchMethodException | IllegalAccessException
                | InstantiationException | InvocationTargetException exception) {
            exception.printStackTrace();
            throw new RuntimeException(exception);
        }
    }
}

創(chuàng)建 AppInjection

如果應(yīng)用中沒有使用 DaggerHilt 等依賴注入框架,那么為了便于日后的維護,無論是車載應(yīng)用還是手機應(yīng)用,都建議定義一個AppInjection來將應(yīng)用中的單例、ViewModel、Repository等實例的獲取統(tǒng)一到一個入口程序中。

public class AppInjection {

    // ViewModel 工廠
    private final static AppViewModelFactory mViewModelFactory = new AppViewModelFactory();

    public static <T extends ViewModel> T getViewModel(ViewModelStoreOwner store, Class<T> clazz) {
        return new ViewModelProvider(store, mViewModelFactory).get(clazz);
    }

    public static AppViewModelFactory getViewModelFactory() {
        return mViewModelFactory;
    }

    /**
     * 受保護的權(quán)限,除了ViewModel,其它模塊不應(yīng)該需要Model層的實例
     *
     * @return {@link HvacRepository}
     */
    protected static HvacRepository getHvacRepository() {
        return new HvacRepository(getHvacManager());
    }

    public static HvacManager getHvacManager() {
        return HvacManager.getInstance();
    }

}

構(gòu)建 Model 層

在車載應(yīng)用中 Model 層的主要數(shù)據(jù)源無外乎 有三種網(wǎng)絡(luò)數(shù)據(jù)源HMI本地數(shù)據(jù)源IPC(進程間通信)數(shù)據(jù)源,其中最常見的是只有IPC數(shù)據(jù)源,三種數(shù)據(jù)源都有的情況往往會出現(xiàn)在主機廠商自行開發(fā)的車載地圖應(yīng)用中。所以我們這里只考慮如何基于IPC數(shù)據(jù)源構(gòu)造Model

定義一個 XXX``Repository 繼承自 BaseRepository,再根據(jù)業(yè)務(wù)需要定義出我們需要使用的接口,這里的HvacManager就是service提供的用來進行跨進程通信的IPC-SDK中的入口。

public class HvacRepository extends BaseRepository {

    private static final String TAG = IpcApp.TAG_HVAC + HvacRepository.class.getSimpleName();

    private final HvacManager mHvacManager;
    private HvacCallback mHvacViewModelCallback;

    private final IHvacCallback mHvacCallback = new IHvacCallback() {
        @Override
        public void onTemperatureChanged(double temp) {
            if (mHvacViewModelCallback != null) {
                // 處理遠程數(shù)據(jù),講他轉(zhuǎn)換為應(yīng)用中需要的數(shù)據(jù)格式或內(nèi)容
                String value = String.valueOf(temp);
                mHvacViewModelCallback.onTemperatureChanged(value);
            }
        }
    };

    public HvacRepository(HvacManager hvacManager) {
        mHvacManager = hvacManager;
        mHvacManager.registerCallback(mHvacCallback);
    }

    public void clear() {
        mHvacManager.unregisterCallback(mHvacCallback);
    }

    public void requestTemperature() {
        LogUtils.logI(TAG, "[requestTemperature]");
        mHvacManager.requestTemperature();
    }

    public void setTemperature(int temperature) {
        LogUtils.logI(TAG, "[setTemperature] " + temperature);
        mHvacManager.setTemperature(temperature);
    }

    public void setHvacListener(HvacCallback callback) {
        LogUtils.logI(TAG, "[setHvacListener] " + callback);
        mHvacViewModelCallback = callback;
    }

    public void removeHvacListener(HvacCallback callback) {
        LogUtils.logI(TAG, "[removeHvacListener] " + callback);
        mHvacViewModelCallback = null;
    }

}

Repository通過一個HvacCallback將監(jiān)聽的遠程數(shù)據(jù)處理后返回給ViewModel

如果應(yīng)用會與多個不同的模塊進行IPC通信,那么建議將這些由不同模塊提供的IPC-SDK封裝在一個Manager中進行統(tǒng)一管理。

構(gòu)建ViewModel

在Jetpack中ViewModel的用途是封裝界面控制器的數(shù)據(jù),以使數(shù)據(jù)在配置更改后仍然存在。在Android的MVVM 架構(gòu)設(shè)計中,ViewModel是最關(guān)鍵的一層,通過持有Repository的引用來進行外部通信

public class HvacViewModel extends BaseViewModel<HvacRepository> {

    private static final String TAG = IpcApp.TAG_HVAC + HvacViewModel.class.getSimpleName();

    private final HvacRepository mRepository;
    // 線程池框架。某些場景,ViewModel訪問Repository中的方法可能會需要切換到子線程。
    private final AppExecutors mAppExecutors;
    private MutableLiveData<String> mTempLive;

    private final HvacCallback mHvacCallback = new HvacCallback() {
        @Override
        public void onTemperatureChanged(String temp) {
            LogUtils.logI(TAG, "[onTemperatureChanged] " + temp);
            getTempLive().postValue(temp);
        }
    };

    public HvacViewModel(HvacRepository repository, AppExecutors executors) {
        super(repository);
        mRepository = repository;
        mAppExecutors = executors;
        mRepository.setHvacListener(mHvacCallback);
    }

    @Override
    protected void onCleared() {
        super.onCleared();
        mRepository.removeHvacListener(mHvacCallback);
        mRepository.release();
    }

    /**
     * 請求頁面數(shù)據(jù)
     */
    public void requestTemperature() {
        mRepository.requestTemperature();
    }

    /**
     * 將溫度數(shù)據(jù)設(shè)定到Service中
     *
     * @param view
     */
    public void setTemperature(View view) {
        mRepository.setTemperature(getTempLive().getValue());
    }

    public MutableLiveData<String> getTempLive() {
        if (mTempLive == null) {
            mTempLive = new MutableLiveData<>();
        }
        return mTempLive;
    }
}

構(gòu)建View層

最后就是構(gòu)建View層,一把就是Activity/Fragment和XML。

HvacActivity中各個方法含義我們上面封裝BaseMvvmActivity的時候已經(jīng)解釋過了,這里不再贅述。

public class HvacActivity extends BaseMvvmActivity<HvacViewModel, ActivityHvacBinding> {

    private static final String TAG = IpcApp.TAG_HVAC + HvacActivity.class.getSimpleName();

    @Override
    protected int getLayoutId() {
        return R.layout.activity_hvac;
    }

    @Override
    protected Object getViewModelOrFactory() {
        return AppInjection.getViewModelFactory();
    }

    @Override
    protected int getViewModelVariable() {
        return BR.viewModel;
    }

    @Override
    protected void initView() {

    }

    @Override
    protected void initObservable(HvacViewModel viewModel) {
        viewModel.getTempLive().observe(this, new Observer<String>() {
            @Override
            public void onChanged(String temp) {
                LogUtils.logI(TAG, "[onChanged] " + temp);
            }
        });
    }

    @Override
    protected void loadData(HvacViewModel viewModel) {
        viewModel.requestTemperature();
    }
}


<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="viewModel"
            type="com.mvvm.hmi.ipc.ui.HvacViewModel" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <Button
            android:id="@+id/btn_confirm"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="36dp"
            android:onClick="@{viewModel::setTemperature}"
            android:text="確定"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintHorizontal_bias="0.498"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@+id/et_temperature" />

        <EditText
            android:id="@+id/et_temperature"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginStart="8dp"
            android:text="@={viewModel.tempLive}"
            app:layout_constraintBottom_toBottomOf="@+id/textView"
            app:layout_constraintStart_toEndOf="@+id/textView"
            app:layout_constraintTop_toTopOf="@+id/textView" />

        <TextView
            android:id="@+id/textView"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginStart="24dp"
            android:layout_marginTop="24dp"
            android:text="Temperature:"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

以上就是如何封裝一個適合車載應(yīng)用使用的 MVVM 框架。不知道你有沒有發(fā)現(xiàn),在HMI中使用AIDL方法。通常是比較麻煩的。我們需要在HMI與Service完成綁定后,我們才能調(diào)用Service中實現(xiàn)的Binder方法。但是示例中我們使用的SDK,并沒進行綁定操作,而是直接進行調(diào)用。關(guān)于如何編寫基于AIDL的SDK,就放到下一章再介紹,感謝您的閱讀。

本文所涉及的源碼請訪問:https://github.com/linux-link/CarMvvmArch

參考資料

應(yīng)用架構(gòu)指南 | Android 開發(fā)者 | Android Developers

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 47,699評論 2 370

推薦閱讀更多精彩內(nèi)容