android 路由路径,GitHub - chiclaim/MRouter: Android 组件化路由框架，基于 APT、ASM、Gradle Plugin 等技术。实现了页面的跳转、参数的自动注...

MRouter(Android Modularization Router)

主要功能

支持不同模块之间的页面跳转

支持自动注入传递过来的参数

支持简单的依赖注入(用作注入其他 module 的业务类或者 Fragment)

支持对 Activity 的管理

使用过程中更友好的错误提示，提升开发效率

如何使用

1. 添加依赖配置

在工程的根目录 build.gradle 添加如下配置：

buildscript {

dependencies {

classpath "com.chiclaim:router-gradle-plugin:1.0.2"

}

}

//在每个使用了 MRouter 的组件工程中的 build.gradle 添加如下配置：

android {

javaCompileOptions {

annotationProcessorOptions {

arguments = [moduleName: project.getName()]

}

}

}

dependencies {

compile "com.chiclaim:router:1.0.1"

annotationProcessor "com.chiclaim:router-compiler:1.0.2"

}

//如果使用了模块化，需要在用到MRouter的模块下添加如下配置，这样才能成功生成代码(模块化使用 APT 工具生成代码都需要如此)

annotationProcessor "com.chiclaim:router-compiler:1.0.2"

移除在 Application 上使用 Components 注解的方式来实现初始化功能。

使用了 gradle-plugin + ASM 技术，在编译时修改 class 字节码的方式来实现自动初始化功能。

为了实现自动初始化功能，请将如下配置，复制到 app/build.gradle 文件中：

apply plugin: 'com.chiclaim.router.plugin'

router_register {

componentInterface = 'com.chiclaim.modularization.router.IComponent'

componentPackage = 'com.chiclaim.modularization.router'

routerInitClass = 'com.chiclaim.modularization.router.RouterInit'

routerInitMethod = 'init'

}

2. API 使用

框架的初始化操作

public class MyApplication extends Application {

@Override

public void onCreate() {

super.onCreate();

MRouter.getInstance().init(this);//初始化操作

}

}

使用 @Route 注解告知框架哪些 Activity 交给框架管理

@Route(path = "xxx/main")//path就是路由的路径

public class MainActivity extends AppCompatActivity {

//...

}

界面跳转和参数传递

MRouter.getInstance()

.build("xxx/main")//build方法参数就是目标界面的路由路径

.putSerializable("user", user)//传递参数

.putParcelable("address", address)//传递参数

.navigation(this);

支持的参数类型和 Intent 参数传递的类型一致

putBoolean(name, boolean)

putBooleanArray(name , boolean[])

putByte(name, byte)

putByteArray(name, byte[])

putChar(name, char)

putCharArray(name, char[])

putShort(name, short)

putShortArray(name, short[])

putFloat(name, float)

putFloatArray(name, float[])

putInt(name, int)

putIntArray(name, int[])

putIntList(name, ArrayList)

putDouble(name, double)

putDoubleArray(name, double[])

putLong(name, long)

putLongArray(name, long[])

putString(name, String)

putStringArray(name, String[])

putStringList(name, ArrayList)

putParcelable(name, Parcelable)

putParcelableArray(name, Parcelable[])

putParcelableList(name, ArrayList)

putSerializable(name, Serialization)

putExtras(Bundle extras)

使用 @Autowired 注解完成在 Activity 和 Fragment 中自动注入参数

第一步：上一个界面传过来的参数在当前类中声明相应的属性，在该属性上加上 @Autowired 注解，name的值就是参数的key，如：

@Autowired(name = "user")

User user; //serializable

@Autowired(name = "address")

Address address; //parcelable

//支持注入其他模块的Fragment，

//也可以通过MRouter.getInstance().build("router path").find()方法获取实例

@Autowired(name = "/user/login")

Fragment loginFragment;

//省略其他类型，详情可以查看例子工程

第二步：调用 inject 方法，执行注入参数，如下所示：

@Override

protected void onCreate(@Nullable Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

MRouter.getInstance().inject(this);//注入操作

setContentView(R.layout.activity_layout);

}

提供不同模块之间的业务注入

使用方法和参数传递类似，不同之处在于目标类需要实现 IProvider 接口。 如：

public interface IOrderSource extends IProvider {

Order getOrderDetail(String orderId);

}

@Route(path = "/source/order")

public class OrderSourceImpl implements IOrderSource {

@Override

public Order getOrderDetail(String orderId) {

Order order = new Order();

order.setOrderId(orderId);

order.setOrderName("Android从入门到放弃");

order.setOrderPrice(100.9);

return order;

}

}

public class UserActivity extends BaseActivity{

@Autowired(name = "/source/order")

IOrderSource orderSource;

@Override

protected void onCreate(@Nullable Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

MRouter.getInstance().inject(this);

setContentView(R.layout.activity_user_order_list);

loadOrderDetail();

}

public void loadOrderDetail(){

//上面是通过 @Autowired 注解的方式注入的

//也可以通过 MRouter.getInstance().build("/source/order").find(); 方式

if(orderSource!=null){

orderSource.getOrderDetail("010101")

}

}

}

据此，可以通过两种方式来注入其他模块的业务类，第一种是注解自动注入的方式；第二种是通过 find 方法来手动获取。

两种方式的区别在于，使用注解的方式需要目标类实现 IProvider 接口。而使用 find 方式来获取则不需要，只需要在目标类加上 @Route 注解即可。

Activity Stack 管理

RouterActivityManager.get().finishActivity();

关闭当前界面的 Activity

RouterActivityManager.get().finishActivity(Activity activity);

关闭特定的 Activity 界面

RouterActivityManager.get().finishActivity(Class clazz);

关闭特定的 Activity 界面

RouterActivityManager.get().finishActivity(String routerPath);

关闭特定的 Activity 界面(要关闭的界面可能在其他模块定义的，拿不到它的 class，可使用它的 routerPath)

RouterActivityManager.get().finishActivity(List list);

关闭 List 里所有的 Activity 界面(list 里面的元素可以是：Activity 对象、Activity 的 Class、Activity 的 routerPath)

RouterActivityManager.get().finishAllActivityExcept(List excepts);

关闭所有的 Activity 界面，保留 excepts 集合的界面(excepts 里面的元素可以是 Activity 对象、Activity 的 Class、Activity 的 routerPath)

RouterActivityManager.get().finishAllActivityExcept(String routerPath);

关闭所有的 Activity 界面，保留 routerPath 对应的的 Activity

RouterActivityManager.get().finishAllActivityExcept(Class activityClass);

关闭所有的 Activity 界面，保留 activityClass 对应的的 Activity

RouterActivityManager.get().finishAllByRange(Class begin, Class end)

关闭区间所有界面，包含 begin 和 end。如栈中有 A、B、C、D、E、F，想关闭 C 到 F 之间的 Activity，begin 参数就是 C，end 参数就是 F

3. 混淆(Proguard)

如果你使用了 Proguard，需要添加如下配置：

#MRouter

-keep public class com.chiclaim.modularization.router.**{*;}

-keepclasseswithmembernames class * { @com.chiclaim.modularization.router.annotation.* ; }

-keepclasseswithmembernames class * { @com.chiclaim.modularization.router.annotation.* ; }

-keep public class * implements com.chiclaim.modularization.router.IAutowired{ public (**); }