CC

Project Url: luckybilly/CC
Introduction: simple and powerful android componentized architecture framework 使用简单但功能强大的安卓组件化框架
More: Author   ReportBugs   OfficialWebsite   
Tags:
组件化-架构-组件-路由-解耦-

English README

Join the chat at https://gitter.im/billy_home/CC

模块 CC AutoRegister
最新版本 Download Download

技术原理: Wiki

demo 演示

demo 下载(包含主工程 demo 和 demo_component_a 组件)

demo_component_b 组件单独运行的 App(Demo_B)下载

以上2 个 app用来演示组件打包在主 app 内和单独以 app 运行时的组件调用,都安装在手机上之后的运行效果如下图所示

image

使用 CC 的理由

    从集成 CC 的那一刻起,你的项目就已经组件化成功了:新业务即可以组件的形式开发
    未解耦的模块通过创建一个 IComponent 接口的实现类即可暴露服务给其它组件调用(通过 CC 可支持跨 app 的组件调用)
    有闲暇时再将模块解耦出来,以使其可以单独编译运行
    解耦只是过程,而不是前提
    点击上方强烈推荐的文章链接⬆了解详细的渐进式组件化概念
  • 一静一动(开发时运行 2 个 app,功能完整)
    • 静:主 App (通过跨 App 的方式调用单组件 App 内的组件)
    • 动:单组件 App (通过跨 App 的方式调用主 App 内的所有组件)
    • 通过这种方式让组件之间完全无需依赖,从源头解决代码隔离的问题
  • 3 种 AOP 策略助你随心所欲进行 AOP 编程
    • 静态拦截器(全局拦截器)、动态拦截器、组件内部 onCall 方法中拦截
  • 对 Push 及 jsBridge 友好:直接转发对组件的调用即可,参考文章:-%E8%AE%A9jsBridge%E6%9B%B4%E4%BC%98%E9%9B%85)
  • 极低的学习成本,便于推广使用:只需了解一个接口和一个静态方法即可定义组件,只需了解一个链式调用即可调用组件

了解业界开源的一些组件化方案:多个维度对比一些有代表性的开源 android 组件化开发方案

CC 功能列表

    1. 支持组件间相互调用(不只是 Activity 跳转,支持任意指令的调用/回调)
    2. 支持组件调用与 Activity、Fragment 的生命周期关联
    3. 支持 app 间跨进程的组件调用(组件开发/调试时可单独作为 app 运行)
    4. 支持 app 间调用的开关及权限设置(默认为关闭状态,调用 CC.enableRemoteCC(true)打开)
    5. 支持同步/异步方式调用
    6. 支持同步/异步方式实现组件
    7. 调用方式不受实现方式的限制(例如:可以同步调用另一个组件的异步实现功能。注:不要在主线程同步调用耗时操作)
    8. 支持添加自定义拦截器【包括:静态拦截器(全局拦截器)和动态拦截器(局部拦截器)】
    9. 支持超时设置
    10. 支持手动取消
    11. 编译时自动注册组件(IComponent),无需手动维护组件注册表(使用 ASM 修改字节码的方式实现)
    12. 支持动态注册/反注册组件(IDynamicComponent)
    13. 支持组件间传递 Fragment、自定义 View 等(在同一个进程内传递)
        13.1 不仅仅是获取 Fragment、自定义 View 的对象,并支持后续的通信。
    14. 尽可能的解决了使用姿势不正确导致的 crash,降低产品线上 crash 率: 
        14.1 组件调用处、回调处、组件实现处的 crash 全部在框架内部 catch 住
        14.2 同步返回或异步回调的 CCResult 对象一定不为 null,避免空指针

目录结构

    - cc                            组件化框架基础库(主要)
    - cc-settings.gradle            组件化开发构建脚本(主要)
    - demo                          demo 主程序
    - demo_base                     demo 公共库(base 类、util 类、公共 Bean 等)
    - demo_component_a              demo 组件 A
    - demo_component_b              demo 组件 B
    - demo_component_kt             demo 组件(kotlin)
    - demo_interceptors             demo 全局拦截器(如果有多个 app 并且拦截器不同,可以创建多个 module 给不同 app 使用)
    - component_protect_demo        添加跨 app 组件调用自定义权限限制的 demo,在 cc-settings-demo-b.gradle 被依赖
    - cc-settings-demo-b.gradle     演示如何自定义配置文件,如:添加 actionProcessor 自动注册的配置
    - demo-debug.apk                demo 安装包(包含 demo/demo_component_a/demo_component_kt)
    - demo_component_b-debug.apk    demo 组件 B 单独运行安装包

集成(共 5 步)

下面介绍在 Android Studio 中进行集成的详细步骤

1. 添加引用

在工程根目录的 build.gradle 中添加组件自动注册插件

buildscript {
    dependencies {
        classpath 'com.billy.android:autoregister:x.x.x'
    }
}

2. 在每个组件 module(包括主 app)的 build.gradle 中:

apply plugin: 'com.android.library'
//或
apply plugin: 'com.android.application'

//替换成
//ext.mainApp = true //设置为 true,表示此 module 为主 app module,一直以 application 方式编译
apply from: 'https://raw.githubusercontent.com/luckybilly/CC/master/cc-settings.gradle'
//注意:最好放在 build.gradle 中代码的第一行

