天天看點

MVVM+元件化+Arouter實作

code小生 一個專注大前端領域的技術平台公衆号回複

Android

加入安卓技術群

作者:孤縌

連結:https://www.jianshu.com/p/452c40b9a11c

聲明:本文已獲

孤縌

授權發表,轉發等請聯系原作者授權

MVVM+元件化實作

子產品概覽

底層子產品:common、network、resource

功能子產品:player、firebase、pay

界面子產品:mobile、tablet、tablet_login

殼子產品: app

子產品實作

1.公共子產品的gradle配置

由于不同子產品,可能引用相同的依賴庫,那麼對于這部分共同的子產品則需要提取出來做統一的管理,是以在項目的根目錄建立了common.gradle。

//project是根項目,可以簡單認為是個對象,對象持有一個名詞為ext的成員變量
project.ext {
    
    //基本的變量配合和版本控制
    compileSdkVersion = 30
    buildToolsVersion = "30"
    minSdkVersion = 21
    targetSdkVersion = 30
    applicationId = "com.sdmc.xmediatv"
    versionCode = 4
    versionName = "4.7.0"

    //設定app配置
    setAppDefaultConfig = {
        extension ->
            //指定為application,代表該子產品可以單獨調試
            extension.apply plugin: 'com.android.application'
            extension.description "app"
            
            //公共的apply 主要是用于三方庫
            extension.apply plugin: 'kotlin-android'
            extension.apply plugin: 'kotlin-android-extensions'
            extension.apply plugin: 'kotlin-kapt'
          
            //設定項目的android
            setAppAndroidConfig extension.android
            //設定項目的三方庫依賴
            setDependencies extension.dependencies

    }

    //設定lib配置(隻可以作為lib,不可單獨調試)
    setLibDefaultConfig = {
        extension ->
            //library,代表隻是單純的庫,不需要依賴其他子產品
            extension.apply plugin: 'com.android.library'
            extension.description "lib"
           
            setLibAndroidConfig extension.android
            setDependencies extension.dependencies
    }

    //是否允許module單獨調試
    isModuleDebug = false
    //動态改變,用于單子產品調試
    setAppOrLibDefaultConfig = {
        extension ->
            if (project.ext.isModuleDebug) {
                extension.apply plugin: 'com.android.application'
                extension.description "app"
            } else {
                extension.apply plugin: 'com.android.library'
                extension.description "lib"

            }
            extension.apply plugin: 'kotlin-android'
            extension.apply plugin: 'kotlin-android-extensions'
            extension.apply plugin: 'kotlin-kapt'
            //設定通用Android配置
            setAppOrLibAndroidConfig extension.android
            //設定通用依賴配置
            setDependencies extension.dependencies
    }

    //設定application 公共的android配置
    setAppAndroidConfig = {
        extension -> //extension 相當于 android 對象
            extension.compileSdkVersion project.ext.compileSdkVersion
            extension.buildToolsVersion project.ext.buildToolsVersion
            extension.defaultConfig {
                applicationId project.ext.applicationId
                minSdkVersion project.ext.minSdkVersion
                targetSdkVersion project.ext.targetSdkVersion
                versionCode project.ext.versionCode
                versionName project.ext.versionName

                extension.flavorDimensions "versionCode"


                testInstrumentationRunner "android.support.tablet_test.runner.AndroidJUnitRunner"

                //ARouter 編譯生成路由
                kapt {
                    arguments {
                        arg("AROUTER_MODULE_NAME", project.getName())
                        includeCompileClasspath = true
                    }

                }
            }
            extension.buildFeatures {
                dataBinding = true
                // for view binding :
                // viewBinding = true
            }
    }

    //設定lib 公共的android配置
    setLibAndroidConfig = {
        extension -> //extension 相當于 android 對象
            extension.compileSdkVersion project.ext.compileSdkVersion
            extension.buildToolsVersion project.ext.buildToolsVersion
            extension.defaultConfig {
                minSdkVersion project.ext.minSdkVersion
                targetSdkVersion project.ext.targetSdkVersion
                versionCode project.ext.versionCode
                versionName project.ext.versionName

                testInstrumentationRunner "android.support.tablet_test.runner.AndroidJUnitRunner"

                //ARouter 編譯生成路由
                /*kapt {
                    arguments {
                        arg("AROUTER_MODULE_NAME", project.getName())
                    }
                }*/
            }
            extension.buildFeatures {
                dataBinding = true
                // for view binding :
                // viewBinding = true
            }
    }

    //設定通用的 android配置(可作為project單獨調試)
    setAppOrLibAndroidConfig = {
        extension -> //extension 相當于 android 對象
            extension.compileSdkVersion project.ext.compileSdkVersion
            extension.buildToolsVersion project.ext.buildToolsVersion
            extension.defaultConfig {
                minSdkVersion project.ext.minSdkVersion
                targetSdkVersion project.ext.targetSdkVersion
                versionCode project.ext.versionCode
                versionName project.ext.versionName

                extension.flavorDimensions "versionCode"


                testInstrumentationRunner "android.support.tablet_test.runner.AndroidJUnitRunner"

                //ARouter 編譯生成路由
                kapt {
                    arguments {
                        arg("AROUTER_MODULE_NAME", project.getName())
                        includeCompileClasspath = true
                    }

                }

            }
            extension.buildFeatures {
                //啟用自動綁定view id
                dataBinding = true
            }
        
            //使用的jdk版本
            extension.compileOptions {
                sourceCompatibility JavaVersion.VERSION_1_8
                targetCompatibility JavaVersion.VERSION_1_8
            }
            extension.kotlinOptions {
                jvmTarget = JavaVersion.VERSION_1_8
            }

            //動态改變清單檔案資源指向
            extension.sourceSets {
                main {
                    if (project.ext.isModuleDebug) {
                        manifest.srcFile 'src/main/manifest/AndroidManifest.xml'
                    } else {
                        manifest.srcFile 'src/main/AndroidManifest.xml'
                    }
                }
            }

    }


    //公用的三方庫依賴,慎重引入,主要引入基礎庫依賴
    setDependencies = {
        extension ->
            extension.implementation fileTree(dir: 'libs', include: ['*.jar'])
            extension.kapt 'com.alibaba:arouter-compiler:1.2.2'

            //ARouter 路由apt插件,用于生成相應代碼,每個module都需要
            extension.implementation 'com.alibaba:arouter-api:1.5.0'
            extension.implementation 'com.alibaba:arouter-compiler:1.2.2'
            extension.implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
            extension.implementation 'androidx.core:core-ktx:1.3.1'
            extension.implementation 'com.google.code.gson:gson:2.8.6'
            extension.implementation 'androidx.appcompat:appcompat:1.2.0'
            extension.implementation 'androidx.constraintlayout:constraintlayout:2.0.0'
            extension.implementation 'androidx.recyclerview:recyclerview:1.0.0'
    }
}
           

根目錄的build.gradle:

buildscript {
    //統一制定版本
    ext.kotlin_version = '1.4.31'
    ext.google_service_version = '19.7.0'
    ext.exoplayer_version = '2.13.2'
    
    repositories {
        //為目前的build.gradle設定依賴庫中心
        google()
        jcenter()
    }
    dependencies {
        //gradle版本
        classpath "com.android.tools.build:gradle:4.0.1"
        //kotlin依賴
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        //bintray.com maven的依賴
        classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0"
        //sonatype maven的依賴
        classpath "com.github.dcendents:android-maven-gradle-plugin:1.5"
        //黃油刀
        classpath 'com.jakewharton:butterknife-gradle-plugin:10.2.3'
        //谷歌服務
        classpath 'com.google.gms:google-services:4.3.3'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        //jitpack庫
        maven { url 'http://www.jitpack.io' }
        //bintray.com維護的Maven倉庫
        jcenter()
        //谷歌maven庫
        maven { url "https://maven.google.com" }
        google()
        //阿裡雲鏡像maven庫位址
        maven {
            url "http://maven.aliyun.com/nexus/content/repositories/releases"
        }
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}
           

2.殼app子產品的實作

//從項目的根目錄中找到common.gradle
apply from: "${rootProject.rootDir}/common.gradle"

//project.ext則是之前強調的common.gradle中的對象,該對象有setAppDefaultConfig
project.ext.setAppDefaultConfig project

//由于setAppDefaultConfig中的android配置是通用配置,是以還需要針對殼本身新增配置
android {

    //混淆規則配置
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }

        debug {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

    packagingOptions {
        //nanohttpd輕量級資料庫所需
        exclude 'META-INF/nanohttpd/default-mimetypes.properties'
        exclude 'META-INF/nanohttpd/mimetypes.properties'
        //為了解決部分第三方庫重複打包了META-INF的問題
        exclude 'META-INF/NOTICE'
        exclude 'META-INF/LICENSE'
        //解決kotlin問題
        exclude("META-INF/*.kotlin_module")
    }

    compileOptions {
        sourceCompatibility = '1.8'
        targetCompatibility = '1.8'
    }

    kotlinOptions {
        jvmTarget = "1.8"
    }

    //在本地loacl.propreties中配置打包所需資訊
    Properties properties = new Properties()
    InputStream inputStream = project.rootProject.file('local.properties').newDataInputStream()
    properties.load(inputStream)
    def sdkDir = properties.getProperty('key.file')
    def keyFile = file(sdkDir)
    def key_keyAlias = properties.getProperty('keyAlias')
    def key_keyPassword = properties.getProperty('keyPassword')
    def key_storePassword = properties.getProperty('storePassword')

    signingConfigs {
        release {
            v2SigningEnabled true
        }
        debug {
            storeFile file(keyFile)
            storePassword key_storePassword
            keyAlias key_keyAlias
            keyPassword key_keyPassword
        }

    }
    /*android.applicationVariants.all {
        variant ->
            variant.outputs.all {
                output ->
                    outputFileName = new File("../version/", "XMediaTV_Android_" +
                            defaultConfig.versionName + "." + releaseTime() + "_" + variant.buildType.name + ".apk")
            }
    }*/

    //android打包提示check release builds false
    lintOptions {
        checkReleaseBuilds false
        abortOnError false
    }
}

dependencies {
    //殼工程所依賴的子產品,implementation代表不依賴子產品下的三分庫
    implementation project(path: ':mobile')
    implementation project(path: ':tablet')
    //api 代表依賴子產品下所有的庫
    api project(path: ':common')
    api project(path: ':firebase')
}
//設定倉庫位址,用于輔助三方庫依賴檔案下載下傳
repositories {
    mavenCentral()
}
           

3.底層子產品的model配置

common中的gradle檔案:

common子產品本身就是為了通用,那麼對于一些常用的庫,則需要在該子產品做一定的依賴處理,以下對不同子產品功能依賴做出了标注

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.3"

    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1.0.0"
        //設定預覽界面的庫支援
        vectorDrawables.useSupportLibrary = true
        testInstrumentationRunner "androidx.tablet_test.runner.AndroidJUnitRunner"
        //混淆檔案指定
        consumerProguardFiles "consumer-rules.pro"

        //配合根目錄的gradle.properties,代碼中調用BuildConfig.SERVER_ADDRESS動态擷取對應值,用于自動打包改服務位址
        buildConfigField "String", "SERVER_ADDRESS", "\"${SERVER_ADDRESS}\""
        buildConfigField "String", "TENANT_CODE", "\"${TENANT_CODE}\""
        buildConfigField "String", "AD_SERVER_ADDRESS", "\"${AD_SERVER_ADDRESS}\""
        buildConfigField "String", "PLAYER_SERVER_URI", "\"${PLAYER_SERVER_URI}\""
        buildConfigField "Boolean", "FORCE_USE_TABLET", project.properties.get("FORCE_USE_TABLET")
    }

    //設定arouter子產品名稱
    kapt {
        arguments {
            arg("AROUTER_MODULE_NAME", project.getName())
        }
    }

    //資源字首強制命名
    resourcePrefix "common_"

    //混淆模式
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

    //用于換膚,讓所有model都可以擁有不同類型的資源目錄
    sourceSets {
        main {
            res.srcDirs = ['src/main/res',
                           'src/main/res-light',
                           'src/main/res-news']
        }
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar"])
    //》》》》kotlin
    //kotlin核心庫配置,對應根目錄的build.gradle版本
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.3.2'
    //kotlin協程庫
    api 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3-native-mt'
    api 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.3-native-mt'


    //》》》》視圖
    //android視圖庫
    api 'androidx.appcompat:appcompat:1.2.0'
    api 'com.google.android.material:material:1.3.0'
    api 'androidx.constraintlayout:constraintlayout:2.0.1'
    api 'androidx.recyclerview:recyclerview:1.1.0'

    //glide圖檔加載庫
    api 'com.github.bumptech.glide:glide:4.12.0'
    //圓角的ImageView庫
    api 'com.makeramen:roundedimageview:2.3.0'
    //recycleView的adapter庫
    api 'com.github.CymChad:BaseRecyclerViewAdapterHelper:3.0.4'
    //下拉重新整理庫
    implementation 'com.lcodecorex:tkrefreshlayout:1.0.7'
    //頭條的自适應庫
    api 'me.jessyan:autosize:1.2.1'
    //換膚庫
    api 'skin.support:skin-support:4.0.5'                   // skin-support
    api 'skin.support:skin-support-appcompat:4.0.5'         // skin-support 基礎控件支援
    api 'skin.support:skin-support-design:4.0.5'
    // skin-support-design material design 控件支援[可選]
    api 'skin.support:skin-support-cardview:4.0.5'
    // skin-support-cardview CardView 控件支援[可選]
    api 'skin.support:skin-support-constraint-layout:4.0.5'
    // skin-support-constraint-layout ConstraintLayout 控件支援[可選]
    //本地資源庫
    api project(path: ':resource')

    //》》》》網絡
    //用于retrofit2庫依賴
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    implementation 'com.squareup.retrofit2:adapter-rxjava2:2.9.0'
    //用于retrofit2+kotlin+coroutines的回調庫,可以直接加上suspend關鍵字擷取到回調對象
    implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2'
    //okhttp3庫
    implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.2'
    //gson解析庫
    implementation 'com.google.code.gson:gson:2.8.6'

    //》》》》其餘基本庫
    //郭霖的Litepal資料庫
    api 'org.litepal.guolindev:core:3.2.2'

    //sharePreference庫
    api 'com.orhanobut:hawk:2.0.1'


    //阿裡的路由庫
    kapt 'com.alibaba:arouter-compiler:1.2.2'
    api 'com.alibaba:arouter-api:1.5.0'

    //谷歌的deeplink分享
    implementation 'com.google.firebase:firebase-dynamic-links:19.1.0'


    //--------------------------------------------------------------

    //》》》》lifecycle庫,用于liveData和viewModle,使用與mvvm架構
    def lifecycle_version = '2.2.0'
    // ViewModel and LiveData
    api "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
    // alternatively - just ViewModel
//    api "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version"
    api 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.0'
    // For Kotlin use lifecycle-viewmodel-ktx
    // alternatively - just LiveData
//    api "androidx.lifecycle:lifecycle-livedata:$lifecycle_version"
    // 有生命周期感覺的協程
    api 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.0'

}
           

network中的gradle檔案:

該子產品為網絡請求子產品,用到的架構是retrofit2 + kotlin + coroutines,本質是請求耗時網絡,通過kotlin使用coroutines的suspend挂起,來達到子線程請求,主線程接收資料的效果。

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
android {
    compileSdkVersion 29

    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1.0.0"
        buildConfigField "String", "SERVER_ADDRESS", "\"${SERVER_ADDRESS}\""
        buildConfigField "String", "TENANT_CODE", "\"${TENANT_CODE}\""
        buildConfigField "String", "AD_SERVER_ADDRESS", "\"${AD_SERVER_ADDRESS}\""
        buildConfigField "String", "PLAYER_SERVER_URI", "\"${PLAYER_SERVER_URI}\""
        buildConfigField "Boolean", "FORCE_USE_TABLET", project.properties.get("FORCE_USE_TABLET")

    }
    resourcePrefix "network_"

    buildTypes {
        debug {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'

        }
        release {
            minifyEnabled true
        }
    }

    compileOptions {
        sourceCompatibility = '1.8'
        targetCompatibility = '1.8'
    }


}

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar"])

    //用于添加retrofit2攔截請求頭用的
    implementation 'com.squareup.okhttp3:logging-interceptor:4.8.1'
    //Chuck輔助工具,用于列印各種http請求
    debugImplementation 'com.readystatesoftware.chuck:library:1.1.0'
    releaseImplementation 'com.readystatesoftware.chuck:library-no-op:1.1.0'

    //--------------------------------------------------------------
    api project(path: ':common')
    implementation files('libs\\XMediaCryptoJar_HKSC.jar')
}
           

