保姆級教你Android組件化入門：一步步搭建組件化架構

原文地址：https://juejin.cn/post/6844903833378750478

1、前言

最近因爲業務需求變更，有考慮採用組件化架構進行開發，這方面我之前沒有接觸過。關於組件化的文章很多，各方大神更是提出了各種的組件化方案，我也看了很多相關文章。但是學習新東西看的再多，不如動手做一次，先不考慮複雜的東西，先動手做個簡單的Demo更有助於理解組件化的思想。組件化相關理論知識這裏就不多講了，想要了解的可以自己去搜或者去看Android組件化方案這篇文章。廢話不多說，直接動手開碼。

2、搭建組件化Demo

先打開Android Studio新建一個項目。

步驟一：新建config.gradle，統一管理build.gradle中的相關內容

然後在項目目錄下新建一個config.gradle文件。

接着在這個文件內添加如下代碼：

ext {
    //表示是作爲module還是application
    isModule = false
    //applicationId版本好sdkVersion統一管理
    android = [
            compileSdkVersion        : 28,
            buildToolsVersion        : 28,
            applicationId            : "com.example.componenttestdemo",
            minSdkVersion            : 19,
            targetSdkVersion         : 28,
            versionCode              : 1,
            versionName              : "1.0",
            testInstrumentationRunner: "android.support.test.runner.AndroidJUnitRunner"
    ]

    //版本號
    def APPCOMPAT_V7_VERSION = "28.0.0"
    def CONSTRAINT_LAYOUT_VERSION = "1.1.3"

    //三方庫統一管理
    dependencies = [
            appcompatV7     : 'com.android.support:appcompat-v7:' + APPCOMPAT_V7_VERSION,
            constraintLayout: 'com.android.support.constraint:constraint-layout:' + CONSTRAINT_LAYOUT_VERSION
    ]
}

因爲我們知道項目使用組件化架構後，單一模塊Module可以作爲單個Application運行，同時也可以在整個主Application中作爲一個Module運行。所以在config.gradle中先定義一個isModule來區別這兩種情況，組件化之後可以通過修改這個值來切換這兩種情況的使用。剩下就是對applicationId、版本號、sdkVersion和三方庫等進行統一管理。

接着修改app下的build.gradle裏設置內容

將原來的compileSdkVersion、applicationId、minSdkVersion、versionCode和三方庫等替換成對應config.gradle中定義的值。

apply plugin: 'com.android.application'

android {
    compileSdkVersion rootProject.ext.android.compileSdkVersion
    defaultConfig {
        applicationId rootProject.ext.android.applicationId
        minSdkVersion rootProject.ext.android.minSdkVersion
        targetSdkVersion rootProject.ext.android.targetSdkVersion
        versionCode rootProject.ext.android.versionCode
        versionName rootProject.ext.android.versionName
        testInstrumentationRunner rootProject.ext.android.testInstrumentationRunner
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation rootProject.ext.dependencies.appcompatV7
    implementation rootProject.ext.dependencies.constraintLayout

}

最後還要在項目目錄下的build.gradle中添加一行：

apply from : "config.gradle"

然後點擊Sync Now同步。最後在進行下一步前，新建一個MyApplication，在AndroidManifest設置name屬性。

步驟二：創建Main模塊，搬空app殼工程

我們知道組件化中需要一個app殼工程，這個殼工程中不處理任何業務，就只是一個空殼，由它將所需要的各個組件模塊組合起來，構成一個完整的應用。而現在項目中的app還是存在默認的入口Activity的，所以要新建一個ModuleMain將默認的MainActivity和其佈局文件搬過去。

接着進入app的AndroidManifest文件將註冊Activity的相關代碼也搬到ModuleMain模塊的AndroidManifest中去，只留下application標籤。

這裏注意組件化項目中每個Module都會有自己的AndroidManifest文件，最後打包時會將這些文件合併成一個文件，所以會出現application標籤中的屬性重複問題，要在app的AndroidManifest文件中添加如下兩行代碼：

 xmlns:tools="http://schemas.android.com/tools"

 tools:replace="android:name,android:label,android:icon, android:theme,android:allowBackup"

這裏的name、label、icon、theme、allowBackup都可能會有重複，所以全部寫上之間用逗號隔開。完整AndroidManifest如下：

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

    <application
        android:name=".application.MyApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        tools:replace="android:name,android:label,android:icon, android:theme,android:allowBackup"
        android:theme="@style/AppTheme">
    </application>

</manifest>

接着app殼工程中只剩剛修改的build.gradle還沒刪減，在刪減前先將app中build.gradle的內容複製覆蓋到Main模塊的build.gradle中，並且還要做部分修改。因爲單個組件可以作爲一個組件模塊被app殼工程組合使用，也可以單獨作爲一個application使用。所以要根據config.gradle中定義的isModule來判斷是作爲Module還是Applicaition。同樣還有作爲Module是不需要applicationId的而作爲應用則是需要的。

//通過isModule來判斷是application還是module
if (rootProject.ext.isModule) {
     apply plugin: 'com.android.library'
} else {
    apply plugin: 'com.android.application'
}
android {
    compileSdkVersion rootProject.ext.android.compileSdkVersion
    defaultConfig {
        //是application才需要applicationId
        if (!rootProject.ext.isModule) {
            applicationId "com.example.sy.moduledmain"
        }
        minSdkVersion rootProject.ext.android.minSdkVersion
        targetSdkVersion rootProject.ext.android.targetSdkVersion
        versionCode rootProject.ext.android.versionCode
        versionName rootProject.ext.android.versionName
        testInstrumentationRunner rootProject.ext.android.testInstrumentationRunner
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    }
}

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation rootProject.ext.dependencies.appcompatV7
    implementation rootProject.ext.dependencies.constraintLayout
}

