ARouter组件化开发及用法全解

为什么要组件化开发?

在项目庞大,业务复杂的app下,如果不采用组件化的开发方式,或许会因为功能区分不明显,导致各个功能块、页面相互依赖,相互调用太多导致耦合度高。而采用组件化可以使我们的模块有明显的划分,强制将我们的功能耦合度降低。

组件化开发项目结构

组件化就是要将项目的各个功能拆成多个模块,就比如抖音来说,有视频播放的app主模块,登录注册模块,视频选择发布模块,相机拍摄特效模块等。


来自郭林的图
ARouter的优势:
  • 支持多模块使用,支持组件化开发
  • 使用注解,实现了映射关系自动注册与分布式路由管理
  • 编译期间处理注解,并生成映射文件,没有使用反射,不影响运行时性能
  • 映射关系按组分类、多级管理,按需初始化
  • 灵活的降级策略,每次跳转都会回调跳转结果,避免StartActivity()一旦失败将会抛出运营级异常
  • 自定义拦截器,自定义拦截顺序,可以对路由进行拦截,比如登录判断和埋点处理
  • 支持依赖注入,可单独作为依赖注入框架使用,从而实现跨模块API调用
  • 支持直接解析标准URL进行跳转,并自动注入参数到目标页面中
  • 支持获取Fragment

跳转原理解析:

路由框架会在项目的编译期通过注解处理器扫描所有添加@Route注解的Activity类,然后将Route注解中的path地址和Activity.class文件映射关系保存到它自己生成的java文件中,只要拿到了映射关系便能拿到Activity.class。当调用build()时,实际调用的是new Intent(context, activity.Class),activity.Class是根据之前的映射文件找到的。当调用ARouter的withXxx()方法它的内部会调用intent.putExtra(String name, String value),调用navigation()方法,它的内部会调用startActivity(intent)进行跳转,这样便可以实现两个相互没有依赖的module顺利的启动对方的Activity了。

List classFileNames = ClassUtils.getFileNameByPackageName(mContext, ROUTE_ROOT_PAKCAGE);

            //
            for (String className : classFileNames) {
                if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_ROOT)) {
                    // This one of root elements, load root.
                    ((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);
                } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_INTERCEPTORS)) {
                    // Load interceptorMeta
                    ((IInterceptorGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.interceptorsIndex);
                } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_PROVIDERS)) {
                    // Load providerIndex
                    ((IProviderGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.providersIndex);
                }
            }

demo代码直通车

示例项目模块结构图:

分为app模块,base模块,登录模块。


组件化开发Arouter配置

1.在libbase模块的gradle文件引入ARouter库:

    api 'com.alibaba:arouter-api:1.2.1'
    annotationProcessor 'com.alibaba:arouter-compiler:1.1.2'

2.在其他模块gradle文件中加入

    annotationProcessor 'com.alibaba:arouter-compiler:1.1.2'

3.在各个模块的gradle文件的defaultConfig标签下加入

        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [ moduleName : project.getName() ]
            }
        }

4.在application中初始化Arouter配置:

        if (AppConfig.isDebug) {
            ARouter.openDebug();
            ARouter.openLog();
        }
        ARouter.init(this);

5.设置跳转路径配置类:

public class RouterPath {
    public static final String ROUTER_LOGIN = "/login/loginPage";
}

6.在需要跳转到的类上设置跳转路径:

@Route(path = RouterPath.ROUTER_LOGIN)
public class LoginActivity extends AppCompatActivity {
}

7.各个模块依赖base模块,app模块依赖login模块。

8.从app模块跳转到登录模块:
build()方法传入跳转的路径
withxxx()设置跳转的传参
.withTransition()设置进入退出的动画

        ARouter.getInstance().build(RouterPath.ROUTER_LOGIN)
                .withString("phone", "18201038278")
                .withTransition(R.anim.dialog_enter, R.anim.dialog_exit)
                .navigation();

传值类型包括:


屏幕快照 2018-11-08 下午3.08.59.png

8.在app模块中获取子模块的fragment,这样就能直接操作该fragment。

(Fragment) ARouter.getInstance().build(RouterConfig.MY_HOME).navigation();
各个模块其他配置

公共模块的application是application类的基类:

/**
 * create by libo
 * create on 2018/12/26
 * description 公共模块基类Application
 */
public class BaseApplication extends Application {
    public static BaseApplication instance;

    @Override
    public void onCreate() {
        super.onCreate();
        instance = this;
        init();
    }

