Skip to content

Latest commit

 

History

History
137 lines (88 loc) · 6.21 KB

README_CN.md

File metadata and controls

137 lines (88 loc) · 6.21 KB

你可能需要 SPI 了

为什么会开源这个 SPI 项目 ？

在项目组件化的过程中，曾通过 AndoridManifest.xml 注册的方式实现过 Application 生命周期的组件化，类似 Glide 中解析 AndoridManifest.xml 发现 GlideModule 的机制，有点繁琐。而后了解到 Google 的 AutoService，通过注解加 Java 原生 SPI，实现 Appcation 生命周期的组件化，好像刚刚好。SPI 可以没有，没有 SPI，可以用其他方案，比如说路由。首先，一般路由基本在提供路由该提供的功能，路由发现和注册机制局限在路由框架内部，不会提供 SPI，如果用路由实现，每添加一个需要 Application 生命周期的组件都需要通过在 Application 中添加代码，不是那么好维护。SPI 也可以到处都是，随着项目组件化后，发现很多地方都需要用到 SPI 机制，AutoService 加原生 SPI 机制，除了有反射还有IO，在接口非常多的时候，比较耗时。而 SPI 机制是遵循开闭原则的，这个事情也是在脑海里留下了不可描述的印象......于是慢慢的，才有了这个 SPI 项目。

在项目中引入 SPI

添加 spi-gradle-plugin 插件到你的项目


buildscript {
  ext {
        kotlin_version = '1.5.31'
        booster_version = '4.13.0'
  }

  repositories {
    jcenter()

    // add maven repository for spi-plugin at build.gradle file of root project
    maven { url "https://raw.githubusercontent.com/afirez/spi/master/repo/" }
  }

  dependencies {
    classpath 'com.afirez.spi:spi-gradle-plugin:3.0.0'
    // ①
    classpath "com.didiglobal.booster:booster-gradle-plugin:$booster_version"
    // ② figure out the features you really need, then choose the right module for integration
    // ② 弄清楚真正需要的特性，然后从下面的模块列表中选择正确的模块进行集成
    // classpath "com.didiglobal.booster:booster-task-all:$booster_version"
    // classpath "com.didiglobal.booster:booster-transform-all:$booster_version"
        
    // gradle plugin version <= 4.1.2
    // classpath 'com.afirez.spi:spi-gradle-plugin:2.0.0'
    
    // gradle plugin version <= 3.6.4
    // classpath 'com.afirez.spi:spi-gradle-plugin:1.0.1'
  }
}

// in module build.gradle
apply plugin: 'com.android.application'

// didi booster
apply plugin: 'com.didiglobal.booster' // ③

// gradle plugin version <= 4.1.2
// apply plugin: 'spi' 
// or apply plugin: 'com.afirez.spi'

添加 spi 到需要的子模块

allprojects {
  repositories {
    ...
    
    mavenCentral()
    google()
    // jcenter()
    
    // didi booster
    maven { url 'https://oss.sonatype.org/content/repositories/public/' }
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }

    // add maven repository for spi at build.gradle file of root project
    maven { url "https://raw.githubusercontent.com/afirez/spi/master/repo/" }

    ...
  }
}


implementation "com.afirez.spi:spi:1.0.1"

如何使用 SPI

1、从 SPI AppLike 谈起

实现 AppLike 接口，并添加 @SPI 注解，该实现者 App 将会在编译时被发现和注册到 ExtensionLoader 中，如下图所示：

然后, AppDelegate 可以通过 ExtensionLoader 拿到所有 AppLike 的实现者并分发 Application 的生命周期。如下图所示：

最后，记得在项目的 App 中调用 AppDelegate 相应方法（attachBaseContext，onCreate，onTerminate 等方法），这样其他模块便有了 Application 的生命周期。

2、SPI Actiivty

被 @SPI 注解过的 Activity ，会在编译期被发现并注册到 ExtensionLoader，然后可以通过 ExtensionLoader 获取指定路径 path 的 Activity 类。（如果 @SPI 中没有路径 path 的值，路径 path 的值将会是被注解类的包名加类名）

3、SPI Fragment

被 @SPI 注解过的 Fragment，会在编译期被发现并注册到 ExtensionLoader，然后可以通过 ExtensionLoader 获取指定路径 path 的 Fragment 类。（如果 @SPI 中没有路径 path 的值，路径 path 的值将会是被注解类的包名加类名）

4、SPI Provider

被 @SPI 注解过的 SpiKotlinProviderImpl，同样会在编译期被发现并注册到 ExtensionLoader，然后可以通过 ExtensionLoader 获取指定路径 path 的 SpiKotlinProvider 实现类。（如果 @SPI 中没有路径 path 的值，路径 path 的值将会是被注解类的包名加类名）

5、用 SPI 搞更多事情

SPI 是一个方便接口聚合与分发的工具，很多接口扩展的场景都需要用到，让我们的代码遵循开闭原则！例如 AppLike 实现 Application 生命周期组件化，请参考 AppLike 等用例自行扩展。

SPI 其实本身已有一个路由表，可以为接口或类（类支持 Activity 和 Fragment）的实现类指定 path 路径，方便我们拿到指定 path 的 实现类。如果你想自己实现组件化的路由，完全可以基于 spi 实现

SPI 聚焦于接口发现与注册和路由表，仅仅基于 SPI 实现 Android 组件化，模块解偶很彻底，但是缺少路由的一些功能，后续考虑开源一个路由项目，敬请期待！

去 spi github 下载源码试试， 了解更多细节。

感谢

afirez