Dagger自动注入框架PopStar

PopStar 1.0已经完成,本文主要阐述PopStar开发的构想和实现方案。
注:新项目建议使用dagger.android包下内容。


DI

DI (Dependency injection),即依赖注入。是我们在开发中经常使用的一种设计模式。简单的描述就是,依赖不在宿主中初始化,而是使用外部传入或工厂生成的方式。这样的设计模式带来如下几点好处:

  • 依赖的注入和配置独立于组件之外。
  • 因为对象是在一个独立、不耦合的地方初始化,所以当注入抽象方法的时候,我们只需要修改对象的实现方法,而不用大改代码库。
  • 依赖可以注入到一个组件中:我们可以注入这些依赖的模拟实现,这样使得测试更加简单。应用在Android开发中,开发者不再需要关注依赖的的生命周期和作用域,这些工作都交由框架管理。这种方式是非常棒的。

Java中有名的框架有JBoss Seam、Spring Framework、Google Guice和Google Dagger2 。PopStar基于Dagger2。

Dagger2

Dagger由Square开发,符合JSR-330规范。后由Google fork,开发了Dagger2 。Dagger2受Google AutoValue项目启发,采用生成+手写结合的方式实现了0反射,可跟踪,可混淆的框架。但这种方式同样带来缺乏动态性的问题,当使用范围扩大,会出现疲于重复手写component, module数量过多和scope无法管理等问题。

PopStar采用了apt+少量反射的模式,生成component和module的全部代码,scope限制在Application,Activity,Fragment三个层面(view的scope和容器相同)。同时对custom annotation做支持。让双手从重复劳动中解放出来。

PopStar

  • Component和Module

component的声明事实上是重复的相同操作,可以用模板解决一部分问题,但在使用时还是需要我们手动调用如下类似代码:

DaggerInjectActivity_DaggerComponent.builder().injectActivity_DaggerModule(new InjectActivity_DaggerModule()).build().inject(this);

这完全是没有必要的,在Android中,我们都会抽取BaseActivity作为一切Activity的父类,他承载了一部分初始化操作。由于Dagger2的限制我们无法直接在BaseActivity中简单声明。PopStar采用apt生成的方式解决了这个问题。当然生成是在编译时,所以不用担心性能和调试问题。具体步骤:

  • 构造Dagger2标准Component。构造DaggerInjector,用于真正的注入生成。
  • 记录class -> DaggerInjector 的Mapping。
  • 调用时查找,进行注入。

module的构造与component不同,他更复杂,是生命周期管理和域管理的载体。先来看一下构想的module结构:

@Module
public class InjectActivity_DaggerModule {
    protected final Provider provider;

    public InjectActivity_DaggerModule(Activity activity) {
        this.provider = Provider.get(activity);
    }

    @Provides
    public Activity provideActivity() {
        return provider.activityScope().getScope();
    }

    @Provides
    public Application provideApplication() {
        return provider.applicationScope().getScope();
    }

    @Provides
    public A provideA() {
        A a = provider.applicationScope().getInstance(A.class);
        AProxy.proxy(a, provideActivity());
        return a;
    }

    @Provides
    public TestInterface provideTestInterface() {
        return provider
                .activityScope()
                .getSingleton(TestInterface.class);
    }
}

module类中的provide方法都交给了provider去处理,provider则是通过自身及此例中的InjectActivity得到的。

  • Scope和Provider

上面说到,Scope在PopStar中只有三个。他们三者的可见性如下图:

dagger.png

其中Application的Scope最小,他只能看到自己范围内的实例,而Fragment最大,他能看到对应Activity Scope和Application中的全部内容。这样做的好处在于,每个域中的内容不需要关心外部是谁在操作,他只需要根据自己的生命周期来管理对应域下的实例。

具体实现,我们就是通过上面module中provider。整个程序维护一个静态mapping,他是scope->provider的映射。provider中维护着自己域下的实例的生命周期,包括:调用者的引用,单例,子域和普通对象的创建。

如果父类携带了域,那么子类直接继承了父类域中的元素。如果采用多态,你需要显式的声明implement和interface的关系。

  • Proxy和Custom Annotation

在开发中会遇到这样一种情况,某些类需要在声明后执行特定操作。PopStar希望提供几个方式解决。一种就是直接继承生命周期接口,在对应函数中执行操作。或者声明一个Proxy。Proxy会在编译时扫描module中的对应类和他的子类的provide方法,调用Invoked函数。

@PSProxy(IPresenter.class)
public class PresenterProxy {
    @Invoked(injector = Activity.class)
    public static void proxy(IPresenter presenter, Activity activity) {
        presenter.attach(activity);
    }
}

custom annotation提供一种初始化的方式,例如retrofit的动态代理。我可以这么声明:

@Provide(typeAnnotations = {Api.class})
public static <T> T provideApi(InjectedField field) {
    return retrofit.create(field.getType());
}

结语

PopStar解决了动态性的问题,并且使用起来非常简单,只需要简单声明。

@Inject
protected Provider<TestInterface> testInterface;
@Inject 
protected Application application;
@Inject 
protected A a;

声明

此篇文章是16年12月在红星内部发表的,发到这里给大家提供下思路。

Basic Knowledge:

stackoverflow what is di
Dagger2
Tasting Dagger2 on Android

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,711评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,079评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,194评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,089评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,197评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,306评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,338评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,119评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,541评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,846评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,014评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,694评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,322评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,026评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,257评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,863评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,895评论 2 351