這時modulemain中的AndroidManifest會提示資源文件的缺少，這時先將app中的對應文件複製到modulemain裏來。

步驟三：新建`Application`和`AndroidManifest`文件

在app殼工程和ModuleMain中分別新建一個Application，因爲Moudule也是需要可以單獨運行的。

接着在ModuleMain裏新建AndroidManifest文件，因爲作爲Module和Application是會有不一樣的所以要做區分，在main目錄下新建module文件夾和application文件夾分別存放兩個情況下的AndroidManifest文件，將原來的AndroidManifest文件拖到module下，再拷貝一份到application下。拷貝完了記得在兩個AndroidManifest裏application標籤下設置name屬性。

接着再build.gradle中添加如下代碼，用來分別在兩種情況下指定使用哪個AndroidManifest。

sourceSets {
        main {
            if (rootProject.ext.isModule) {
                manifest.srcFile 'src/main/module/AndroidManifest.xml'
            } else {
                manifest.srcFile 'src/main/application/AndroidManifest.xml'
                java {
                    //排除java/module文件夾下的所有文件
                    exclude '*module'
                }
            }
        }
    }

然後再到app的build.gradle中在dependencies內添加以下代碼，用來引入ModuleMain模塊。

if (rootProject.ext.isModule) {
    implementation project(":modulemain")
}

現在可以再次點擊Sync Now等同步結束後，雖然項目中只有一個殼工程和一個主Module，但是已可以看到組件化的雛形。此時已經可以通過修改config.gradle裏的isModule的值，進行Application和Module兩種模式的切換，將ModuleMain作爲app 的模塊運行或者是單獨作爲一個應用運行了。

步驟四：新建其他組件Module和解決資源文件衝突

接着按照新建ModuleMain的步驟重複新建其他業務Module，這裏我新建了3個Module，業務A：ModuleA與業務B：ModuleB和一個BaseModule。其中BaseModule主要存放一些基礎類和工具類，只做爲Module爲上層業務模塊提供服務。

接下來解決資源文件衝突的問題，進入ModuleMain的build.gradle添加下面這行代碼，爲資源文件命名規範一個統一開頭：

resourcePrefix "modulemain_"

添加後起名是沒按照規範Android Studio就會有一個提示：

按要求修改文件名後提示消失。

步驟五：使用ARouter進行組件間通信

接下來就要處理組件間的通信問題，採用阿里的ARouter。按照文檔集成ARouter。首先在defaultConfig下添加如下代碼：

javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
    }

再引入ARouter依賴：

implementation rootProject.ext.dependencies.arouter
implementation rootProject.ext.dependencies.arouterCompiler

最後在Application中初始化ARouter：

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

這樣ARouter就集成好了，接着在MoudleA和ModuleB中新建兩個Activity，然後使用ARouter進行頁面跳轉。

ModuleMain中MainActivity.java：

public class MainActivity extends BaseActivity  {
    /**
     * toA
     */
    private Button mModulemainA;
    /**
     * toB
     */
    private Button mModulemainB;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.modulemain_activity_main);
        initView();
        initEvent();
    }

    private void initEvent() {
        mModulemainA.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                ARouter.getInstance().build(ARouterPath.PATH_MOUDULE_A).navigation();
            }
        });

        mModulemainB.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                ARouter.getInstance().build(ARouterPath.PATH_MOUDULE_B).withString("key","傳遞的數據").navigation();
            }
        });
    }

    private void initView() {
        mModulemainA = (Button) findViewById(R.id.modulemain_a);
        mModulemainB = (Button) findViewById(R.id.modulemain_b);
    }

}

ModuleA中ModuleAActivity.java：

@Route(path = ARouterPath.PATH_MOUDULE_A)
public class ModuleAActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.modulea_activity_module_a);
    }
}

ModuleB中ModuleBActivity.java：

@Route(path = ARouterPath.PATH_MOUDULE_B)
public class ModuleBActivity extends AppCompatActivity {
    @Autowired(name = "key")
    String data;
    /**
     * TextView
     */
    private TextView mTextViewB;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.moduleb_activity_module_b);
        ARouter.getInstance().inject(this);
        initView();
    }
    private void initView() {
        mTextViewB = (TextView) findViewById(R.id.textViewB);
        mTextViewB.setText(data);
    }
}

運行效果：

這裏看到模塊之間界面通信正常，並且單個業務模塊也可以單獨運行，這樣一個最基本的組件化架構Demo差不多就完成了。

