ARetrofit - Android组件化最佳路由

Android组件化最佳路由，为简单而生。

Github 源码: ARetrofit

demo

demo apk 下载

一、介绍

从命名来看，做Android开发的小伙伴们感觉是不是似曾相识…是的，Retrofit，一款优秀的网络框架，目前正在被大量使用，相信大家对它的用法已经非常熟悉吧。

ARetrofit一款优秀的Android组件化框架（皮一下^_开心），可以轻松实现跨module通信。这里之所以使用Retrofit作为后缀命名主要是为了尊重retrofit大神的架构思路，其目的降低开发者的学习和使用成本。

如果你正在对项目进行组件化，ARetrofit将是不二选择。

二、功能介绍

新增ActivityCallback,通过配置一个参数实现Activity回调，且可以回传任意参数，告别onActivityResult繁琐写法，使用更灵活
支持直接解析标准URL进行跳转
支持跨module通信
支持添加多个拦截器，自定义拦截顺序
支持依赖注入，可单独作为依赖注入框架使用
可单独作为自动注册框架使用
支持InstantRun
支持MultiDex(Google方案)
页面、拦截器、服务等组件均自动注册到框架
支持获取Fragment
支持Kotlin混编
跨进程通信
特点：
简单、低侵入(只需要在Activity/Fragment/其他类声明路由注册)、易上手

##三、原理解析

基本用法

step1: 添加依赖和配置

project gradle file

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:x.x.x'
        //自动注入插件
        classpath "com.sjtu.yifei:auto-inject:1.0.1"
    }
}

app gradle file

//在plugin:'com.android.application'下添加以下插件，用于自动注入
apply plugin: 'com.sjtu.yifei.autoinject'

lib module gradle file

dependencies {
   ...
   annotationProcessor "com.sjtu.yifei:auto-complier:1.5.0"

   api "com.sjtu.yifei:auto-api:1.5.0"
}

kotlin lib module gradle file

apply plugin: 'kotlin-kapt' //kotlin 需要添加插件

dependencies {
    ...
    //kotlin使用kapt插件
    kapt "com.sjtu.yifei:auto-complier:1.5.0"

    api "com.sjtu.yifei:auto-api:1.5.0"
}

step2: 声明路由注解

Activity

/**
 * this activity in test-module1
 */
@Route(path = "/test-module1/Test1Activity")
public class Test1Activity extends AppCompatActivity {
    ...
}

Fragment

/**
 * this fragment in login-module
 */
@Route(path = "/login-module/TestFragment")
public class TestFragment extends Fragment {
    ...
}

step3: 面向接口编程:ARetrofit将Activity／Fragment 通信转化成接口

/**
 * this interface in router-module
 */
public interface RouteService {
    //Activity 跳转，支持注解传入参数/Flags/requestCode，参数解析遵循android机制
    @Flags(Intent.FLAG_ACTIVITY_NEW_TASK)
    @Go("/test-module1/Test1Activity")
    boolean launchTest1Activity(@Extra("para1") String para1, @Extra("para2") int para2);
    @Go("/test-module1/Test1Activity")
    boolean launchTest1ActivityForResult(@Extra("para1") String para1, @Extra("para2") int para2, @RequestCode int requestCode);

    //Fragment初始化，支持注解传入参数，参数解析遵循android机制
    @Go("/login-module/TestFragment")
    Fragment getTestFragment(@Extra("param1") String para1, @Extra("param2") int[] para2);
}

step4: 初始化SDK

    //在你的application onCreate()方法中
    Routerfit.init(this);

step5: 发起路由操作

private void launchTest1Activity(String para1, int para2) {
    //路由操作
   Routerfit.register(RouteService.class).launchTest1Activity(para1,para2);
}

step6：添加混淆规则(如果使用了Proguard)

-keep class * implements com.sjtu.yifei.ioc.**{*;}
-keep class * implements com.sjtu.yifei.annotation.AutoRegisterContract{*;}

三支持ActivityCallback

