MRouter(Android Modularization Router)

主要功能

1.不同模块之间的页面跳转

支持fragment、activity的startActivityForResult()方法

2.自动注入传递过来的参数

支持fragment、activity自动注入参数，避免大量的的 getIntent.getXXX() 和 bundle.getXXX() 重复代码。

3.使用过程中更友好的错误提示

在使用的过程如果不符合MRouter的规范，会精确提示开发者哪行代码除了问题，由于什么原因造成的等。帮助快速定位问题，提高开发效率。

4.支持对Activity的管理

一般我们在程序中会把所有启动的Activity对象放在Stack栈中，便于统一管理（主要用于关闭）。例如启动了A、B、C、D四个界面，想关闭ACD界面只保留B界面，一般遍历栈只要不是B界面全部关掉， 如果想在app模块执行这个操作，且B界面在另一个模块，根本拿不到B的class，从而无法告诉工具类，要保留哪个界面（因为B界面不是在app模块定义的，在app模块拿不到）。所以如果使用到了模块化， 对Activity的管理的功能最好由模块化框架来提供。

如何使用

1. 添加依赖配置

在工程的根目录 build.gradle 添加如下配置：
allprojects {
    repositories {
        if (!useLocal.toBoolean()) {
            maven {
                url "https://dl.bintray.com/ggz-org/maven/"
            }
        }
        jcenter()
    }
}

//在每个使用了MRouter的字工程里的 build.gradle 添加如下配置：
android {
    javaCompileOptions {
        annotationProcessorOptions {
            arguments = [moduleName: project.getName()]
        }
    }
}

dependencies {
    compile "com.chiclaim:router:0.2.3"
    annotationProcessor "com.chiclaim:router-compiler:0.2.3"
}

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

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

2. API使用

1. 告诉框架哪些模块用到了MRouter，

如果你是多模块，请在Application类加上@Components注解：

//注意如果模块名包含了特殊字符，如sample.order，需要把'.'等特殊字符去掉
//app，sampleuser，sampleorder三个模块都使用了MRouter

@Components({"app", "sampleuser", "sampleorder"})
public class MyApplication extends Application {
    //...
}

2. 框架的初始化操作

@Components({"app", "sampleuser", "sampleorder"})
public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        MRouter.getInstance().init(this);//初始化操作
    }
}

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

@Route(path = "xxx/main")//path就是路由的路径
public class MainActivity extends AppCompatActivity {
    //...
}

4. 界面跳转和参数传递

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)

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

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

@Autowired(name = "user")
User user; //serializable

@Autowired(name = "address")
Address address; //parcelable

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

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

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    MRouter.getInstance().inject(this);//注入操作
    setContentView(R.layout.activity_layout);
}

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

使用方法和参数传递类似，不同之处在于目标类需要实现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(){
        if(orderSource!=null){
            orderSource.getOrderDetail("010101")
        }
    }
}

7. Activity的管理

• 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
  

混淆(Proguard)

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

#MRouter
-keep public class com.chiclaim.modularization.router.**{*;}
-keepclasseswithmembernames class * { @com.chiclaim.modularization.router.annotation.* <methods>; }
-keepclasseswithmembernames class * { @com.chiclaim.modularization.router.annotation.* <fields>; }
-keep public class * implements com.chiclaim.modularization.router.IAutowired{ public <init>(**); }

TODOs

重构生成的代码
优化通过@Components的方式来注册所有使用了MRouter的模块