3、將Module作爲遠程maven倉庫

在開發中，可能會把一些公用Module傳到私有服務器上，然後在項目中直接依賴使用。下面就將Module上傳到Github作爲遠程maven倉庫，在項目直接引用。首先新建一個項目，創建一個UtilModule。

將原來項目中的工具類移到UtilModule中，接着在UtilModule的build.gradle中添加以下代碼：

apply plugin: 'maven'
uploadArchives {
    repositories.mavenDeployer {
        def mavenDirPath = file('\\Users\\sy\\AndroidProjects\\UtilModule') // 本地存放地址
        repository(url:"file://${mavenDirPath.absolutePath}")
        pom.project {
            groupId "com.example.utilmodule" // 包名
            artifactId "utilmodule" // module的名字
            version "1.0.0" // 版本號
        }
    }
}

然後點擊gradle中的uploadArchives：

進入設置的目錄查看，aar已經打包好了。

接着打開Github創建一個新倉庫：

按照Github上的命令，將本地打包好的UtilModule上傳到Github上：

[圖片上傳失敗...(image-e543eb-1621175226862)]

[圖片上傳失敗...(image-6f8651-1621175226862)]

上傳完成後將倉庫地址複製下來，將其中的github.com部分修改爲raw.githubusercontent.com再在結尾加上/master表示是主分支，添加到項目中的build.gradle中。[圖片上傳失敗...(image-ee818-1621175226862)]

接着在到Module的build.gradle中添加依賴：

utilmodule      : 'com.example.utilmodule:utilmodule:' + UTIL_MODULE_VERSION
複製代碼

implementation rootProject.ext.dependencies.utilmodule
複製代碼

這裏就是之前設置的包名：Module名：版本號。SyncNow之後刪除原來項目中的工具類，然後在代碼裏使用遠程倉庫的工具類測試：

[圖片上傳失敗...(image-2dfdc9-1621175226862)]

運行打印日誌：

D/com.example.modulemain.MainActivity: onCreate:false
複製代碼

這說明遠程倉庫依賴成功已經能正常使用其中的類和方法。

4、總結

這篇文章主要是記錄下我初識組件化，搭建組件化Demo的過程，Demo主要對於我對組件化思想的理解和體驗還是很有幫助的，Demo中還有很多沒考慮到的地方，比如Application的動態配置合併、Fragment、組件化的混淆等等，也是我正在學習的問題。這篇文章主要供和我一樣對組件化這塊不太瞭解的新手做參考，希望能對新手有所幫助。

最後再貼上幾個總結得比較好的開源組件化方案的鏈接，也是我後面準備研究學習的方案：
多個維度對比一些有代表性的開源android組件化開發方案
 AppJoint方案
 ArmsComponent方案

補一下文中Demo源碼地址：github.com/syDeveloper…

作者：胖宅老鼠
鏈接：https://juejin.cn/post/6844903833378750478
來源：掘金
著作權歸作者所有。商業轉載請聯繫作者獲得授權，非商業轉載請註明出處。

保姆級教你Android組件化入門：一步步搭建組件化架構

1、前言

2、搭建組件化Demo

步驟一：新建config.gradle，統一管理build.gradle中的相關內容

步驟二：創建Main模塊，搬空app殼工程

步驟三：新建`Application`和`AndroidManifest`文件

步驟四：新建其他組件Module和解決資源文件衝突

步驟五：使用ARouter進行組件間通信

3、將Module作爲遠程maven倉庫

4、總結

七天.NET 8操作SQLite入門到實戰 - （2）第七天Blazor班級管理頁面編寫和接口對接

自學編程兩個月，現在我月入 4 萬元

百度安全多篇議題入選Blackhat Asia以硬技術發現“芯”問題

「實戰應用」如何用圖表控件LightningChart創建2D氣泡圖

GtkSharp 設置窗口背景透明

Google Chrome驅動程序 124.0.6367.62（正式版本）去哪下載？

阿里淘系技術分享：Flutter 快速上手！！！ Flutter是什麼配置開發環境體驗如何添加Flutter項目所需的依賴？如何歸檔圖片資源以及如何處理不同分辨率組件總結最後最後

搞Android開發，學歷是要的，但是不重！雙非院校拿下字節跳動offer的面試準備

天天都在 996 ，安卓人該如何持續學習，實現可持續性發展？程序猿 996 的普遍現狀 996 下，我們該如何持續學習？最後總結

如何規範的進行 Android 組件化開發？

還談論Android的前景？根本沒什麼好問的…… 前言

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

保姆級教你Android組件化入門：一步步搭建組件化架構

1、前言

2、搭建組件化Demo

步驟一： 新建config.gradle，統一管理build.gradle中的相關內容

步驟二：創建Main模塊，搬空app殼工程

步驟三 ：新建Application和AndroidManifest文件

步驟四：新建其他組件Module和解決資源文件衝突

步驟五：使用ARouter進行組件間通信

3、將Module作爲遠程maven倉庫

4、總結

步驟一：新建config.gradle，統一管理build.gradle中的相關內容

步驟三：新建`Application`和`AndroidManifest`文件