阿里 ARouter 框架解析(一)

前言

  阿里 ARouter 框架是一个路由框架,用于解决我们项目组件化时,Module 之间进行进行通信的问题。

如何使用

github 地址:https://github.com/alibaba/ARouter

  我们新建一个项目,然后分别新建几个 Module


阿里 ARouter 框架解析(一)_第1张图片
image.png

  basemodule 模块,我们放一些共用的东西,并且在他的 build.gradle 添加如下配置:

    android {
     //...
      defaultConfig {
          //...
          javaCompileOptions {
              annotationProcessorOptions {
                  arguments = [moduleName: project.getName()]
                }
            }
        }
    }
    //使用 ARouter 框架
    compile 'com.alibaba:arouter-api:1.3.1'
    /*
        annotationProcessor只在编译的时候执行依赖的库,但是库最终不打包到apk中。
        编译库中的代码没有直接使用的意义,也没有提供开放的api调用,最终的目的是得到编译库中生成的文件,供我们调用。
    */
    annotationProcessor 'com.alibaba:arouter-compiler:1.1.4'

然后在其他的模块下面添加如下配置

注意:关于 annotationProcessor、android-apt、Provided,的区别等知识 https://blog.csdn.net/xx326664162/article/details/68490059

    android {
     //...
      defaultConfig {
          //...
          javaCompileOptions {
              annotationProcessorOptions {
                  arguments = [moduleName: project.getName()]
                }
            }
        }
    }
    //使用 ARouter 框架
    compile project(':app-basemodule')
    annotationProcessor 'com.alibaba:arouter-compiler:1.1.4'

注:在 app 模块下面还要增加如下配置:

compile project(':app-module1') compile project(':app-module2')

  配置完成后,我们开始编写代码,首先,我们让每个 Moudle 都有两个 Activity(MainActivity,SecondActivity),base 模块中有一个接口。

  • 1.base 模块:
public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        if(BuildConfig.DEBUG){
            // 这两行必须写在init之前,否则这些配置在init过程中将无效
            ARouter.openLog();// 打印日志
            ARouter.openDebug();// 开启调试模式(如果在InstantRun模式下运行,必须开启调试模式!线上版本需要关闭,否则有安全风险)
        }
        ARouter.init(this);// 尽可能早,推荐在Application中初始化
    }
}
import com.alibaba.android.arouter.facade.template.IProvider;

public interface BaseService extends IProvider {

    void getUserName();
}
import com.alibaba.android.arouter.facade.annotation.Route;

@Route(path = "/service/login")
public class LoginServiceImpl implements BaseService {

    private Context mContext;

    @Override
    public void getUserName() {
        Toast.makeText(mContext, "获取用户姓名", Toast.LENGTH_SHORT).show();
    }

    @Override
    public void init(Context context) {
        this.mContext = context;
    }
}
  • 2.app 模块:
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;

import com.alibaba.android.arouter.facade.annotation.Route;
import com.alibaba.android.arouter.launcher.ARouter;
import com.radish.android.app_basemodule.LoginServiceImpl;

// 在支持路由的页面上添加注解(必选)
// 这里的路径需要注意的是至少需要有两级,/xx/xx
@Route(path = "/app/main")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        findViewById(R.id.btn_app).setOnClickListener(v -> {
            //应用内跳转
            ARouter.getInstance().build("/app/second").navigation();
        });

        findViewById(R.id.btn_module1).setOnClickListener(v -> {
            //跳转到 module1 模块
            ARouter.getInstance().build("/module1/main").navigation();
        });

        findViewById(R.id.btn_module2).setOnClickListener(v -> {
            //跳转到 module2 模块
            ARouter.getInstance().build("/module2/main").navigation();
        });

        findViewById(R.id.btn_login).setOnClickListener(v -> {
            //调用 base 模块暴露的接口
            LoginServiceImpl loginService = (LoginServiceImpl) ARouter.getInstance().build("/service/login").navigation();
            loginService.getUserName();
        });
    }
}
@Route(path = "/app/second")
public class SecondActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
    }
}
  • 3.module1 模块:
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;

import com.alibaba.android.arouter.facade.annotation.Route;
import com.alibaba.android.arouter.launcher.ARouter;
import com.radish.android.app_basemodule.LoginServiceImpl;

@Route(path = "/module1/main")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_module1_main);

        findViewById(R.id.btn_module1).setOnClickListener(v -> {
            ARouter.getInstance().build("/module1/second").navigation();
        });

        findViewById(R.id.btn_app).setOnClickListener(v -> {
            ARouter.getInstance().build("/app/main").navigation();
        });

        findViewById(R.id.btn_module2).setOnClickListener(v -> {
            ARouter.getInstance().build("/module2/main").navigation();
        });

        findViewById(R.id.btn_login).setOnClickListener(v -> {
            LoginServiceImpl loginService = (LoginServiceImpl) ARouter.getInstance().build("/service/login").navigation();
            loginService.getUserName();
        });
    }
}
@Route(path = "/module1/second")
public class SecondActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_module1_second);
    }
}
  • 4.module2 模块:
@Route(path = "/module2/main")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_module2_main);

        findViewById(R.id.btn_module2).setOnClickListener(v -> {
            ARouter.getInstance().build("/module2/second").navigation();
        });

        findViewById(R.id.btn_app).setOnClickListener(v -> {
            ARouter.getInstance().build("/app/main").navigation();
        });

        findViewById(R.id.btn_module1).setOnClickListener(v -> {
            ARouter.getInstance().build("/module1/main").navigation();
        });

        findViewById(R.id.btn_login).setOnClickListener(v -> {
            LoginServiceImpl loginService = (LoginServiceImpl) ARouter.getInstance().build("/service/login").navigation();
            loginService.getUserName();
        });
    }
}
@Route(path = "/module2/second")
public class SecondActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_module2_second);
    }
}

运行结果

  我们看一下运行结果,首先是 app 模块从 MainActivity 跳转到 SecondActivity 模块内跳转,并且调用 base 模块暴露的接口。


阿里 ARouter 框架解析(一)_第2张图片
app 模块应用内跳转.gif

  然后是从 app 模块分别跳转到 moduel1 和 moduel2 模块,并且分别在各个模块中调用 base 模块暴露的接口中的方法。


阿里 ARouter 框架解析(一)_第3张图片
app 跳转到 module1和 module2.gif

  然后是 module1 中的应用内跳转和跨模块跳转
阿里 ARouter 框架解析(一)_第4张图片
module1 的跳转.gif

  module2 的跳转就不截图了,一样的。

你可能感兴趣的:(阿里 ARouter 框架解析(一))