Android组件化架构搭建

早期单一分层模式

  • 问题一:无论怎么分包,随着项目增大,项目失去层次感。
  • 问题二:包名约束太弱,稍有不注意,就会不同业务包直接互相调用,代码高耦合。
  • 问题三:多人开发在版本管理中,容易出现代码覆盖冲突等问题。

组件化的意义

不相互依赖,可以相互交互,任意组合,自由组装。组件化示意图,如下所示:
Android组件化架构搭建_第1张图片

此时app模块不在是老大,组件化之后,所有module都平起平坐。

下面,我们以一个dome来阐释如何搭建一个组件化架构。
demo中所用的router跳转方案,请大家参考笔者的另一篇博客:android组件化页面跳转策略

首先,我们新建一个工程,然后在新工程下新建三个library,如下所示:
Android组件化架构搭建_第2张图片
common模块就对应着上面示意图的公共基础库,当然我们,可以继续拆分,将utils拆成一个library,http拆成一个library,然后让common模块同一依赖这些基础库。这个大家就根据项目的复杂程度进行划分了。order模块和personal模块,存放的就是order页面的所有功能代码和personal页面的所有功能代码。这里,我们简单起见就只写一个页面意思一下。
接下来,我们要做的一个非常重要的功能就是修改build.gradle文件。因为,我们如果要打成一个完整的apk,那么势必就只能要app这个主模块,其余的common、order、personal就只能是充当依赖库的角色,这个大家都好理解。而如果我们在开发过程中,某个模块已经开发好了想要提前测试呢?例如,order模块的功能已经开发好了,测试组想要先测试这个功能,那么我们完全可以只打一个只含有order功能的包给测试。鉴于这种清空,order模块就势必不能以依赖库的方式存在了。因此,我们可以在build.gradle中修改相关的配置信息。
我们新建一个app_config.gradle文件用来统一管理gradle中相关的版本信息:

// 把一些公用的,共用的,可扩展的,加入到这里面来
// 整个App项目的Gradle配置文件
// ext 自定义增加我们的内容

ext {

    // 开发环境 / 生产环境(测试/正式)
    isRelease = true

    // 建立Map存储,对象名、key都可以自定义,groovy糖果语法,非常灵活
    app_android = [
            compileSdkVersion: 28,
            buildToolsVersion: "29.0.0",

            applicationId: "com.xx.modular",
            minSdkVersion: 15,
            targetSdkVersion: 28,
            versionCode: 1,
            versionName: "1.0",
            testInstrumentationRunner: "androidx.test.runner.AndroidJUnitRunner"
    ]

    appId = ["app"     : "com.xx.modular",
             "order"   : "com.xx.order",
             "personal": "com.xx.personal"]

    //  测试环境,正式环境 URL
    url = [
            "debug"  : "https://11.22.33.44/debug",
            "release": "https://11.22.33.44/release"
    ]

    // 依赖相关的
    app_implementation = [
            "appcompat": "androidx.appcompat:appcompat:1.1.0",
            "junit": "junit:junit:4.12",
            "runner": "androidx.test:runner:1.2.0",
            "espresso": "androidx.test.espresso:espresso-core:3.2.0"
    ]
}

然后在项目级build.gradle中引入该配置文件:

// Top-level build file where you can add configuration options common to all sub-projects/modules.

apply from : "app_config.gradle"