    private void init() {
        //组件化ARouter初始化
        if (AppConfig.isDebug) {
            ARouter.openDebug();
            ARouter.openLog();
        }
        ARouter.init(this);
    }
}

其他模块的application继承基类application:

public class MyApplication extends BaseApplication {

    @Override
    public void onCreate() {
        super.onCreate();
    }
}
其他配置:

权限等配置写在app模块下的AndroidManifest.xml中;字符串、颜色、尺寸资源等写在公共模块下。

ARouter功能用法

1.Arouter实现startActivityForResult()方式,1表示传的requestCode。
//这里的1为requestCode
ARouter.getInstance().build(RouterPath.ROUTER_LOGIN)
                .navigation(this, 1);
2.@Autowired注解获取传递参数

跳转ROUTER_INTENT的path页面,传递id,name2个参数

        ARouter.getInstance().build(RouterPath.ROUTER_INTENT).withInt("id", 100)
            .withString("name", "王力宏").navigation();

在ROUTER_INTENT页面声明添加注解的属性,然后需要在onCreate()方法里声明 ARouter.getInstance().inject(this) 进行注册,跳转的页面注解属性会自动赋值。

    @Autowired(name = "id")
    int id;
    @Autowired(name = "name")
    String name;
3.拦截器使用

这里用于处理判断登录登录的拦截器,通过对传递的extra值进行判断。继承IInterceptor接口处理process方法。根据extra自定义判断条件,跳转到登录页面。

/**
 * create by libo
 * create on 2020-06-03
 * description 登录拦截器  getExtra  右边第一位代表是否需要登录   0代表需要登录,1不需要登录,默认不传extra也需要登录
 */
@Interceptor(priority = 3)
public class SignInterceptor implements IInterceptor {

    @Override
    public void process(Postcard postcard, InterceptorCallback callback) {
        int extra = postcard.getExtra();
        if ((extra & 1) == 0) {
            //需要登录
            ARouter.getInstance().build(RouterPath.ROUTER_LOGIN).navigation();
            callback.onInterrupt(null);
        } else {
            callback.onContinue(postcard);
        }
    }

    @Override
    public void init(Context context) {

    }
}

需要登录页面设置extras=0,不需要登录的页面设置extras=1。

@Route(path = RouterPath.ROUTER_NEED_LOGIN, extras = 0)
public class NeedLoginActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_need_login);
    }
}
4.监听跳转过程
ARouter.getInstance().build(RouterPath.ROUTER_NEED_LOGIN).navigation(this, new NavCallback() {
            @Override
            public void onFound(Postcard postcard) {
                Log.e("minfo", "页面找到了");
            }

            @Override
            public void onLost(Postcard postcard) {
                Log.e("minfo", "页面找不到了");
            }

            @Override
            public void onArrival(Postcard postcard) {
                Log.e("minfo", "页面跳转完成");
            }

            @Override
            public void onInterrupt(Postcard postcard) {
                Log.e("minfo", "页面被拦截了");
            }
        });
另外:Butterknife在子模块中的配置

1.在base模块的gradle文件中加入库引入:

    api 'com.jakewharton:butterknife:8.5.1'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'

2.在其他各个模块的gradle文件中加入:

    annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'

3.在子模块(除了app模块)中的gradle文件的顶部加入使用butterknife插件配置:

apply plugin: 'com.jakewharton.butterknife'

4.在项目的gradle文件中dependencies标签下加入插件配置:

        classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1'
子模块中使用方式:

绑定控件需要将原本R来引入的改为R2来引入。

    @BindView(R2.id.tv_login_code)
    TextView tvLoginCode;
    @BindView(R2.id.et_login_phone)
    EditText etLoginPhone;
    @BindView(R2.id.btn_login_next)
    Button btnLoginNext;

事件绑定:原来用switch匹配的需要改为用if else匹配。

    @OnClick(R2.id.btn_login_next)
    void onClick(View view) {
        if (view.getId() == R.id.btn_login_next) {
            Toast.makeText(getApplicationContext(), getString(R.string.login), Toast.LENGTH_SHORT).show();
        }
    }
使用注意事项:

1.声明各个跳转的path,path需要以"/"开头,并且至少2个,否则会报
ARouter::Extract the default group failed, the path must be start with '/' and contain more than 2 '/'!

2.需要跨module使用的依赖需要用api,而不是implementation,否则base模块引入库其他模块使用不了。

3.application模块要跳转到子模块,如果子模块也是application状态,则Arouter跳转不生效,需要将application配置改为library配置。

你可能感兴趣的:(ARouter组件化开发及用法全解)