默认组件 module 为 library,若组件需要以 app 单独安装到手机上运行,可以在工程根目录的local.properties中添加配置

module_name=true #module_name 为具体每个 module 的名称,设置为 true 代表以 application 方式编译

可参考主 app module: demo/build.gradle 的配置组件 module: demo_component_a/build.gradle 的配置

3. 实现 IComponent 接口创建组件

创建组件(实现IComponent接口,需要保留无参构造方法)

public class ComponentA implements IComponent {
    //需保留无参构造方法

    @Override
    public String getName() {
        //组件的名称,调用此组件的方式:
        // CC.obtainBuilder("ComponentA").build().callAsync()
        return "ComponentA";
    }

    @Override
    public boolean onCall(CC cc) {
        Context context = cc.getContext();
        Intent intent = new Intent(context, ActivityComponentA.class);
        if (!(context instanceof Activity)) {
            //调用方没有设置 context 或 app 间组件跳转,context 为 application
            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        }
        context.startActivity(intent);
        //发送组件调用的结果(返回信息)
        CC.sendCCResult(cc.getCallId(), CCResult.success());
        //返回值说明
        // false: 组件同步实现(onCall 方法执行完之前会将执行结果 CCResult 发送给 CC)
        // true: 组件异步实现(onCall 方法执行完之后再将 CCResult 发送给 CC,CC 会持续等待组件调用 CC.sendCCResult 发送的结果,直至超时)
        return false;
    }
}

4. 调用组件

//同步调用,直接返回结果
CCResult result = CC.obtainBuilder("ComponentA").build().call();
//或 异步调用,不需要回调结果
String callId = CC.obtainBuilder("ComponentA").build().callAsync();
//或 异步调用,在子线程执行回调
String callId = CC.obtainBuilder("ComponentA").build().callAsync(new IComponentCallback(){...});
//或 异步调用,在主线程执行回调
String callId = CC.obtainBuilder("ComponentA").build().callAsyncCallbackOnMainThread(new IComponentCallback(){...});

更多使用方式请戳这里

5. 在主 app module 中按如下方式添加对所有组件 module 的依赖

注意:组件之间不要互相依赖

apply from: 'https://raw.githubusercontent.com/luckybilly/CC/master/cc-settings.gradle'

//...

dependencies {
    addComponent 'demo_component_a' //会默认添加依赖:project(':demo_component_a')
    addComponent 'demo_component_kt', project(':demo_component_kt') //module 方式
    addComponent 'demo_component_b', 'com.billy.demo:demo_b:1.1.0'  //maven 方式
}

用法示例见demo

按照此方式添加的依赖有以下特点:

  • 方便:组件切换 library 和 application 方式编译时,只需在 local.properties 中进行设置,不需要修改 app module 中的依赖列表
    • 运行主 app module 时会自动将【设置为以 app 方式编译的组件 module】从依赖列表中排除
  • 安全:避免调试时切换 library 和 application 方式修改主 app 中的依赖项被误提交到代码仓库,导致 jenkins 集成打包时功能缺失
  • 隔离:避免直接调用组件中的代码及资源

注意:

CC 会优先调用 app 内部的组件,只有在内部找不到对应组件且设置CC.enableRemoteCC(true)时才会尝试进行跨 app 组件调用

所以,单组件以 app 运行调试时,如果主 app 要主动与此组件进行通信,请确保主 app 中没有包含此组件(Tips:最简单的方式是重新 Run 一次主 app module)

状态码清单

状态码 说明
0 CC 调用成功
1 CC 调用成功,但业务逻辑判定为失败
-1 保留状态码:默认的请求错误 code
-2 没有指定组件名称
-3 result 不该为 null。例如:组件回调时使用 CC.sendCCResult(callId, null) 或 interceptor 返回 null
-4 调用过程中出现 exception,请查看 logcat
-5 指定的 ComponentName 没有找到
-6 context 为 null,通过反射获取 application 失败,出现这种情况可以用 CC.init(application)来初始化
-7 跨 app 调用组件时,LocalSocket 连接出错
-8 已取消
-9 已超时
-10 component.onCall(cc) return false, 未调用 CC.sendCCResult(callId, ccResult)方法
-11 跨 app 组件调用时对象传输出错,可能是自定义类型没有共用,请查看 Logcat

混淆配置

不需要额外的混淆配置

自动注册插件

源码:AutoRegister 原理:android 扫描接口实现类并通过修改字节码自动生成注册表

更新日志

遇到问题怎么办?

  • 先打开 CC 的日志开关,看完整的调用过程日志,这往往能帮助我们找到问题
    CC.enableDebug(true);  //普通调试日志,会提示一些错误信息
    CC.enableVerboseLog(true);  //组件调用的详细过程日志,用于跟踪整个调用过程
    
  • Wiki
  • 常见问题
  • issue
  • 加下方的 QQ 群提问

QQ 群

注:PPT 演讲稿《渐进式 Android 组件化实施方案》可在 QQ 群文件中下载,欢迎加群讨论

QQ 群号:686844583

CC 交流群

或者扫描下方二维码加群聊

image

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea