ARouter学习之一——框架的使用

最新推荐文章于 2024-04-01 06:48:55 发布

bendan50

最新推荐文章于 2024-04-01 06:48:55 发布

阅读量2.4k

点赞数

分类专栏： ARouter android

本文链接：https://blog.csdn.net/bendan50/article/details/101033656

版权

android 同时被 2 个专栏收录

28 篇文章 1 订阅

订阅专栏

ARouter

3 篇文章 0 订阅

订阅专栏

按照ARouter学习之三——注解解析器（arouter-compiler源码）的结尾，似乎这应该是学习之四，但我选择标题起为之一，虽说是后面才写，但毕竟学习的话都是先学会用，再去弄懂原理。而总结顺序，则是根据好奇心的顺序来整理。

本文的初衷：搞懂在项目中怎样引入ARouter并加以使用

引入ARouter建立依赖

该小节的内容均引自github上的文档，若需要请稳步：https://github.com/alibaba/ARouter/blob/master/README_CN.md

build.gradle文件内容如下：

android {
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
    }
}

dependencies {
    // 替换成最新版本, 需要注意的是api
    // 要与compiler匹配使用，均使用最新版可以保证兼容
    compile 'com.alibaba:arouter-api:x.x.x'
    annotationProcessor 'com.alibaba:arouter-compiler:x.x.x'
    ...
}

最可能早的注册ARouter，在MyApplication中进行初始化

if (isDebug()) {           // 这两行必须写在init之前，否则这些配置在init过程中将无效
    ARouter.openLog();     // 打印日志
    ARouter.openDebug();   // 开启调试模式(如果在InstantRun模式下运行，必须开启调试模式！线上版本需要关闭,否则有安全风险)
}
ARouter.init(mApplication); // 尽可能早，推荐在Application中初始化

至此，完成依赖的建立，接下来就可以正常使用。

各类简单的跳转

通过前两篇的源码阅读RouteType类，我们知道ARouter支持跳转的对象包括：Activity、Fragment、Service，本节来看看如何使用ARouter框架来进行这样的跳转。其步骤可拆分成两步：添加注解和发起路由操作。

添加注解：

// 在支持路由的页面上添加注解(必选)
// 这里的路径需要注意的是至少需要有两级，/xx/xx
@Route(path = "/test/activity")
public class YourActivity extend Activity {
    ...
}

注意path必须不能少于两级，若只是[/xx]的话，则ARouter会抛出数组越界异常，原因是在源码中获取路由“组”指明确指出的。下一篇文章重点分析为什么发起路由操作时就可以进行跳转时，会分析到这块的代码。请稳步我之前的文章（在学习ARouter源码前自己挖的坑）ARouter报错：Failed to extract default group! String index out of range: -2

然后，就可以发起路由操作了。

// 1. 应用内简单的跳转(通过URL跳转在'进阶用法'中)
ARouter.getInstance().build("/test/activity").navigation();

// 2. 跳转并携带参数
ARouter.getInstance().build("/test/1")
            .withLong("key1", 666L)
            .withString("key3", "888")
            .withObject("key4", new Test("Jack", "Rose"))
            .navigation();

简而言之，就是获取ARouter单例后，调用build传入路径，若有参数，则通过withType添加键值对，最后调用naigation()方法即可。

我怎么知道这些的呢？这是我必须告诉读者的，鱼与渔。ARouter的github上的指南以及它的源码。

上面是跳转到Activity，并传递简单的参数，下面列下跳转Fragment和Service的代码，实质实际是完全一样的。

@Route(path = "/test/fragment")
public class BlankFragment extends Fragment {

    @Autowired
    String name;

    ...
}

case R.id.getFragment:
     Fragment fragment = (Fragment) ARouter.getInstance().build("/test/fragment").navigation();
     Toast.makeText(this, "找到Fragment:" + fragment.toString(), Toast.LENGTH_SHORT).show();
     break;

import com.alibaba.android.arouter.facade.template.IProvider;
//需要继承IProvider
public interface HelloService extends IProvider {
    void sayHello(String name);
}

//接口实现类
@Route(path = "/yourservicegroupname/hello")
public class HelloServiceImpl implements HelloService {
    Context mContext;

    @Override
    public void sayHello(String name) {
        Toast.makeText(mContext, "Hello " + name, Toast.LENGTH_SHORT).show();
    }

    /**
     * Do your init work in this method, it well be call when processor has been load.
     *
     * @param context ctx
     */
    @Override
    public void init(Context context) {
        mContext = context;
        Log.e("testService", HelloService.class.getName() + " has init.");
    }
}

发起Service路由，有两种方式，一种通过路由路径，一种通过类

case R.id.navByName:
	((HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation()).sayHello("mike");
	break;
case R.id.navByType:
	ARouter.getInstance().navigation(HelloService.class).sayHello("mike");
	break;