Rubik是一套解决Android平台组件化的综合方案,提供gradle project之间的路由通讯能力,以及对gradle project的组件定义、版本控制、maven发布、aar/jar与源码之间的切换以及组件的自由组合等能力。
Rubik由两部分组成:
(1) 创建或使用已有的一个或多个android library module,作为"组件工程"(如demo代码中的demo_component_detail、demo_component_home等),用于开发真正的业务逻辑。
(2) 在最外层工程(gradle root project)的build.gradle或gradle.properties文件中配置Rubik版本号等初始化参数,并在最外层工程中启用rubik插件:
ext {
rubik_kapt_version = "com.rubik:kapt:1.9.1.1-K1_5"
rubik_router_version = "com.rubik:router:1.9.1.1-K1_5"
rubik_plugins_version = "com.rubik:plugins:1.9.1.1-AGBT4-K1_5"
}
apply plugin: 'rubik' // 启用rubik插件
(3) 在最外层工程的build.gradle文件或同级目录下的rubik-*.gradle文件中,配置组件信息:
rubik {
component { // 第一个组件
uri "app://com.myapp.home" // 组件的Uri
touching { // 组件需要依赖的其他组件
uri ("app://com.myapp.detail" ) {
version "0.1.1" // 依赖其他组件的版本
}
uri( … )
}
source { // 定义默认来源,如不需切换源码和aar,可以只声明project或maven
project (":demo_component_home")
}
}
component { … } //继续配置第二个组件
}
(1). 在接口提供者工程内,通过注解定义路由路径,作为组件暴露给其他组件的通信接口:
通过RFunction注解声明函数路由:
@RFunction(path = "account/user")
fun getUser(id : Int, name : String) : User? {
…
}
通过RPage注解声明页面路由:
@RPage(path = "page/main")
class HomeActivity : AppCompatActivity() {
…
}
(2). 执行接口提供者工程对应的"publishRubikXxxRContextLib"任务,发布组件上下文到云端或本地maven仓库。
(3). 执行接口提供者工程对应的"publishRubikXxxRComponent"任务,发布组件aar到云端或本地maven仓库。
(4). 在接口调用者工程内,调用上述接口提供者所提供的接口,可以选择两种方式:
通过Kotlin DSL:
navigate {
uri = "app://com.myapp.detail/account/user" // 请求的uri
query { // 请求的参数
"id" with 400
"name" with "CuiVincent"
}
result<User?> { user ->
// 通过泛型指定接收数据类型,多次异步返回时,可以用多个result接收
…
}
}
通过自动生成的镜像函数:
DetailContext.Account.user(400, "CuiVincent" ) { user ->
… // 自动生成的镜像函数的参数类型、返回值类型都是明确的,比DSL方式更具有约束力
}
(1). 创建或使用已有的android application project,作为"壳工程"(如demo代码中的demo_root_app),用于把组件组装并编译成Apk。
(2). 在"壳工程"的的build.gradle文件或同级目录下的rubik-*.gradle文件中,指定"壳工程"最终要将哪些组件,以哪种方式引入,并打包到最终的编译产物之中:
rubik {
packing {
projectMode { // projectMode,通过源码工程的方式引入组件
uri ("app://com.myapp.home")
uri ("app://com.myapp.*") // 支持通过*匹配任意字符
}
mavenMode { // mavenMode,通过maven上的aar的方式引入组件
uri ("app://com.myapp.detail") {
version "0.2.0"
}
}
}
}
@RunWith(AndroidJUnit4::class)
class RouterTestCase {
@Before
fun init() {
Rubik.init()
} // 初始化Rubik
@Test
fun usePerview() {
PerviewContext.preViewVideo(path) { success ->
log("preViewVideo success:${success}")
} // 测试用例
}
… // 继续写测试用例
}
## 如何贡献
请用Kotlin语言编写,所有注明动机的合理改动提交都会被接收。