ARetrofit

Project Url: yifei8/ARetrofit
Introduction: Android 组件化最佳路由,为简单而生。
More: Author   ReportBugs   OfficialWebsite   
Tags:

最新版本

模块 auto-api auto-complier auto-annotation auto-inject
最新版本 Download Download Download Download

Android 组件化超级路由,为简单而生。

Github 源码: ARetrofit

demo

demo apk 下载

一 介绍

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

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

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

二 功能介绍

  • 支持直接解析标准 URL 进行跳转
  • 支持跨 module 通信
  • 支持添加多个拦截器,自定义拦截顺序
  • 支持依赖注入,可单独作为依赖注入框架使用
  • 可单独作为自动注册框架使用
  • 支持 InstantRun
  • 支持 MultiDex(Google 方案)
  • 页面、拦截器、服务等组件均自动注册到框架
  • 支持获取 Fragment
  • 支持 Kotlin 混编
  • 跨进程通信(待完善~)如有 IPC 业务可参考ABridge 进程间通信最牛方案

特点: 简单、低侵入(只需要在 Activity/Fragment/其他类 声明路由注册)、易上手

二 基本用法

step1: 添加依赖和配置

//module gradle file
dependencies {
    ...
    annotationProcessor "com.sjtu.yifei:auto-complier:x.x.x"
    api "com.sjtu.yifei:auto-api:x.x.x"
}

//project gradle file
buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.1'
        //Gradle 插件实现路由表的自动加载
        classpath "com.sjtu.yifei:auto-inject:x.x.x"
    }
}

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

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);
      //支持直接解析标准 URL 进行跳转 传入 注解@Uri 参数
      boolean launchSchemeActivity(@Uri String uristring);
    
      //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{*;}
    

    三 高阶用法

  • 以登录组件为例

    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();
          }
      }
    }
    

    四 沟通交流

    qq 群

qq 交流群.jpeg

Email

iyifei8@gmail.com

644912187@qq.com

五 欢迎 fork、issues

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea