Android独立Module运行

前言

Android组件化中我们经常会将逻辑组件到各个Module中，为了进一步提高开发效率，避免不必要的编译时间浪费，我们可以通过对Module中build配置进行进行设置，以使各个业务单元模块Module可以独立运行。

一、gradle文件说明

实现Module可以独立运行涉及到修改gradle文件或者相关配置，因此，我们首先对gradle的相关文件做一个简单说明，然后再说明如何更改。

gradle相关文件位置

在这里插入图片描述

如上图所示，我们在Android工程中常见到的gradle及相关文件有如下几个：

项目根目录下的build.gradle
项目根目录下的settings.gradle
项目根目录下的gradle.properties
项目根目录下的gradle文件夹
Module目录下的build.gradle

1.项目根目录下的build.gradle

项目根目录下的build.gradle文件是整个项目工程的配置入口，在此文件中可以配置版本，插件，依赖库等信息，示例代码：

apply from:"config.gradle"
buildscript {
    ext.kotlin_version = "1.3.72"
    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.0"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.8'

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
    }
}

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

整个文件主要包括两个部分： buildscript和allprojects。

buildscript是gradle脚本执行所需依赖，分别是对应maven库和插件。
allprojects里是项目本身需要的依赖，项目内所需要的库需要在此处声明，否则会找不到对应的库

2.项目根目录下的settings.gradle

settings.gradle文件主要是用来声明工程树的配置，我们需要将各个Module在此文件中引入，否则Module会被当成一个文件夹，而不会被当成Module处理。
文件配置示例如下：

include ':singlework'
include ':annotationTest'
include ':processorTest'
include ':app'
rootProject.name = "DemoWork1"

如上图，我们在当前的工程中引入了singlework，annotationTest，processorTest，app等几个Module。

include后面为Module名称。

3.项目根目录下的gradle.properties

此文件主要是配置项目中全局的Gradle配置，如是否使用AndroidX等其他内容也需要在此处配置android.useAndroidX=true.

4.项目根目录下的gradle文件夹

从上图中我们可以看出gradle文件夹中存在一个wrapper文件夹，wrapper文件夹中有gradle-wrapper.jar和gradle-wrapper.properties两个文件。

wrapper实际上是对Gradle的一层包装，可以使工程在构建时有着统一的Gradle版本。

gradle-wrapper.jar文件：具体的Gradle功能实现的jar包
gradle-wrapper.properties：gradle wrapper的配置文件，用来配置使用gradle的版本
根目录下的gradlew：Linux下的可执行脚本
根目录下的gradlew.bat: Windows下的可执行脚本

5.Module目录下的build.gradle

Module下的build.gradle文件主要是对于当前Module的配置，主要用来声明版本，依赖库以及一些编译或打包配置。

我们建立一个新工程，app Module下的build.gradle文件如下：

plugins {
    id 'com.android.application'
}

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.didachuxing.taxi.myapplication"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

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

dependencies {

    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'com.google.android.material:material:1.2.1'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

主要分为plugins,android和dependencies三个部分。

plugin：声明要引入的插件
android：声明Android工程相关的配置
dependencies：声明当前Module的依赖库。

Android中Gradle插件常见的有三个：

APP应用工程：com.android.application，用来生成可运行的apk应用。
Library库工程：com.android.library，用来生成AAR包给其他的APP工程公用。
Test测试工程：com.android.test，对APP应用工程或者Library库工程进行单元测试。

本次我们的用来设置Module库独立运行主要是针对这个插件配置进行调整。

二、独立Module运行

要使得Module模块能够独立运行，需要将当前Module的Gradle插件设置为APP工程，并将其他的Module的Gradle插件设置为lib即可。

具体的操作可以参考如下步骤：

1. gradle.properties中配置模块控制

在项目根目录下的gradle.properties文件中配置需要独立执行的Module名称。

如下所示，配置需要运行的名称runModule，如果需要运行的模块是app，则取值为app，如果需要运行的模块是singlework，则取值为singlework。

#控制运行哪个模块(app：运行app模块 singlework：运行singleWork模块
runModule=singlework

2. setting中配置需要运行的模块

setting中配置的是可以运行的Module模块，我们也可以根据运行的模块来自定义我们需要运行的Module文件。

如下所示，在运行singlework模块时，我们选择只运行singlework Module；在运行app Module时，我们将其他的Module全部引入，示例如下：

if (String.valueOf(runModule) == "singlework") {
    include ':singlework'
} else {
    include ':apt_lib'
    include ':common'
    include ':annotationTest'
    include ':processorTest'
    include ':app'
}
rootProject.name = "DemoWork1"

3. singlework Module的build.gradle文件配置

和settings中的配置类似，在singlework中的配置我们也可以进行设置，当选择运行singlework模块时，我们将当前的Gradle插件置为APP；当选择运行app模块时，我们将当前的Gradle插件置位lib，示例代码如下：

if (String.valueOf(runModule) == "singlework") {
    apply plugin: 'com.android.application'
} else {
    apply plugin: 'com.android.library'
}
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        if (String.valueOf(runModule) == "singlework") {
            applicationId "com.example.demowork1"       //当为运行module时才有applicationId属性，可以做到不同Module的APP在手机桌面上共存显示
        }
		...
	}
	...
}

4.app Module的build.gradle文件配置

和上一步中的配置类似，更新在app Module中的配置文件，示例代码如下：

if (String.valueOf(runModule) == "singlework") {
    apply plugin: 'com.android.library'
} else {
    apply plugin: 'com.android.application'
}

apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'com.google.protobuf'

android {
    compileSdkVersion rootProject.ext.android["compileSdkVersion"]
    buildToolsVersion rootProject.ext.android["buildToolsVersion"]

    defaultConfig {
        if (String.valueOf(runModule) == "app") {
            applicationId "com.example.demowork1"
        }
	...
	}
...
}

完成了上述步骤之后，此时可以通过修改gradle.properities文件中的参数来调整运行哪一个Module。

总结

通过修改gradle配置可以调整我们要运行的Module，这对于我们的组件化开发和调试有着极大的便利。