resoure的gradle:

該Model主要是用于存放抽取的顔色、多語言、以及與app相關的圖示、占位圖等

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.3"

    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        consumerProguardFiles "consumer-rules.pro"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

    sourceSets {
        main {
            res.srcDirs = ['src/main/res',
                           'src/main/res-light',
                           'src/main/res-news']
        }
    }
}

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar"])
    //kotlin
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.3.2'

    //單元測試庫
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'

}
           

基本子產品配置都是作為library庫使用,對于基本子產品的内容有要求,就是一定是一項基礎并且多子產品共用的功能,才值得放在基礎子產品中。

4.功能子產品或界面子產品的依賴配置

對于子產品依賴,隻要弄清楚api和implementation的功能,并且清楚common.gradle,是如何使用的,就能很清晰的使用子產品化項目開發。

apply from: "${rootProject.rootDir}/common.gradle"

//使用common.gradle中的公用配置
project.ext.setAppOrLibDefaultConfig project

android {
    resourcePrefix "tablet_"


    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

}

dependencies {
    //這裡統一依賴了network,network中由于是api common,common api resource,是以隻需要implementation network就行
    implementation project(path: ':network')
    //統一依賴功能model,播放器、Firebase、支付
    implementation project(path: ':player')
    implementation project(path: ':firebase')
    implementation project(path: ':pay')
    //依賴了一個界面子產品,含各種平闆的彈窗界面和登入
    implementation project(path: ':tablet_login')
    //下拉重新整理庫
    implementation 'com.lcodecorex:tkrefreshlayout:1.0.7'
    //輪播圖庫
    implementation 'com.github.zhpanvip:BannerViewPager:3.1.6'
    //谷歌支付庫
    implementation 'com.android.billingclient:billing:2.1.0'
    //依次是,谷歌消息、DeepLink、廣告
    implementation 'com.google.firebase:firebase-messaging:20.1.2'
    implementation 'com.google.firebase:firebase-dynamic-links:19.1.0'
    implementation "com.google.android.gms:play-services-ads:$google_service_version"
}
           

