Android組件化開發

最近公司在做一款新的車機 Launcher,需要將一個類似QQ音樂、喜馬拉雅的音頻模塊放入其中,整體作為一個 Launcher,雖然產品一再確定,后面不會進行拆分,但是小心為上,將 Launcher 和 音頻軟件分為兩個 App 開發,兩個團隊開發互不影響,最后通過組件化,作為 module 引入到空殼App中。

整體思路

這里寫個組件化二維碼掃描的 Demo ,①空殼 App,②公共 Library,③第一個 App 類似于上面說的 Launcher,④第二個 App 類似于上面說的音頻 App。



其中③、④均是可單獨運行的 module,都依賴于②,當運行①時,需要將③、④轉換為 library 去依賴。

那么需要解決的第一個問題就是,如何在 app 和 library 直接切換。

切換 application 和 library 屬性

切換 module 的 application 和 library,需要在 gradle.properties 里面進行配置,因為這里面的變量都是全局的,全部 gradle 都可以取到。


gradle.properties

在最后一行增加一個標記變量 isModule=true,我這里用 true 表示 application,false 表示 library。

# Project-wide Gradle settings.
# IDE (e.g. Android Studio) users:
# Gradle settings configured through the IDE *will override*
# any settings specified in this file.
# For more details on how to configure your build environment visit
# http://www.gradle.org/docs/current/userguide/build_environment.html
# Specifies the JVM arguments used for the daemon process.
# The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m
# When configured, Gradle will run in incubating parallel mode.
# This option should only be used with decoupled projects. More details, visit
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
# org.gradle.parallel=true
isModule=false

下面就可以修改 module 的 build.gradle 判斷操作了。

if (isModule.toBoolean()) {// ① 切換
    apply plugin: 'com.android.application'
} else {
    apply plugin: 'com.android.library'
}
apply plugin: 'com.jakewharton.butterknife'

def config = rootProject.ext// 定義變量
android {
    compileSdkVersion config.android.compileSdkVersion
    defaultConfig {
        if (isModule.toBoolean()) {// ② library沒有applicationId
            applicationId "com.ff.modulea"
        }
        minSdkVersion config.android.minSdkVersion
        targetSdkVersion config.android.targetSdkVersion
        versionCode 1
        versionName "1.0"
    }

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

    sourceSets {
        main {
            // ③ 加載不同位置的AndroidManifest
            if (isModule.toBoolean()) {
                manifest.srcFile 'src/main/module/AndroidManifest.xml'
            } else {
                manifest.srcFile 'src/main/AndroidManifest.xml'
            }
        }
    }

    compileOptions {
        // ButterKnife 需要Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    lintOptions {
        // 禁用Google Search
        disable 'GoogleAppIndexingWarning'
    }
}

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    annotationProcessor "com.jakewharton:butterknife-compiler:$config.dependencies.butterknife"
    api project(':baselib')
}

主要看上面①、②、③ 處代碼,主要說下③,可以通過修改 SourceSets 中的屬性,修改 AndroidManifest 默認的加載路徑,更多SourceSets介紹與使用

先看下作為 library 時的 AndroidManifest,上圖①處。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.ff.moduleb">

    <application>
        <activity
            android:name="com.ff.moduleb.CaptureActivity"
            android:configChanges="keyboardHidden|orientation|screenSize"
            android:screenOrientation="portrait" />
    </application>

</manifest>

再對比下作為 application 的 AndroidManifest,上圖②處。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.ff.moduleb">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".CaptureActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

為什么需要加載不同的 AndroidManifest ?
一是,因為 library 清單文件不需要指明 application 內容;二是,并不是每個 Activity 都是 App 第一個啟動的 Activity。

還需要注意一點,由于組件化,可能會導致每個 module 之間依賴的遠程倉庫版本不一致,出現異常情況,所以這里使用 config.gradle 統一配置版本。

ext {

    android = [
            compileSdkVersion: 28,
            minSdkVersion    : 19,
            targetSdkVersion : 28
    ]

    dependencies = [
            arouter_api     : "1.4.1",
            arouter_compiler: "1.2.2",
            butterknife     : "9.0.0",
            zxing           : "3.3.3"
    ]

    supportVersion = "28.0.0"
}

只需要在項目的 build.gradle 中引入即可使用,更多詳細介紹

// Top-level build file where you can add configuration options common to all sub-projects/modules.
apply from: "config.gradle"http:// 引入config.gradle
buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.3.2'
        classpath 'com.jakewharton:butterknife-gradle-plugin:9.0.0'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

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

空殼 App

里面沒有任何 java 代碼。



只有一個 AndroidManifest,指明 application,我們會把 BaseApplication 放在 baselib 中。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.ff.module">

    <application
        android:name="com.ff.baselib.base.BaseApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme" />

</manifest>

唯一依賴是 baselib 庫中的 BaseApplication。

apply plugin: 'com.android.application'

