！！停止维护了！！由于 AGP8 已经不支持 Transform 接口，且基于字符协议的组件化方案存在协议难以管理和问题不好排查等因素，因此经过考虑后不再使用类似的方案，而是改用接口注入方案，详见 BCU modifier-component-di 。
YCR 是一个轻量级的，支持跨进程调用的，支持渐进式改造的组件化框架。
YCR 的设计初衷在于减少项目的组件化改造成本。框架整体采用贴近原生的设计思路，在尽可能保留原生能力上做扩展，以最大程度的保留兼容性和扩展性。
YCR 的整体设计和调用方式和 ARouter 类似，如果你之前采用的是 ARouter 方案，相信你很快就能上手。YCR 也继承了 CC 渐进式组件化的思想，提供了行为处理器用于处理组件间的交互行为，使新组件的开发不再必须要老项目提前解耦或下沉公共类，并且提供了开发时跨进程调用能力使新组件的开发更加便捷。
| module | describe |
|---|---|
| ycr-api | YCR 库常规开发包，不带跨进程功能 |
| ycr-api-dev | YCR 库开发时辅助包，带跨进程调用功能，可提升开发效率 |
| ycr-compiler | YCR 库的注解处理器包，用于处理 @Route 和 @RouteParam |
| ycr-plugin | YCR 库的插件包，用于收集路由，行为等信息并自动注册到框架中 |
- 页面，拦截器，行为处理器等组件自动注册
- 支持组件间行为调用，支持夸组件获取任意对象
- 支持开发时跨进程组件调用
- 支持路由过程拦截器。支持全局拦截器和局部拦截器分层拦截
- 支持绑定 Lifecycle 控制路由过程的生命周期
- 支持手动中断路由过程
- 支持 startActivityForResult
- 支持调用过程无入侵式获取 ActivityResult
- 支持设置原生转场动画
- 支持目标 Activity 路由参数注入
- 支持 Kotlin，Java 混编
- 支持自定义局部的路由过程的异常处理，处理后可选择是否抛到全局
- 支持自定义全局的路由过程的异常处理
- 分离开发时库和发布时库，使其更精简并且对 App 启动过程 0 影响
- YCR
- app —— 主组件 demo
- lib_base —— 组件基础库 demo
- module_m1 —— kotlin 的业务组件 demo
- module_java —— java 的业务组件 demo
- repos —— YCR 库的本地 maven 仓库，便于开发时调试和构建
- libs —— YCR 库的源码目录
- lib_ycr_annoation —— YCR 库所用的注解和路由基础实体
- lib_ycr_apt —— YCR 库的注解处理器
- lib_ycr_plugin —— YCR 库的插件，用于自动注册路由，拦截器等
- lib_ycr_api_core —— YCR 库 Api 的核心，用于实现 lib_ycr_api 和 lib_ycr_api_dev
- lib_ycr_api —— YCR 库的集成时 Api
- lib_ycr_api_dev —— YCR 库的开发时 Api（用于开发时跨进程调用）
- ./gradlew uploadArchives
// Top-level build file
buildscript {
ext.kotlin_version = '1.4.10'
ext.LIB_VERSION = 'xxx.xxx.xxx'
... ...
dependencies {
... ...
// kotlin 插件
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
// YCR 库插件
classpath "com.ysj.lib.ycr:ycr-plugin:$LIB_VERSION"
}
}// 导入 kotlin 相关插件
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
// 若该 module 是组件则必须要导入 YCR 插件
apply plugin: 'ycr-plugin'
// 设置 ycr-plugin 的编译参数
ycr {
// 若该 module 是主组件，则必须设置
main = true
// 设置 YCR 编译时日志输出等级（可选）
loggerLevel = 1
}
android {
... ...
// 设置 java 环境为 java 8
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
// 设置 kotlin 环境为 jvm 1.8
jvmTarget = '1.8'
// 设置 kotlin 接口兼容 java 8 的默认方法
freeCompilerArgs = ["-Xjvm-default=enable"]
}
}
dependencies {
... ...
// kotlin 依赖
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
implementation 'androidx.core:core-ktx:1.3.1'
// 根据实际情况导入依赖
// implementation "com.ysj.lib.ycr:ycr-api:$LIB_VERSION"
// implementation "com.ysj.lib.ycr:ycr-api-dev:$LIB_VERSION"
// kapt "com.ysj.lib.ycr:ycr-compiler:$LIB_VERSION"
}-keep class * implements com.ysj.lib.ycr.template.YCRTemplate
-keep class * implements java.io.Serializable {<methods>;}
// 通过 @Route 标记 Activity 即可实现页面间路由
@Route(path = "/test/activity")
public class YourActivity extends Activity {
...
}public class YourActivity extends Activity {
@RouteParam
int i;
@RouteParam
boolean b;
@RouteParam
String str;
// 通过 name 手动指定 key
@RouteParam(name = "name")
String aaa;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 通过该代码标记该类需要注入
YCR.getInstance().inject(this);
}
}public class YourExceptionProcessor implements IGlobalExceptionProcessor {
@Override
public short priority() {
// 你可以通过重写该方法定义异常处理器的优先级
// 优先级可以相同，但是相同的优先级不保证执行顺序
return 0;
}
@Override
public boolean handleException(@NotNull Postman postman,
@NotNull IYCRExceptions iycrExceptions) {
return false;
}
}// 通过 @Route 标记 IActionProcessor 的实现类来定义一个行为处理器
@Route(path = "/test/actions")
public class YourActionProcessor implements IActionProcessor {
@Nullable
@Override
public Object doAction(@NotNull Postman postman) {
// 在这里处理
switch (postman.getActionName()) {
case "your_action":
return "any object";
}
return null;
}
}// 通过实现 IInterceptor 接口来定义一个局部拦截器
public class YourLocalInterceptor implements IInterceptor {
@Override
public void onIntercept(@NotNull Postman postman,
@NotNull InterceptorCallback interceptorCallback) {
// 表示该拦截器允许继续后续的路由
interceptorCallback.onContinue(postman);
// 表示该拦截器不允许后续路由，并中断后续拦截器
// 你可以通过 InterruptReason 来告诉路由调用方中断路由的原因
interceptorCallback.onInterrupt(postman, new InterruptReason<>(1, "", null));
// 注意此处 onContinue 和 onInterrupt 必须调用其中一个，但不能都调用
}
}
// 局部拦截器通过如下方式调用
// YCR.getInstance().buile("your path").withInterceptor(new YourLocalInterceptor())// 通过实现 IGlobalInterceptor 接口来定义一个全局拦截器
// 全局拦截器执行于局部拦截器后，若局部拦截器拦截了则不会调用全局拦截器
// 全局拦截器会在符合调用条件时自动调用
public class YourInterceptor implements IGlobalInterceptor {
@Override
public void priority() {
// 你可以通过重写该方法定义拦截器的优先级
// 优先级可以相同，但是相同的优先级不保证执行顺序
return 1;
}
@Override
public void onIntercept(@NotNull Postman postman,
@NotNull InterceptorCallback interceptorCallback) {
// 此处的处理方式和局部拦截器一致
}
}// 你可以通过实现 IExecutorProvider 来为 YCR 提供一个 ThreadPoolExecutor
// 但这不是必须的，YCR 有自己默认的线程池（单线程）
// 在一个 app 中只能有一个 IExecutorProvider 实现，否则会在编译时提示错误
public class YourExecutorProvider implements IExecutorProvider {
@Nullable
@Override
public ThreadPoolExecutor providerExecutor() {
// 在这里返回你自己的线程池
// 若返回 null 时 YCR 会使用自己默认的线程池
return (ThreadPoolExecutor) Executors.newCachedThreadPool();
}
}YCR 支持流式调用 API，你可以在一行代码中完成组件间调用
// 路由到 @Route(path = ""/app/MainActivity"") 标识的 Activity 中
YCR.getInstance().build("/app/MainActivity").navigation(context)
// 路由过程绑定生命周期，当生命周期状态变更为 Lifecycle.State.DESTROYED 时会中断路由过程
YCR.getInstance()
.build("/app/MainActivity")
.bindLifecycle(lifecycle)
.navigation(context)
// 路由时携带参数（如下为传递整个 Bundle）
Bundle params = new Bundle();
YCR.getInstance()
.build("/app/MainActivity")
.withAll(params)
.navigation(context)
// 路由时 Activity 时指定 requestCode，此时 Context 需为 Activity 才能生效
YCR.getInstance()
.build("/app/MainActivity")
.withRequestCode(100)
.navigation(context)
// 路由到 @Route(path = "/app/actions") 标识的 IActionProcessor 中
// 并执行 app_test_action 行为
YCR.getInstance()
.build("/app/actions")
.withRouteAction("app_test_action")
.navigation(context)
// 同步调用行为并获取返回结果
Object result = YCR.getInstance()
.build("/m1/actions")
.withRouteAction("m1_test_action1")
.navigationSync(context)
// 添加路由结果的监听
YCR.getInstance()
.build("/app/actions")
.withRouteAction("app_test_action")
.addOnResultCallback(new RouteResultCallback<String>() {
@Override
public void onResult(@Nullable String result) {}
})
.navigation(context)
// startActivityForResult 并监听结果
YCR.getInstance()
.build("/java/MainActivity")
.bindLifecycle(lifecycle)
.withRequestCode(99)
.addOnResultCallback(new RouteResultCallback<ActivityResult>() {
@Override
public void onResult(@Nullable ActivityResult result) {}
})
.navigation(this)
// 添加路由过程被拦截器中断的监听
YCR.getInstance()
.build("/app/MainActivity")
.doOnInterrupt(new InterceptorCallback.InterruptCallback() {
@Override
public void onInterrupt(@NotNull Postman postman, @NotNull InterruptReason<?> reason) {}
})
.navigation(context)这通常有 2 种原因
-
在主线程中采用 navigationSync 方式调用时由于等待拦截器处理结果过长造成卡顿
解决方法：在子线程中调用，或减少拦截器处理时间。
-
在跨进程调用时长时间卡住，并且通过调试工具 dump 时显示类似如下
解决方法：这是由于 binder 长时间等待目标返回结果造成的。目标进程进入后台时间过长后会被系统挂起，只需要手动重新唤起目标即可。使用模拟器测试时不会出现，这可能与手机厂商的系统调度有关，因此这也是跨进程调用功能只是作为开发时辅助的原因之一。
- 欢迎 Issues，Fork
- 如果觉得对你有所帮助请给个 Star 吧！