子產品内容

1.common

MVVM+元件化+Arouter實作

base包:

存放着各種基類,其中主要的是MVVM,是以着重講述MVVM架構搭建

ViewModel講解:

首先,要繼承ViewModel,導包,viewModel主要功能是,代替UI界面去做耗時操作,是以通過viewModelScope對象調用協程挂起,最終通過liveData綁定資料回調。

api "androidx.lifecycle:lifecycle-extensions:$lifecycle_version" //viewModel+livedata
api 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.0' //kotlin專用
由于ViewModel是配合Coroutine使用的,是以必需先認識CoroutineScope(協程範圍)和withContext(Dispatchers.IO)中的Dispatchers模式,這裡先講Dispatchers的用途和具體場景。
           
MVVM+元件化+Arouter實作
//實作LifecycleObserver接口,是為了通過activity的lifecycle.addObserver(LifecycleObserver) 綁定到生命周期中
open class BaseViewModel : ViewModel(), LifecycleObserver {
    
    //viewModelScope是ViewModel中的成員對象,該對象實作了CoroutineScope接口
    //suspend CoroutineScope.() -> Unit, suspend是kotlin線程挂起的辨別,實際上去走了await()方法 
    //CoroutineScope.() -> Unit 代表一個方法體,并且該方法體對象是CoroutineScope接口對象,主要是規範方法體類型,可除去CoroutineScope.
    fun launchUI(block: suspend CoroutineScope.() -> Unit) = viewModelScope.launch {
        try {
            block()
        } catch (e: Exception) {
            e.printStackTrace()
        }

    }
    
    //相比上個方法,主要是多了 withContext(Dispatchers.IO),目的是切換到子線程做耗時操作
    fun launchIO(block: suspend CoroutineScope.() -> Unit) = viewModelScope.launch {
        withContext(Dispatchers.IO) {
            try {
                block()
            } catch (e: Exception) {
                e.printStackTrace()

            }
        }
    }
    
    //errorHandler 是為了統一處理網絡異常
    fun launchIO(
        block: suspend CoroutineScope.() -> Unit,
        errorHandler: (code: Int, message: String) -> Unit?,
    ) = viewModelScope.launch {
        withContext(Dispatchers.IO) {
            try {
                if (NetWorkUtils.isNetConnect(CommonManager.context)) {
                    block()
                } else {
                    errorHandler(300, "No internet connection")
                }
            } catch (e: Exception) {
                handlerErrorCode(e, errorHandler)
                e.printStackTrace()
            }finally {
                //....
            }
        }
    }

    private fun handlerErrorCode(
        e: Exception,
        errorHandler: (code: Int, message: String) -> Unit?,
    ) {
        when (e) {
            is HttpException -> {
                errorHandler(e.code(), e.message())
            }
            is UnknownHostException -> {
                errorHandler(404, "Unable to connect to server")
            }
            is SocketTimeoutException -> {
                errorHandler(408, "Socket time out")//通路逾時
            }
            is ConnectException -> {
                errorHandler(404, "Connect exception")
            }
            is SocketException -> {
                errorHandler(500, "Socket exception")
            }
            is EOFException -> {
                errorHandler(500, "EOF exception") //連接配接意外中斷
            }
            is IllegalArgumentException -> {
                errorHandler(400, "Illegal argument exception")//參數錯誤
            }
            is SSLException -> {
                errorHandler(401, "SSL exception")//證書錯誤
            }
            is NullPointerException -> {
                errorHandler(600, "Null pointer exception")
            }
            else -> {
                errorHandler(700, "Unknown exception")
            }
        }
    }

