ysj001 / ycr Goto Github PK

// 通过 @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();
    }
}

// 路由到 @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)