updata time 2020年10月09日14:03:57
前言
在平时的开发过程中,中小项目MVC 、MVP 已经够用。但在大公司中,由于过多的业务逻辑,数个开发人员合作开发。复用问题、不方便、编译时长,方便测试等问题的出现,也就决定了Android 架构的演变方向,最近时间充裕,该片文章为本人从零搭建组件化的一些思考记录及总结,有不对的地方还望多包涵。
一、 什么是组件化
项目按功能拆分成功若干个组件,每个组件负责相应的功能,每个组件都可以以一个单独的 module 开发,并且可以单独抽出来作为 SDK 对外发布使用,比如登录组件,视频组件。组件化与模块化其实很相似,但不同的是模块化是以业务为导向,组件化是以功能为导向。一般一个模块可以包含多个组件。
自己对项目架构进行一个图形化
组件架构图
-
BaseLib :各种基础工具类,比如:Log工具类,Activity 入栈出栈, 等基础工具类为基础Lib,可以供所有Lib依赖
-
Lib : 基础功能Sdk底层封装。比如:网络Sdk ,图片加载,数据库等功能都封装为单独的Lib。
-
基础业务层 :module可封装工具类 如: BaseActivity BaseFragment 等
-
业务层 : 每个模块代表了一个业务,模块之间相互隔离解耦,方便维护和复用。(类似模块化)
-
宿主层 : App外壳,不参与业务功能实现,主要承担App生成和 初始化功能。
上述架构为本人项目,读者可以根据业务情况自行拆分,baseLib和Lib其实也可以合并为一个整体
二、 组件化完善与优化
相比于单个App Module ,多个Module 多个Lib 要实现业务逻辑,还存在一些问题:
1 . 组件间界面跳转,不同组件之间不仅会有数据的传递,也会有相互的页面跳转。(ARouter)
2 . 数据传递与组件间方法 如何相互调用。
3 . 如何获取组件中 Fragment 的实例并将组件中的 Fragment 实例添加到主项目的界面中?
4 . 单个模块如何独立运行和组件式运行 切换问题。
5 . 多个content provider 初始话插件方式的优化 (startup)
- module单独运行 和合并运行管理。
三、组件化问题解决
1 . 界面跳转
Activity跳转分为 显示跳转和隐式跳转,但是显示跳转存在Activity之间的双向依赖,不符合组件化的架构思想定位,我们这里使用 隐式跳转,但是手搓Schame,清单文件会非常混乱,这里我们使用 alibaba 的开源库 ARouter。
原理:代码里加入的@Route注解,在编译时期通过apt生成存储path和activityClass映射关系的类文件,app进程启动的时候拿到这些类文件,把保存这些映射关系的数据读到map中,进行路由跳转的时候,通过build()方法传入要到达页面的路由地址,ARouter会通过它自己存储的路由表找到路由地址对应的Activity.class(activity.class = map.get(path)),然后new Intent(),当调用ARouter的withString()方法它的内部会调用intent.putExtra(String name, String value),调用navigation()方法,它的内部会调用startActivity(intent)进行跳转,这样便可以实现相互没有依赖的module顺利的启动对方的Activity了。
代码示例:
// 路由 gradle引入(kotlin 和 java引入方式区分)
api libs.arouter_api
kapt libs.arouter_compiler
// 定义路由地址
object ARouterConstant {
// == 服务
const val LOGIN_SERVICE = "/login/login_service"
//====== login
//跳转到登陆页面
const val LOGIN_ACTIVITY = "/login/LoginActivity"
const val LOGIN_FRAGMENT = "/login/LoginFragment"
...
}
// 路由地址目标类
@Route(path = LOGIN_ACTIVITY)
class LoginActivity : ContainerActivity() {
override fun initBaseFragment(): Fragment? {
return LoginFragment()
}
}
//调用界面跳转
ARouter.build(ARouterConstant . LOGIN_ACTIVITY).navigation()
2 . 通信问题
常用的通信方式有:BroadcastReceiver 、EventBus、接口等,考虑到 BroadcastReceiver 偏重,Eventbus 虽然3.0以后采用注解方式通信比2.X版本采用反射快得多,但根据组件化架构多个Module都依赖于Base Module,这里使用ARouter 的IProvider方式进行数据传递。
//接口定义
interface LoginService : IProvider {
val userInfo: UserBean?
...
}
//接口实现
@Route(path = LOGIN_SERVICE)
class LoginServiceImpl : LoginService {
override val userInfo: UserBean
get() = getUserBean()
...
}
// 调用
class LoginImpl public constructor() {
init {
//初始化
ARouter.getInstance().inject(this)
}
@Autowired(name = ARouterConstant.LOGIN_SERVICE)
lateinit var mLoginService: LoginService
/**
* 获取用户信息
*/
val userInfo: UserBean?
get() = mLoginService.userInfo
}
3. 单工程方案
由于多个Module,存在独立运行和合并运行的情况,资源文件命名冲突及 Lib、Module定义等问题。
// module_home.gradle文件
apply from: rootProject.file('module.gradle')
android {
defaultConfig {
//仅在以application方式编译时才添加applicationId属性
if (runAsApp) {
applicationId build_version.applicationId + '.module_home'
}
}
//资源命名规范
resourcePrefix "home_"
kotlinOptions {
jvmTarget = JavaVersion.VERSION_1_8.toString()
}
}
dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
...
}
通过上述资源规范,可以让各个module出现命名不规范的变量名,会给予提示。
//
//是否library
def isLibrary = ext.has('isLibrary')
ext.isLibrary = isLibrary
//
def isMainLibrary = ext.has('isMainLibrary')
ext.isMainLibrary = isMainLibrary
//设置到ext中,供lib的build.gradle使用
apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
android {
compileSdkVersion build_version.compileSdkVersion
buildToolsVersion build_version.buildToolsVersion
defaultConfig {
...
}
buildTypes {
debug {
...
}
release {
release {
...
}
}
}
sourceSets {
main {
jniLibs.srcDirs = ['libs']
}
}
// 省略部分配置
...
}
dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
...
}
上述代码,通过ext.isLibrary来区分该module是以lib方式运行还是独立运行。
local.properties 文件
sdk.dir=/Users/yangmingchuan/Library/Android/sdk
// 配置本地debug 开关
#module_home=true
#module_login=true
module.gradle 文件
//配置AndroidManifest.xml在library模式和application模式下的文件路径
android {
//隐藏部分配置
...
sourceSets {
main {
jniLibs.srcDirs = ['libs']
//默认的作为application运行时Manifest文件路径
def debugManifest = 'src/main/debug/AndroidManifest.xml'
if (runAsApp && project.file(debugManifest).exists()) {
manifest.srcFile debugManifest
} else {
manifest.srcFile 'src/main/AndroidManifest.xml'
//集成开发模式下自动排除debug文件夹中的所有Java文件
// 可以将debug代码放在这个包内,例如:Application子类
java {
exclude 'debug/**'
}
}
// 注:2018-03-12推荐:将组件单独以app运行时的测试代码及资源放到src/main/debug/目录下
if (runAsApp) {
//debug模式下,如果存在src/main/debug/assets,则自动将其添加到assets源码目录
if (project.file('src/main/debug/assets').exists()) {
assets.srcDirs = ['src/main/assets', 'src/main/debug/assets']
}
//debug模式下,如果存在src/main/debug/java,则自动将其添加到java源码目录
if (project.file('src/main/debug/java').exists()) {
java.srcDirs = ['src/main/java', 'src/main/debug/java']
}
//debug模式下,如果存在src/main/debug/res,则自动将其添加到资源目录
if (project.file('src/main/debug/res').exists()) {
res.srcDirs = ['src/main/res', 'src/main/debug/res']
}
}
}
}
//隐藏部分配置
...
}
上述代码,使用读取 local.properties 本地配置,sync project 后,即可单Module运行 加载src/main/debug文件夹下的清单文件, 开始debug测试。
V1.0工程图该文章为本人学习组件化总结,有不当的地方还望指出,一起学习。
后续不断更新....
不要脸贴下GitHub ComponentMaster
网友评论