def config = rootProject.ext
android {
    compileSdkVersion config.android.compileSdkVersion
    defaultConfig {
        applicationId "com.ff.ui"
        minSdkVersion config.android.minSdkVersion
        targetSdkVersion config.android.targetSdkVersion
        versionCode 1
        versionName "1.0"
    }

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

    compileOptions {
        // ButterKnife 需要Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    lintOptions {
        // 禁用Google Search
        disable 'GoogleAppIndexingWarning'
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    if (isModule.toBoolean()) {
        // 依賴baselib中的BaseApplication
        implementation project(':baselib')
    } else {
        // modulea和moduleb中依賴了baselib
        implementation project(':modulea')
        implementation project(':moduleb')
    }
}

公用的 Library

這里面可以放基類、工具類、常量、權限聲明、圖片網絡框架等等。

我這里放入了一些常量,BaseApplication,BaseActivity,二維碼掃描的 jar 包。
至于 ButterKnife 需要如何引入,可以看下 ButterKnife最新版本使用的深坑

apply plugin: 'com.android.library'
// 雖然在library中使用butterknife,但僅在BaseActivity中bind,
// 不需要尋找控件,也就不需要生成R2,所以無需添加plugin
// apply plugin: 'com.jakewharton.butterknife'

def config = rootProject.ext// 定義變量
android {
    compileSdkVersion config.android.compileSdkVersion
    defaultConfig {
        minSdkVersion config.android.minSdkVersion
        targetSdkVersion config.android.targetSdkVersion
        versionCode 1
        versionName "1.0"
    }

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

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    api "com.android.support:appcompat-v7:$config.supportVersion"
    api "com.jakewharton:butterknife:$config.dependencies.butterknife"
    // 僅在BaseActivity中bind,不需要尋找控件,也就不需要生成java文件,無需使用annotationProcessor
    // annotationProcessor "com.alibaba:arouter-compiler:$config.dependencies.arouter_compiler"
    api files('libs/zxing.jar')
}

權限聲明,可以都放在這個 AndroidManifest 中。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.ff.baselib">

    <uses-feature android:name="android.hardware.camera" />
    <uses-feature android:name="android.hardware.camera.autofocus" />

    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.FLASHLIGHT" />
    <uses-permission android:name="android.permission.VIBRATE" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

</manifest>

組件 module

上面已經設置好,切換 module 的 application 和 library 屬性,這里就沒有什么其他工作了。

注意不同 module 間的 layout 文件不要重名,不然會出現找不到的現象,類名可以重復,因為每個 module 的包名是不一樣的,要是每個 module 的包名都一樣我就無語了。

組件間跳轉

比如我們這里需要 modulea 中的 MainActivity 需要跳轉到 moduleb 中到 CaptureActivity 這個就需要使用路由框架了,這里推薦阿里開源的路由框架 ARouter,使用很便捷。

添加依賴和配置

官方示例代碼:

android {
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {// ①
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
    }
}

dependencies {
    // 替換成最新版本, 需要注意的是api
    // 要與compiler匹配使用,均使用最新版可以保證兼容
    compile 'com.alibaba:arouter-api:x.x.x'// ②
    annotationProcessor 'com.alibaba:arouter-compiler:x.x.x'// ②
    ...
}
  1. 首先,要注意的是①、③處代碼,需要同時出現,不然會報錯:
ARouter::Compiler >>> No module name, for more information, look at gradle log.
  1. 在新版本中需要使用 api 代替 compiler:
dependencies {
    api 'com.alibaba:arouter-api:x.x.x'
    ...
}
  1. com.alibaba:arouter-api 中的 v4 包是 25 的,與我引入的 v7 包沖突(一般 v7 都包含 v4),所以需要使用 exclude 移除 com.alibaba:arouter-api 里面的 v4 包:
dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    api "com.android.support:appcompat-v7:$config.supportVersion"
    // arouter-api中包含了v4包,與上面v7包中的v4沖突了
    api("com.alibaba:arouter-api:$config.dependencies.arouter_api") {
        // 默認情況下v7中是包含V4包的,exclude的意思是去除v4包,這樣就可以解決沖突了
        exclude module: 'support-v4'// 根據組件名排除
        exclude group: 'com.android.support'// 根據包名排除
    }
}

關于 exclude 可以看 com.android.support版本沖突的解決辦法

添加注解

官方示例代碼:

// 在支持路由的頁面上添加注解(必選)
// 這里的路徑需要注意的是至少需要有兩級,/xx/xx
@Route(path = "/test/activity")
public class YourActivity extend Activity {
    ...
}

初始化SDK

官方示例代碼:

if (isDebug()) {           // 這兩行必須寫在init之前,否則這些配置在init過程中將無效
    ARouter.openLog();     // 打印日志
    ARouter.openDebug();   // 開啟調試模式(如果在InstantRun模式下運行,必須開啟調試模式!線上版本需要關閉,否則有安全風險)
}
ARouter.init(mApplication); // 盡可能早,推薦在Application中初始化

發起路由操作

官方示例代碼:

// 1. 應用內簡單的跳轉(通過URL跳轉在'進階用法'中)
ARouter.getInstance().build("/test/activity").navigation();

// 2. 跳轉并攜帶參數
ARouter.getInstance().build("/test/1")
            .withLong("key1", 666L)
            .withString("key3", "888")
            .withObject("key4", new Test("Jack", "Rose"))
            .navigation();

具體的使用,包括 startActivityForResult 的實現,就不在這里粘出來了,可以下載demo看下。
github項目地址

其他注意點

組件化開發中,資源文件不要重名,建議使用組建名作為前綴。

參考資料

Android組件化方案
Android組件化初探
解決v4,v7包沖突問題
探索Android路由框架-ARouter之基本使用

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容