告别onActivityResult,使得代码更加简洁灵活，如登录回调

step1:注册登录接口

public interface RouteService {
    ...
    //通过配置ActivityCallback参数实现Activity回调
    @Go("/login-module/LoginActivity")
    boolean launchLoginActivity(@Extra ActivityCallback callback);
}

step2:登录回调操作（优雅的实现登录回调）

@Interceptor(priority = 3)
public class LoginInterceptor implements AInterceptor {

    private static final String TAG = "LoginInterceptor";
    @Override
    public void intercept(final Chain chain) {
        //Test2Activity 需要登录
        if ("/login-module/Test2Activity".equalsIgnoreCase(chain.path())) {
            Routerfit.register(RouteService.class).launchLoginActivity(new ActivityCallback() {
                @Override
                public void onActivityResult(int i, Object data) {
                    if (i == Routerfit.RESULT_OK) {//登录成功后继续执行
                        Toast.makeText(ActivityLifecycleMonitor.getTopActivityOrApp(), "登录成功", Toast.LENGTH_LONG).show();
                        chain.proceed();
                    } else {
                        Toast.makeText(ActivityLifecycleMonitor.getTopActivityOrApp(), "登录取消/失败", Toast.LENGTH_LONG).show();
                    }
                }
            });
        } else {
            chain.proceed();
        }
    }

}

四高阶用法

以登录组件为例

step1 声明登录服务

/**
 * this interface in router-module
 * 声明登录服务
 */
public interface ILoginProvider {
    String login();
}

注：#自己声明的服务需要防止混淆#

-keep class * implements com.sjtu.yifei.route.ILoginProvider{*;}

step2 实现服务

/**
 * the ILoginProvider in login-module/
 */
@Route(path = "/login-module/ILoginProviderImpl")
public class ILoginProviderImpl implements ILoginProvider {

    private String para1;
    private int para2;

    public ILoginProviderImpl(String para1, int para2) {
        this.para1 = para1;
        this.para2 = para2;
    }

    @Override
    public String login() {
        Routerfit.register(RouteService.class).launchLoginActivity();
        return "ILoginProviderImpl para1:" + para1 + ",para2:" + para2;
    }
}

step3 注册服务接口

public interface RouteService {
    ...
    //通过依赖注入解耦，支持注解传入构造函数参数
    @Go("/login-module/ILoginProviderImpl")
    ILoginProvider getILoginProviderImpl(@Extra("param1") String para1, @Extra("param2") int para2);
}

step4 拦截器功能

//拦截器只需申明注解，不需要额外处理。注：priority 值越大，拦截器优先级越高
@Interceptor(priority = 3)
public class LoginInterceptor implements AInterceptor {

    private static final String TAG = "LoginInterceptor";

    @Override
    public void intercept(Chain chain) {
        Log.e(TAG,"path:" + chain.path());
        //假如 Test2Activity 需要登录
        if ("/login-module/Test2Activity".equalsIgnoreCase(chain.path())) {
            if( /**是否需要登录*/) {//需要登录
                //获取登录服务
                ILoginProvider iProvider = Routerfit.register(RouteService.class).getILoginProviderImpl("provider from login-module", 10001);
                if (iProvider != null) {
                    iProvider.login();
                } else {
                    //传递请求，不执行以下代码则拦截请求
                    chain.proceed();
                }
            }
        } else {
            //传递请求，不执行以下代码则拦截请求
            chain.proceed();
        }
    }
}

最后

在这里我总结出了互联网公司Android程序员面试涉及到的绝大部分面试题及答案做成了文档和架构视频资料免费分享给大家【包括高级UI、性能优化、架构师课程、NDK、Kotlin、混合式开发（ReactNative+Weex）、Flutter等架构技术资料】，希望能帮助到您面试前的复习且找到一个好的工作，也节省大家在网上搜索资料的时间来学习。

资料获取方式：加入Android架构交流QQ群聊：513088520 ，进群即领取资料！！！

点击链接加入群聊【Android移动架构总群】：加入群聊

资料大全