Android组件化开发实践
一、首先，我们弄清楚什么是组件化开发？为什么要使用组件化开发？
在Android项目开发中，我们都是根据不同的块或者业务关系，在主App下分很多不同的package，把需要的第三方库依赖配置好，就开始开发。
但是随着项目发展到一定阶段，随着版本迭代，业务功能和参与开发人员的增多，代码会越来越臃肿，耦合越来越严重，开发和维护难度也越来越大，牵一发而动全身。明明只为了添加一个很小的功能，却需要更改很多地方。编译速度也会变得很慢。
对于这些问题，相信大家都深有体会。在这种情况下，出现了组件化开发。
组件化开发的主要思路，就是将一个Module拆分成若干个Module，由主App提供统一的入口，每个拆分后的Module都依赖共享的Common依赖库。通过相关配置，各Module可以独立运行调试，也可以供主App依赖使用。
这里借鉴一位大神的图片：
参考地址：https://blog.csdn.net/guiying712/article/details/55213884
二、组件化使用场景
几乎任何项目都可以进行组件化开发，尤其适合业务功能复杂的大型项目。大型企业，实现团队协作开发项目。
三、组件化的优点
a、降低耦合，达到代码复用的目的，使代码更加清晰
b、有利于团队协作开发，开发人员之间职责明确，每一个开发人员只需要关注和负责自己的功能点，互不干扰，提高效率
c、加快编译速度，提高开发效率，降低项目维护难度，便于测试
四、组件化的不足
a、在Application与Library之间切换时，对一些控件注入框架支持不友好，例如ButterKnife
b、作为Application运行时，不适合在Application中定义方法
c、配置Module作为Applica或者Library时稍显繁琐，需要细心，否则容易出错。
五、实践案例
参考了网上一些技术博客及视频资料，特别是网易云课堂的公开课视频，文末有相关链接，非常感谢他们的无私分享。
在开始之前，我们先提到一个知识点：
在Project的gradle.properties文件中，一些配置信息都可以在Module的build.gradle文件中读取到。
为什么要提到这一点，在下面相关配置中会用到。
开发环境如下：
win10专业版
AndroidStudio3.2 64位
假如我们要实现这样一个功能：
点击 “签到” 按钮，跳转到依赖module signcomponent中。
点击 “登录” 按钮，跳转到依赖module logincomponent中。
点击“显示LoginComponent中的UserInfoFragment”按钮，加载logincomponent中的UserInfoFragment。
业务并不复杂，主要是理解组件化开发的思路，注意如何进行配置。好，让我们开始配置，查看示例代码。
-
在TestComponent这个Project中，新建三个独立的Module。
app（作为主应用）
LoginComponent（登录模块）
SignComponent（签到模块）
这三个Module都可以独立运行。新建一个library：SharedLibrary。
-
配置
实现logincomponent 与 signcomponent既可以独立运行，也可以作为主Module app的依赖 。
1). 配置TestComponent 的gradle.properties文件
#配置某个组件是否可以独立运行
isLoginRunAlone = true
isSignRunALone = true
这里配置两个boolean变量。
isLoginRunAlone：配置登录模块（即logincomponent ）是否作为独立Application运行。
isSignRunAlone：配置签到模块（即signcomponent）是否作为独立Application运行。
配置为true时，则Module作为独立Application。false，作为主app的依赖。
2). 在Module中配置build.gradle文件
（1）主app的build,gradle配置。
主要在dependencies配置Module是否作为依赖。
apply plugin: 'com.android.application'
android {
compileSdkVersion 27
defaultConfig {
applicationId "com.li.testcomponent"
minSdkVersion 14
targetSdkVersion 27
versionCode 1
versionName "1.0"
// testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
// testImplementation 'junit:junit:4.12'
// androidTestImplementation 'com.android.support.test:runner:1.0.2'
// androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
implementation project(':sharedlibrary')
// 如果LoginComponent不是独立作为Module运行，而是作为Library，则可以引用
if (!isLoginRunAlone.toBoolean()){
implementation project(':logincomponent')
}
// 如果SignComponent不是独立作为Module运行，而是作为Library，则可以引用
if (!isSignRunALone.toBoolean()){
implementation project(':signcomponent')
}
}
（2）logincomponent 的build,gradle配置：
主要配置3个地方，apply plugin， applicationId， manifest加载文件（后面接着讲，作为application或者module时，AndroidManifest.xml是不一样的）。
if (isLoginRunAlone.toBoolean()){
apply plugin: 'com.android.application'
}else{
apply plugin: 'com.android.library'
}
android {
compileSdkVersion 27
defaultConfig {
if (isLoginRunAlone.toBoolean()){
applicationId "com.li.logincomponent"
}
minSdkVersion 14
targetSdkVersion 27
versionCode 1
versionName "1.0"
// testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
sourceSets{
main{
// 在独立运行或者作为Libarary调试时，使用不同的AndroidManifest.xml文件
if (isLoginRunAlone.toBoolean()){
manifest.srcFile 'src/main/manifest/AndroidManifest.xml'
}else {
manifest.srcFile 'src/main/AndroidManifest.xml'
}
}
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
// testImplementation 'junit:junit:4.12'
// androidTestImplementation 'com.android.support.test:runner:1.0.2'
// androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
implementation project(':sharedlibrary')
}
（3）signcomponent 的build,gradle配置。和上面类似。
if (isSignRunALone.toBoolean()){
apply plugin: 'com.android.application'
}else {
apply plugin: 'com.android.library'
}
android {
compileSdkVersion 27
defaultConfig {
if (isSignRunALone.toBoolean()){
applicationId "com.li.signcomponent"
}
minSdkVersion 14
targetSdkVersion 27
versionCode 1
versionName "1.0"
// testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
sourceSets{
main{
// 在独立运行或者作为Libarary调试时，使用不同的AndroidManifest.xml文件
if (isSignRunALone.toBoolean()){
manifest.srcFile 'src/main/manifest/AndroidManifest.xml'
}else {
manifest.srcFile 'src/main/AndroidManifest.xml'
}
}
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
// testImplementation 'junit:junit:4.12'
// androidTestImplementation 'com.android.support.test:runner:1.0.2'
// androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
implementation project(':sharedlibrary')
}
3). 配置AndroidManifest.xml 文件
在logincomponent Module的main目录下新建manifest文件夹。
当logincomponent 作为独立的Application运行时，加载manifest里面的AndroidManifest.xml 文件。
当logincomponent 作为主app的依赖时，加载main目录里面的AndroidManifest.xml 文件。
logincomponent 作为Application：
logincomponent 作为依赖：
类似的，对signcomponent 也进行配置。
signcomponent 作为Application：
signcomponent 作为依赖：
Module作为application独立运行时，注意AndroidManifest.xml 中application的配置，配置为下面自定义的application。
全部配置完成之后，我们可以在gradle.properties中修改变量的值，分别作为application、依赖的module。看配置是否OK。
六、主要业务代码
代码并不复杂，关键的地方也有注释。先全部贴出来，这样也比较好理解一点。
- 主app代码
MainActivity.java
/*
* ************************************************************
* 文件：MainActivity.java 模块：app 项目：TestComponent
* 当前修改时间：2019年03月16日 23:19:58
* 上次修改时间：2019年03月16日 22:57:38
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.testcomponent;
import android.os.Bundle;
import android.support.v4.app.FragmentManager;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;
import android.widget.Toast;
import com.li.sharedlibrary.ServiceFactory;
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
private Button btnSign, btnLogin, btnShowUserInfo;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initViews();
}
private void initViews() {
btnSign = findViewById(R.id.btnSign);
btnLogin = findViewById(R.id.btnLogin);
btnShowUserInfo = findViewById(R.id.btnShowUserInfo);
btnSign.setOnClickListener(this);
btnLogin.setOnClickListener(this);
btnShowUserInfo.setOnClickListener(this);
}
private void sign() {
ServiceFactory.getInstance().getSignService().launch(MainActivity.this,"");
}
private void login() {
ServiceFactory.getInstance().getLoginService().launch(MainActivity.this, "");
}
private void showUserInfo() {
// v-4包的FragmentManager,注意是否是在Activity中使用，
// 因为Activity中并没有此方法的定义，必须是继承FragmentActivity或者AppCompatActivity，然后使用
FragmentManager fragmentManager = getSupportFragmentManager();
Bundle bundle = new Bundle();
ServiceFactory.getInstance().getLoginService().newUserInfoFragment(fragmentManager, R.id.llFragmentContainer, bundle);
}
@Override
public void onClick(View v) {
switch (v.getId()){
case R.id.btnSign:
sign();
break;
case R.id.btnLogin:
login();
break;
case R.id.btnShowUserInfo:
showUserInfo();
break;
default:
break;
}
}
}
activity_main.xml文件
MainApplication.java
/*
* ************************************************************
* 文件：MainApplication.java 模块：app 项目：TestComponent
* 当前修改时间：2019年03月31日 01:31:35
* 上次修改时间：2019年03月16日 17:52:09
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.testcomponent;
import android.app.Application;
import android.util.Log;
import com.li.sharedlibrary.AppConfig;
import com.li.sharedlibrary.IComponentApplication;
public class MainApplication extends Application implements IComponentApplication {
private static Application application;
public static Application getApplication(){
return application;
}
@Override
public void onCreate() {
super.onCreate();
initialize(this);
}
@Override
public void initialize(Application application) {
for (String cpnt : AppConfig.Components){
try{
Class clz = Class.forName(cpnt);
Object obj = clz.newInstance();
if (obj instanceof IComponentApplication){
((IComponentApplication) obj).initialize(this);
}
}catch (Exception e){
Log.e("TAG", e.getMessage());
}
}
}
}
- sharedlibrary
ILoginService.java
/*
* ************************************************************
* 文件：ILoginService.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月31日 01:33:29
* 上次修改时间：2019年03月16日 18:24:48
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
import android.content.Context;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
public interface ILoginService {
void launch(Context ctx, String targetClass);
Fragment newUserInfoFragment(FragmentManager fragmentManager, int viewId, Bundle bundle);
}
ISignService.java
/*
* ************************************************************
* 文件：ISignService.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月31日 01:34:30
* 上次修改时间：2019年03月16日 16:56:17
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
import android.content.Context;
public interface ISignService {
void launch(Context ctx, String userId);
}
EmptyLoginService.java
/*
* ************************************************************
* 文件：EmptyLoginService.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月16日 23:05:57
* 上次修改时间：2019年03月16日 23:05:57
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
import android.content.Context;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
public class EmptyLoginService implements ILoginService {
@Override
public void launch(Context ctx, String targetClass) {
}
@Override
public Fragment newUserInfoFragment(FragmentManager fragmentManager, int viewId, Bundle bundle) {
return null;
}
}
EmptySignService.java
/*
* ************************************************************
* 文件：EmptySignService.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月16日 23:06:27
* 上次修改时间：2019年03月16日 23:06:27
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
import android.content.Context;
public class EmptySignService implements ISignService {
@Override
public void launch(Context ctx, String userId) {
}
}
IComponentApplication.java
/*
* ************************************************************
* 文件：IComponentApplication.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月31日 01:37:43
* 上次修改时间：2019年03月16日 11:41:34
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
import android.app.Application;
public interface IComponentApplication {
void initialize(Application application);
}
AppConfig.java
/*
* ************************************************************
* 文件：AppConfig.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月16日 12:20:11
* 上次修改时间：2019年03月16日 11:49:05
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
public class AppConfig {
public static final String[] Components = {
"com.li.logincomponent.LoginApplication",
"com.li.signcomponent.SignApplication"
};
}
ServiceFactory.java
/*
* ************************************************************
* 文件：ServiceFactory.java 模块：sharedlibrary 项目：TestComponent
* 当前修改时间：2019年03月16日 18:32:57
* 上次修改时间：2019年03月16日 11:30:08
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.sharedlibrary;
public class ServiceFactory {
private static final ServiceFactory instance = new ServiceFactory();
private ILoginService mLoginService;
private ISignService mSignService;
private ServiceFactory(){}
public static ServiceFactory getInstance() {
return instance;
}
public ILoginService getLoginService() {
if (mLoginService == null){
mLoginService = new EmptyLoginService();
}
return mLoginService;
}
public void setLoginService(ILoginService mLoginService) {
this.mLoginService = mLoginService;
}
public ISignService getSignService() {
if (mSignService == null){
mSignService = new EmptySignService();
}
return mSignService;
}
public void setSignService(ISignService mSignService) {
this.mSignService = mSignService;
}
}
- logincomponent
LoginActivity.java
/*
* ************************************************************
* 文件：LoginActivity.java 模块：logincomponent 项目：TestComponent
* 当前修改时间：2019年03月31日 01:14:39
* 上次修改时间：2019年03月16日 23:50:38
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.logincomponent;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
public class LoginActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_login);
}
}
activity_login.xml
UserInfoFragment.java
/*
* ************************************************************
* 文件：UserInfoFragment.java 模块：logincomponent 项目：TestComponent
* 当前修改时间：2019年03月16日 12:20:01
* 上次修改时间：2019年03月16日 12:12:08
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.logincomponent;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
public class UserInfoFragment extends Fragment {
public UserInfoFragment() {
// Required empty public constructor
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
// Inflate the layout for this fragment
return inflater.inflate(R.layout.fragment_user_info, container, false);
}
}
fragment_user_info.xml
LoginApplication.java
/*
* ************************************************************
* 文件：LoginApplication.java 模块：logincomponent 项目：TestComponent
* 当前修改时间：2019年03月16日 23:07:44
* 上次修改时间：2019年03月16日 22:57:38
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.logincomponent;
import android.app.Application;
import com.li.sharedlibrary.IComponentApplication;
import com.li.sharedlibrary.ServiceFactory;
public class LoginApplication extends Application implements IComponentApplication {
private static Application application;
public static Application getApplication(){
return application;
}
@Override
public void onCreate() {
super.onCreate();
}
@Override
public void initialize(Application app) {
application = app;
ServiceFactory.getInstance().setLoginService(new LoginService());
}
}
LoginService.java
/*
* ************************************************************
* 文件：LoginService.java 模块：logincomponent 项目：TestComponent
* 当前修改时间：2019年03月31日 01:43:49
* 上次修改时间：2019年03月16日 23:20:27
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.logincomponent;
import android.content.Intent;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.content.Context;
import android.os.Bundle;
import com.li.sharedlibrary.ILoginService;
public class LoginService implements ILoginService {
@Override
public void launch(Context ctx, String targetClass) {
Intent intent = new Intent(ctx, LoginActivity.class);
// intent.putExtra(LoginActivity.EXTRA_TARGET_CLASS, targetClass);
// intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
ctx.startActivity(intent);
}
@Override
public Fragment newUserInfoFragment(FragmentManager fragmentManager, int viewId, Bundle bundle) {
UserInfoFragment fragment = new UserInfoFragment();
fragment.setArguments(bundle);
fragmentManager.beginTransaction().replace(viewId, fragment).commit();
return fragment;
}
}
- signcomponent
SignActivity.java
/*
* ************************************************************
* 文件：SignActivity.java 模块：signcomponent 项目：TestComponent
* 当前修改时间：2019年03月31日 01:49:25
* 上次修改时间：2019年03月31日 01:45:19
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.signcomponent;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
public class SignActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_sign);
}
}
activity_sign.xml
SignApplication.java
/*
* ************************************************************
* 文件：SignApplication.java 模块：signcomponent 项目：TestComponent
* 当前修改时间：2019年03月31日 01:44:58
* 上次修改时间：2019年03月16日 23:09:33
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.signcomponent;
import android.app.Application;
import com.li.sharedlibrary.IComponentApplication;
import com.li.sharedlibrary.ServiceFactory;
public class SignApplication extends Application implements IComponentApplication {
private static Application application;
public static Application getApplication(){
return application;
}
@Override
public void onCreate() {
super.onCreate();
}
@Override
public void initialize(Application app) {
application = app;
ServiceFactory.getInstance().setSignService(new SignService());
}
}
SignService.java
/*
* ************************************************************
* 文件：SignService.java 模块：signcomponent 项目：TestComponent
* 当前修改时间：2019年03月31日 01:50:25
* 上次修改时间：2019年03月31日 01:45:19
* 作者：[email protected]
* Copyright (c) 2019
* ************************************************************
*/
package com.li.signcomponent;
import android.content.Context;
import android.content.Intent;
import com.li.sharedlibrary.ISignService;
public class SignService implements ISignService {
@Override
public void launch(Context ctx, String userId) {
Intent intent = new Intent(ctx, SignActivity.class);
intent.putExtra("UserId", userId);
ctx.startActivity(intent);
}
}
最终实现效果：
六、总结
在这个示例中，主App与各依赖的Module之间通信，这里比较简单，使用反射和接口回调来实现。
组件化工程模块下的业务关系，业务之间将不再直接引用和依赖，而是通过“路由”这样一个中转站间接产生联系。开源框架的话，有阿里开源的路由框架ARouter，关于它的使用和分析，后面有时间继续写。
现在快凌晨两点了，再不睡觉的话白天没精神。大家可以先自己理解一下，下次接着写一下代码流程。
看博客或者视频只是初步理解，纸上得来终觉浅。自己好好想一遍，整理之后再写出来，思路也会清晰很多。
由于知识欠缺，文章可能存在一些不足或者疏漏之处，欢迎大家批评指正，共同交流进步。再次对其他大神及网易云课堂表示感谢！暂时就这样吧，睡觉！
参考资料：
https://blog.csdn.net/guiying712/article/details/55213884
https://juejin.im/post/5c46e6fb6fb9a049a5713bcc#heading-4