https://github.com/sunfusheng/spi
SPI (Service Provider Interface) 助力 Android 组件化开发
https://github.com/sunfusheng/spi
annotation annotation-processor asm module serviceprovider spi
Last synced: 6 months ago
JSON representation
SPI (Service Provider Interface) 助力 Android 组件化开发
- Host: GitHub
- URL: https://github.com/sunfusheng/spi
- Owner: sunfusheng
- Created: 2019-03-01T08:05:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-24T06:58:54.000Z (over 5 years ago)
- Last Synced: 2025-03-22T22:24:15.458Z (7 months ago)
- Topics: annotation, annotation-processor, asm, module, serviceprovider, spi
- Language: Java
- Homepage: https://github.com/sunfusheng/SPI
- Size: 222 KB
- Stars: 13
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SPI
SPI (Service Provider Interface) 助力 Android 组件化开发
### Gradle配置:
| spi-core | spi-plugin |
| :--- | :--- |
| [ ](https://bintray.com/sfsheng0322/maven/spi-core/_latestVersion) | [ ](https://bintray.com/sfsheng0322/maven/spi-plugin/_latestVersion) |
#### project gradle
``` gradle
dependencies {
...
classpath 'com.sunfusheng:spi-plugin:'
}
```
#### module gradle
``` gradle
apply plugin: 'com.sunfusheng.spi'
dependencies {
...
implementation 'com.sunfusheng:spi-core:'
}
```
### 具体场景与使用
比如在组件化开发中，主工程（app module）会依赖各个子模块（sub module），我们会在主工程中初始化各个子模块，
通常我们的做法是在主工程中分别调用每个子模块初始化类的初始化和反初始化方法，那么问题来了，每增加一个模块就需要添加一行或若干行初始化和反初始化的代码，
当然这样也没什么问题，但是有没有一种更好的方式呢？
又比如在组件化开发中，主工程中的Activity包含若干个Fragment，每个Fragment都代表不同的业务封装在自己的模块中，
如果我们要找到这些Fragment并加载，虽然不是什么难事但是不是不够优雅呢？
那么我们是不是可以在编译时处理这些重复的劳动呢，将各个子模块的初始化类或Fragment类当成一种需要加载的服务，通过注解生成需要调用的代码入口，
在编译时将这些代码插入到统一的注册池中去；每个子模块包括主工程对应的服务实现类（可以叫Service Provider）都继承统一一个抽象类或实现一个接口，
这样我们只需要在主模块中找到那些实现固定抽象类或接口的服务然后统一操作就可以了，具体分解下使用步骤：
#### 1、根据需求定义抽象类(abstract class)或接口(Interface)
``` java
abstract public class AbsApplicationDelegate {
abstract public void onCreate(Application application);
public void onLowMemory() { }
public void onTrimMemory(int level) { }
public void onTerminate() { }
}
```
#### 2、子模块实现类继承抽象类或实现接口，并添加注解@Provide(AbsApplicationDelegate.class)
``` java
@Provide(AbsApplicationDelegate.class)
public class AApplicationDelegate extends AbsApplicationDelegate {
@Override
public void onCreate(Application application) {
Log.d("SPI", "AApplicationDelegate::onCreate()");
}
}
```
#### 3、主工程中实现所有服务(Service)提供者(Provider)的管理
``` java
public class ApplicationDelegateManager {
private static final ApplicationDelegateManager mDelegatesManager = new ApplicationDelegateManager();
private List mDelegates;
private ApplicationDelegateManager() {
mDelegates = ServiceProvider.getProviders(AbsApplicationDelegate.class);
}
public static ApplicationDelegateManager getInstant() {
return mDelegatesManager;
}
public void onCreate(Application application) {
for (AbsApplicationDelegate delegate : mDelegates) {
delegate.onCreate(application);
}
}
public void onLowMemory() {
for (AbsApplicationDelegate delegate : mDelegates) {
delegate.onLowMemory();
}
}
public void onTrimMemory(int level) {
for (AbsApplicationDelegate delegate : mDelegates) {
delegate.onTrimMemory(level);
}
}
public void onTerminate() {
for (AbsApplicationDelegate delegate : mDelegates) {
delegate.onTerminate();
}
}
}
```
#### 4、最后调用即可，也可以根据自己的需求解锁其他姿势
``` java
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ServiceProvider.init();
ApplicationDelegateManager.getInstant().onCreate(this);
}
@Override
public void onLowMemory() {
super.onLowMemory();
ApplicationDelegateManager.getInstant().onLowMemory();
}
@Override
public void onTrimMemory(int level) {
super.onTrimMemory(level);
ApplicationDelegateManager.getInstant().onTrimMemory(level);
}
@Override
public void onTerminate() {
super.onTerminate();
ApplicationDelegateManager.getInstant().onTerminate();
ServiceProvider.destroy();
}
}
```
### 个人微信公众号
### 关于我
[GitHub: sunfusheng](https://github.com/sunfusheng)
[个人邮箱: sfsheng0322@126.com](https://mail.126.com/)
[个人博客: sunfusheng.com](http://sunfusheng.com/)
[简书主页](http://www.jianshu.com/users/88509e7e2ed1/latest_articles)
[新浪微博](http://weibo.com/u/3852192525)