Android 组件化-Gradle配置

组件化 Gradle 配置

1. 项目基本业务结构如下图。

• 新建项目结构如下：
  
  2. 抽取 gradle 基本配置到 config.gradle

ext {
    // 是否开启组件化开发 true -> 开启 false -> 不开启
    isOpenComponent = false
    android = [
            compileSdkVersion: 29,
            buildToolsVersion: "29.0.3",
            minSdkVersion    : 23,
            targetSdkVersion : 29,
            versionCode      : 1,
            versionName      : "1.0"
    ]
    // 定义各个组件 applicationId 如果是组件模式则需要配置 ，如果是集成模式则不需要配置。
    appId = ["app"    : "com.component.based",
             "module1": "com.component.module1",
             "module2": "com.component.module2"]
    // 可以配置一些公共的库和版本放到这里 demo 里面我都放到base里面了 所以这里面只是记录了一下可以这么做
    supportLibrary = ["29.0.0"]
    // 公共配置包可以放在这里
    dependencies = [
            "appcompat-v7": "androidx.appcompat:appcompat-v7:${supportLibrary}",
    ]
}

3. application 的 Gradle

// 引入 config.gradle 相当于java中的 import:
apply from: 'config.gradle'
apply plugin: 'com.alibaba.arouter'
buildscript {

    repositories {
        google()
        jcenter()

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.6.2'
        // 采用 ali的 ARouter
        classpath "com.alibaba:arouter-register:1.0.2"
        // 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
}

4. 引用配置 config.gradle

• app中

apply plugin: 'com.android.application'
// 获取 config.gradle 中的配置
def androidConfig = rootProject.ext.android
def appId = rootProject.ext.appId
android {
    // 引用配置项
    compileSdkVersion androidConfig.compileSdkVersion
    buildToolsVersion androidConfig.buildToolsVersion

    defaultConfig {
        applicationId appId.app
        minSdkVersion androidConfig.minSdkVersion
        targetSdkVersion androidConfig.targetSdkVersion
        versionCode androidConfig.versionCode
        versionName androidConfig.versionName

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        javaCompileOptions {
            annotationProcessorOptions {
                // ARouter配置
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
    }

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

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    // 引入 base  因为我在 app里面也做了一些业务代码 充当了 一个模块
    implementation project(path: ':base')
    annotationProcessor 'com.alibaba:arouter-compiler:1.2.2'
    // 集成开发时 且 module1 和 module2 是 library 的情况下才需要依赖
    if (!rootProject.ext.isOpenComponent){
        implementation project(path: ':module1')
        implementation project(path: ':module2')
    }
}

• module1.gradle 配置 （每个业务module基本配置都差不多 其他需求根据自己需要配置）

def isOpenComponent = rootProject.ext.isOpenComponent
if (isOpenComponent) {
    // 如果是组件开发 则设置成 application
    apply plugin: 'com.android.application'
} else {
    // 如果是集成开发 则设置成 library
    apply plugin: 'com.android.library'
}
def androidConfig = rootProject.ext.android
def appId = rootProject.ext.appId
android {
    compileSdkVersion androidConfig.compileSdkVersion
    buildToolsVersion androidConfig.buildToolsVersion
    defaultConfig {
        // 如果是组件开发 则需要设置 applicationId
        if (isOpenComponent) {
            applicationId appId.app
        }
        minSdkVersion androidConfig.minSdkVersion
        targetSdkVersion androidConfig.targetSdkVersion
        versionCode androidConfig.versionCode
        versionName androidConfig.versionName
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
		// 添加一条 boolean类型的变量 
		// 可以在java代码中通过 buildConfig 获取设置的值 用来做业务逻辑判断
     buildConfigField("boolean","isOpenComponent",String.valueOf(isOpenComponent))
    }

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

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation project(path: ':base')
    annotationProcessor 'com.alibaba:arouter-compiler:1.2.2'
}

• base 和其他 core模块都是正常的配置就不贴出来了

5. 根据切换 config.gradle 中的 isOpenComponent = false 来切换是否是组件开发。

6. 那么有个问题是每个组件模块中都有可能需要自定义的 application 初始化一些功能，比如下面的 ARouter初始化操作。

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        if (BuildConfig.DEBUG) {
            ARouter.openLog();
            ARouter.openDebug();
        }
        ARouter.init(this);
    }
}

但是如果每个组件中都自定义了 application 会报错如下：项目进行打包时会合并AndroidManifest ，如果在多个AndroidManifest中指定了 android:name=".MyApplication" 就会报错。

Manifest merger failed : Attribute application@name value=(com.component.based.MyApplication) from AndroidManifest.xml:8:9-38
	is also present at [:module1] AndroidManifest.xml:14:9-64 value=(com.component.module1.Module1Application).
	Suggestion: add 'tools:replace="android:name"' to <application> element at AndroidManifest.xml:6:5-23:19 to override.

这里不去阐述合并原理，那么怎么解决上面的问题呢？下面提供两个方法。
（1）在 app 的 manifest 中添加如下代码，替换掉

 <application
 	android:name=".MyApplication"
 	// 通过 replace 替换 android:name 属性
	tools:replace="android:name">

（2）每个module都配置自己的 application ，然后在 gradle 中根据是否是组件模式进行资源替换。
以例子中的module1为例，新建 manifest 和 aplication 文件 结构如下（结构可以自己随意定义）：

其中新增的 AndroidManifest 如下：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.component.module1">
    <uses-permission android:name="android.permission.INTERNET " />
    <application
        android:name=".Module1Application"
        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=".Module1Activity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

application 如下：

public class Module1Application extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        if (BuildConfig.DEBUG) {
            ARouter.openLog();
            ARouter.openDebug();
        }
        ARouter.init(this);
    }
}

然后在 module1 gradle 的 android{} 中增加配置如下：

//资源配置
    sourceSets{
        main{
            //在组件模式下 使用不同的manifest文件
            if(isOpenComponent){
                manifest.srcFile 'src/main/module/AndroidManifest.xml'
                java.srcDirs 'src/main/module/java','src/main/java'
            }else{
                manifest.srcFile 'src/main/AndroidManifest.xml'
            }
        }
    }

然后就可以了。

demo下载链接