    fun Map<String, Any>.getBody(): RequestBody {
        return Gson().toJson(this).toRequestBody("application/json".toMediaTypeOrNull())
    }

    data class ErrorHandler(val code: Int, val message: String)
}
           

BaseVMActivity講解:

//持有倆個泛型,VM和DB,分别是BaseViewModel和ViewDataBinding的實作類
abstract class BaseVMActivity<VM : BaseViewModel, DB : ViewDataBinding> : BaseActivity(){
    
    //是否列印生命周期
    var openLifecycle: Boolean = false
    lateinit var viewModel: VM
    lateinit var dataBinding: DB
    
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        LogUtil.e(TAG, "onCreate", openLifecycle)
        //綁定視圖,擷取到dataBinding
        dataBinding = DataBindingUtil.setContentView(this, provideContentViewId())
        tvTitle = dataBinding.root.findViewById(R.id.title)
        back = dataBinding.root.findViewById(R.id.back)
        //執行個體化ViewModel
        viewModel = initVM()
        //讓viewModel關聯生命周期
        lifecycle.addObserver(viewModel)
        //開始接口監聽回調
        startObserve()
    }

    abstract fun initVM(): VM

    abstract fun startObserve()

    override fun onResume() {
        super.onResume()
        LogUtil.e(TAG, "onResume", openLifecycle)
    }

    override fun onPause() {
        super.onPause()
        LogUtil.e(TAG, "onPause", openLifecycle)
    }

    override fun onStart() {
        super.onStart()
        LogUtil.e(TAG, "onStart", openLifecycle)
    }

    override fun onRestart() {
        super.onRestart()
        LogUtil.e(TAG, "onRestart", openLifecycle)
    }

    override fun onStop() {
        super.onStop()
        LogUtil.e(TAG, "onStop", openLifecycle)
    }

    override fun onDestroy() {
        super.onDestroy()
        LogUtil.e(TAG, "onDestroy", openLifecycle)
    }
    
    //Arouter路由跳轉封裝, action代表Postcard方法體回調
    fun open(path: String, requestCode: Int = 0, action: Postcard.() -> Unit = {}) {
        val postcard = ARouter.getInstance().build(path)
        postcard.action()
        postcard.navigation(this, requestCode)
    }
    
    fun openWithFinish(path: String, action: Postcard.() -> Unit = {}) {
        open(path, 0, action)
        finish()
    }
}
           

router包:

路由本意是,為了解決不同子產品之間無法通路各自界面問題

路由指定,首先需要定義路徑名,然後在對應的類中新增注解@Route(path = RouterPath.MOBILE_HOME),之後通過Arouter的navigation()方法跳轉到不同子產品的界面,進而實作跨子產品的跳轉。

interface RouterPath {
    companion object {
        //mobile
        const val MOBILE_HOME = "/mobile/home_activity"
        const val MOBILE_SPLASH = "/mobile/splash"
        const val MOBILE_VOD_DETAIL = "/mobile/vod_detail"
        const val MOBILE_LIVE = "/mobile/live"
        const val MOBILE_PAY = "/mobile/pay/activity"
        const val MOBILE_EVENT = "/mobile/event"


        //tablet
        const val TABLET_HOME = "/tablet/home_activity"
        const val TABLET_VOD_DETAIL = "/tablet/vod_detail"
        const val TABLET_SPLASH = "/tablet/splash"
        const val TABLET_EVENT = "/tablet/event"

        const val PAY_ACTIVITY = "/pay/activity"

    }
}
           

view包:

adapterItemDecoration是存放recycleview的裝飾類ItemDecoration

viewExpand是存放所有視圖相關的kotlin方法擴充,例如ImageView的加載圖檔封裝

其餘的則為view包中的一些常用的自定義view視圖

2.network:

在了解network子產品之前,必需對retrofit的使用由清晰的認識,是以接下來就看一個正常的retrofit是如何調用的。

調用庫的依賴:

//retrofit核心庫,這個在我們的common包中就有依賴
api 'com.squareup.retrofit2:retrofit:2.9.0'
//加上這個之後,你可以省略輸入流轉Gson的步驟
api 'com.squareup.retrofit2:converter-gson:2.9.0'
//使用之後,支援接口回調傳回Deferred<T>對象,該對象是延遲結果發送的意思,可以使用suspend代替
api 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2'
           