buildscript {
    repositories {
        google()
        jcenter()
        
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.1'
        
        // 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模块下修改build.gradle文件

apply plugin: 'com.android.application'

// 定义变量
def app_android = /*this.*/getRootProject().ext.app_android;

// 定义变量
def app_implementation = rootProject.ext.app_implementation;

// 定义变量
def url = this.getRootProject().ext.url;

android {
    compileSdkVersion app_android.compileSdkVersion
    buildToolsVersion app_android.buildToolsVersion
    defaultConfig {
        applicationId app_android.applicationIdisRelease
        minSdkVersion app_android.minSdkVersion
        targetSdkVersion app_android.targetSdkVersion
        versionCode app_android.versionCode
        versionName app_android.versionName
        testInstrumentationRunner app_android.testInstrumentationRunner

        // 这个方法接收三个非空的参数,第一个:确定值的类型,第二个:指定key的名字,第三个:传值(必须是String)
        // 为什么需要定义这个?因为src代码中有可能需要用到跨模块交互,如果是组件化模块显然不行
        // 切记:不能在android根节点,只能在defaultConfig或buildTypes节点下
        buildConfigField("boolean", "isRelease", String.valueOf(isRelease))
    }
    buildTypes {
        debug {
            // 增加服务器URL地址---是在测试环境下
            buildConfigField("String", "SERVER_URL", "\"${url.debug}\"")
        }
        release {
            // 增加服务器URL地址---是在正式环境下
            buildConfigField("String", "SERVER_URL", "\"${url.release}\"")

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

    // 源集 - 设置源集的属性,更改源集的 Java 目录或者自由目录等
    // 注意:我们先加入进来,后续在学习哦
    sourceSets {
        main {
            if (!isRelease) {
                // 如果是组件化模式,需要单独运行时
                manifest.srcFile 'src/main/AndroidManifest.xml'
                java.srcDirs = ['src/main/java']
                res.srcDirs = ['src/main/res']
                resources.srcDirs = ['src/main/resources']
                aidl.srcDirs = ['src/main/aidl']
                assets.srcDirs = ['src/main/assets']
            } else {
                // 集成化模式,整个项目打包
                manifest.srcFile 'src/main/AndroidManifest.xml'
            }
        }
    }
}

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

    // 更简洁的方式,由于我们config那边定义的是 map,那么是不是可以遍历map
    app_implementation.each {
        k, v -> implementation v
    }

    implementation project(":common") // 公共基础库

    // 如果是集成化模式,做发布版本时。各个模块都不能独立运行了
    if (isRelease) {
        implementation project(':order')  // 这样依赖时,必须是集成化,有柱状图, 否则会循环依赖问题
        implementation project(':personal')  // 这样依赖时,必须是集成化,有柱状图, 否则会循环依赖问题
    }
}

接着,我们修改personal模块下的build.gradle文件:

if (isRelease) { // 如果是发布版本时,各个模块都不能独立运行
    apply plugin: 'com.android.library'
} else {
    apply plugin: 'com.android.application'
}

// 定义变量
def app_android = this.rootProject.ext.app_android;

android {
    compileSdkVersion app_android.compileSdkVersion
    buildToolsVersion app_android.buildToolsVersion

    defaultConfig {
        if (!isRelease) { // 如果是集成化模式,不能有applicationId
            appId.personal // 组件化模式能独立运行才能有applicationId
        }

        minSdkVersion app_android.minSdkVersion
        targetSdkVersion app_android.targetSdkVersion
        versionCode app_android.versionCode
        versionName app_android.versionName
        testInstrumentationRunner app_android.testInstrumentationRunner

        // 这个方法接收三个非空的参数,第一个:确定值的类型,第二个:指定key的名字,第三个:传值(必须是String)
        // 为什么需要定义这个?因为src代码中有可能需要用到跨模块交互,如果是组件化模块显然不行
        // 切记:不能在android根节点,只能在defaultConfig或buildTypes节点下
        buildConfigField("boolean", "isRelease", String.valueOf(isRelease))
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

    // 配置资源路径,方便测试环境,打包不集成到正式环境
    sourceSets {
        main {
            if (!isRelease) {
                // 如果是组件化模式,需要单独运行时,我们需要指定一个AndroidManifest文件才行
                manifest.srcFile 'src/main/debug/AndroidManifest.xml'
            } else {
                // 集成化模式,整个项目打包apk
                manifest.srcFile 'src/main/AndroidManifest.xml'
                java {
                    // release 时 debug 目录下文件不需要合并到主工程
                    exclude '**/debug/**'
                }
            }
        }
    }
}

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

    app_implementation.each {
        k, v -> implementation v
    }

    implementation project(":common") // 公共基础库
}

接着,如果我们想要单独运行personal模块,那还需要什么条件呢?首先肯定需要一个AndroidManifest文件吧!然后根据项目可以定义个application或者baseactivity。
Android组件化架构搭建_第3张图片

这也是为什么我们要在build.gradle文件中指定源集的原因。order业务组件的同理,这里就不多加阐述了。
这里,我们的组件化架构就大体搭建完成了。我们将isRelease改为true,那么就将所有的模块都集成到app模块中了,我们只能执行app模块。而当我们将isRelease改为false,我们就可以选择app、order、peronal模块三者中的任意一个运行。

你可能感兴趣的:(android,android,studio,ide)