guohongjun/Router

🍭灵活的组件化路由框架.

Router

建议浏览中文wiki. It's better than you think.

Getting started

• Add dependencies by adding the following lines to your build.gradle:

android {
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = ["moduleName": project.name]
            }
        }
    }
}

dependencies {
    implementation 'com.chenenyu.router:router:版本号'
    // 每个使用了@Router注解的module都要添加该注解处理器
    annotationProcessor 'com.chenenyu.router:compiler:版本号'
}

latest router version:

latest compiler version:

基本用法

1. 初始化

Router.initialize(new Configuration.Builder()
        // 调试模式，开启后会打印log
        .setDebuggable(BuildConfig.DEBUG)
        // 模块名(即project.name)，每个使用Router的module都要在这里注册
        .registerModules("your app module", "your lib module", "other module")
        .build());

2. 添加拦截器(可选)

@Interceptor("SampleInterceptor")
public class SampleInterceptor implements RouteInterceptor {
    @Override
    public boolean intercept(Context context, RouteRequest routeRequest) {
        // do something
        return false;
    }
}

3. 添加注解

// 给Activity添加注解，指定了路径和拦截器(可选)
@Route(value = "test", interceptors = "SampleInterceptor")
public class TestActivity extends AppCompatActivity {
    @InjectParam(key="foo") // 参数映射
    String foo;
  
     @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Router.injectParams(this);  // 自动从bundle中获取并注入参数
        ...
    }
}

// 给Fragment添加注解
@Route("test")
public class TestFragment extends Fragment {
    ...
}

4. 跳转

// 简单跳转
Router.build("test").go(this);
// startActivityForResult
Router.build("test").requestCode(0).go(this);
// 携带bundle参数
Router.build("test").with("key", Object).go(this);
// 添加回调
Router.build("test").go(this, new RouteCallback() {
        @Override
        public void callback(RouteResult state, Uri uri, String message) {
             // do something
        }
});
// 获取路由对应的intent
Router.build("test").getIntent();
// 获取注解的Fragment
Router.build("test").getFragment();

进阶用法

Please refer to the wiki for more information.

ProGuard

# Router
-keep class com.chenenyu.router.** {*;}
-keep class * implements com.chenenyu.router.template.ParamInjector {*;}

讨论

QQ group: 271849001

Donate ❤️

Click here.

License

Apache 2.0