實作步驟:

//1.定義接口,并申明請求方式和對應的傳回結果
interface TestApi {
    //get請求,(https://www.baidu.com/test/{body})
    @GET("/test/{body}")
    fun getTest(@Path("test") body: String): Deferred<Test>
}

//2.使用retrofit初始化TestApi接口的實作對象
val myTestApi by lazy {
    val retrofit = retrofit2.Retrofit.Builder()
            .baseUrl("https://www.baidu.com")
            //添加Gson轉換
            .addConverterFactory(GsonConverterFactory.create())
            //添加Deferred轉換
            .addCallAdapterFactory(CoroutineCallAdapterFactory())
            .build()
    
    //建立實作TestApi接口的MyTestApi對象,通過該對象就可以調用getTest()方法去走對應的網絡請求
    retrofit.create(MyTestApi::class.java)
}

//3.使用協程實作簡潔回調
//確定在UI線程中調用,當getTest方法執行後,回調用await()挂起,如果在方法中申明suspend,則可以省略,直接讓getTest()傳回Test
GlobalScope.launch(Dispatchers.Main) {
    try {
        //回調UI線程中重新整理界面資料
        onResponseUI(myTestApi.getTest("test").await())
    } catch (e: Exception) {
        prink(e)
    }
}

//4.搭配LiveData的進階用法
interface HistoryApi {
    //用了post請求,并且加了suspend,直接讓接口傳回對象本身
    @POST(AppConfig.BO_API + "/play/list")
    suspend fun getPlayHistory(@Body body: RequestBody): WatchHistoryData
}

class HistoryViewModel : BaseViewModel() {
    private var historyApi = NetWorkManager.historyApiSingleton
    //聲明并初始化一個LiveData對象
    var playHistoryData: MutableLiveData<WatchHistoryData> = MutableLiveData()

    fun getPlayHistory(
        page: Int = 0, pageSize: Int = 12, type: String = XMediaConst.CONTENT_TYPE_VOD
    ) = launchIO {

        var parameter: HashMap<String, Any> = hashMapOf()
        parameter["type"] = type
        parameter["page"] = page
        parameter["pageSize"] = pageSize
        //調用方法傳回對象
        val resultData = historyApi.getPlayHistory(parameter.getBody())
        if (resultData.resultCode == 0)
            //讓liveData對象綁定接口傳回對象值
            playHistoryData.postValue(resultData)
    }
}

//在starObserve中做回調監聽,playHistoryData是一個liveData類型,當資料改變就會回調
historyViewModel.run {
    //this傳的是一個lifecycleOwner對象,通常是activity或fragment持有
    playHistoryData.observe([email protected]) {

    }
}
           

Network包中的組成:

MVVM+元件化+Arouter實作

api包:存放所有網絡請求接口API

interface HistoryApi {
    //用了post請求,并且加了suspend,直接讓接口傳回對象本身
    @POST(AppConfig.BO_API + "/play/list")
    suspend fun getPlayHistory(@Body body: RequestBody): WatchHistoryData
}
           

bean包:存放Bean對象

data class WatchHistoryData(
    val contents: List<Content>,
    val description: String,
    val pageCount: Int,
    val resultCode: Int
)
           

viewModel包:存放ViewModel實作類

NetworkManager: 用于retrofit網絡請求頭參數統一配置,retrofit的對象初始化,以及初始化viewModel實作類對象

// lazy預設模式就是同步鎖,其餘模式暫不展開
val historyApiSingleton: HistoryApi by lazy(mode = LazyThreadSafetyMode.SYNCHRONIZED) {
            retrofit.create(HistoryApi::class.java)
        }

val client = OkHttpClient.Builder()
            //.cache(Cache(file, cacheSize))
            .connectTimeout(DEFAULT_TIME, TimeUnit.SECONDS) //連接配接逾時設定
            .readTimeout(DEFAULT_TIME, TimeUnit.SECONDS) //讀取逾時設定
            .writeTimeout(WRITE_TIME, TimeUnit.SECONDS) //寫入逾時設定
            .addInterceptor(headInterceptor()) //請求頭攔截
            .addInterceptor(ChuckInterceptor(context)) //chunk工具類攔截
            //.addNetworkInterceptor(responseCacheInterceptor()) //緩存攔截
            .addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY)) //送出和接收資料的攔截器
            .build()

var retrofit = Retrofit.Builder()
            .baseUrl(AppConfig.SERVER_ROOT_URI)
            .addConverterFactory(GsonConverterFactory.create()) //gson解析
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //Rxjava
            .addCallAdapterFactory(CoroutineCallAdapterFactory()) //協程Coroutine
            .client(client)
            .build()
           

3.功能子產品和界面子產品

功能子產品沒什麼好講的,就是功能封裝,調用方式也很簡潔,而界面子產品,主要描述一下MVVM的Activity是怎麼實作的

//HomeViewModel,即我們之前将的ViewModel實作類, TabletActivityCategoryBinding則是系統通過xml自動生成的,具體請看下述的xml
class TabletCategoryActivity : BaseVMActivity<HomeViewModel, TabletActivityCategoryBinding>() {
    //分類内容清單,具體資料需要調網絡請求接口擷取
    private var categoryContentList: MutableList<CategoryContentData.Content> = mutableListOf()
    private var categoryAdapter: TabletCategoryAdapter? = null

    companion object {
        const val CATEGORY_ID = "category_id"
        const val CATEGORY_TYPE = "category_type"
        const val CATEGORY_TITLE = "category_title"
    }

    //HomeViewModel初始化,BaseVMActivity重寫方法1
    override fun initVM(): HomeViewModel = HomeViewModel()
    //指定xml布局id,BaseVMActivity重寫方法2
    override fun provideContentViewId(): Int = R.layout.tablet_activity_category

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        initRecyclerView()
        initData()
    }

    private fun initData() {
        //判斷跳轉前是否攜帶CATEGORY_ID參數
        intent.getStringExtra(CATEGORY_ID)?.let {
            if (it.isNotEmpty()) {
                //調用getCategoryContentList()的網絡請求接口
                viewModel.getCategoryContentList(it)
            }
        }
        //tv_title自動綁定視圖 是在app/build.gradle 中開啟了buildFeatures { dataBinding = true }
        intent.getStringExtra(CATEGORY_TITLE)?.let {
            tv_title.text = it
        }
    }
    
    //recyclerView的初始化
    private fun initRecyclerView() {
        categoryAdapter = TabletCategoryAdapter()
        recycler_view.layoutManager = GridLayoutManager(this, 6)
        recycler_view.addItemDecoration(
            GridSpacingItemDecoration(
                6, 6f.dpInt, false))
        recycler_view.adapter = categoryAdapter
        categoryAdapter?.setOnItemClickListener { _, _, position ->
            TabletVodDetailsActivity.actionActivity(this,
                categoryContentList[position].contentId,
                0)
        }

        nav_back.setOnClickListener { finish() }
    }
    
    //監聽viewModel實作類中的LiveData資料,BaseVMActivity重寫方法3
    override fun startObserve() {
        viewModel.categoryContentListData.observe(this, { categoryContentData ->
            //categoryContentData即網絡請求結果對象                                            
            categoryContentData.contents.let {
                if (it.isNotEmpty()) {
                    categoryContentList.addAll(it)
                    //重新整理資料
                    categoryAdapter?.setList(it)
                }
            }
        })
    }
}
           
?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">
    <-- 生成TabletActivityCategoryBinding類的關鍵 -->
    <data>

    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@drawable/theme_bg"
        android:fitsSystemWindows="true">

        <ImageView
            android:id="@+id/nav_back"
            android:layout_width="32dp"
            android:layout_height="32dp"
            android:layout_marginStart="14dp"
            android:clickable="true"
            android:focusable="true"
            android:padding="8dp"
            android:src="@drawable/nav_back"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

        <TextView
            android:id="@+id/tv_title"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textColor="@color/main_text_color"
            android:textSize="24sp"
            app:layout_constraintBottom_toBottomOf="@id/nav_back"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="@id/nav_back" />

        <androidx.recyclerview.widget.RecyclerView
            android:id="@+id/recycler_view"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:layout_marginTop="34dp"
            app:layoutManager="androidx.recyclerview.widget.GridLayoutManager"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@id/nav_back"
            app:spanCount="6"
            tools:listitem="@layout/tablet_item_category_vertical" />

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

MVVM模式總結:

MVVM+元件化+Arouter實作

相關推薦

Android Jetpack 架構開發元件化應用實戰

Android 元件化工程結構以及項目具體實施方案

一篇文章搞懂 Android 元件化

Android 徹底元件化—如何使用 Arouter

Android路由架構ARouter的內建、基本使用以及踩坑全過程

我是

code小生

,喜歡可以随手點個

在看

、轉發給你的朋友,謝謝~

如果你有寫部落格的好習慣
歡迎投稿
           
點個“在看”小生感恩❤️