Dagger2 分析【1】

说明

本次示例是基于:

compile 'com.google.dagger:dagger:2.11'
annotationProcessor 'com.google.dagger:dagger-compiler:2.11'

该章节主要分析基本的注入代码

注入代码

这里我们先从最基础的注入方式开始:
Inject:

public class Engine {
    @Inject
    public Engine() {}
}

public class Car {
  @Inject
  public Car(Engine engine) {}
}

Component:

@Component
public interface ManComponent {
    void injectMan(ManActivity manActivity);  // 注入 man 所需要的依赖
}
public class ManActivity extends AppCompatActivity {

    @Inject
    Car mCar;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_man);
        DaggerManComponent.create().inject(this);
        Log.d("Car", mCar.toString());

        DaggerManComponent.builder().build().inject(this);
        Log.d("Car", mCar.toString());
    }
}

这里我们先运行起来,看看打印出来的日志:

07-08 11:00:32.461 9953-9953/com.whyalwaysmea.dagger2 D/Car: com.whyalwaysmea.dagger2.bean.Car@850a3f9
07-08 11:00:32.461 9953-9953/com.whyalwaysmea.dagger2 D/Car: com.whyalwaysmea.dagger2.bean.Car@27e1df3e

可以发现,Car的地址变了,说明两次注入是生成的不同的对象。

生成代码分析

我们这里先从DaggerManComponent开始看, DaggerManComponent是直接apt生成的代码:

public final class DaggerManComponent implements ManComponent {
  private Provider<Car> carProvider;

  private MembersInjector<ManActivity> manActivityMembersInjector;

  private DaggerManComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  public static ManComponent create() {
    return new Builder().build();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {

    this.carProvider = Car_Factory.create(Engine_Factory.create());

    this.manActivityMembersInjector = ManActivity_MembersInjector.create(carProvider);
  }

  @Override
  public void inject(ManActivity mainActivity) {
    manActivityMembersInjector.injectMembers(mainActivity);
  }

  public static final class Builder {
    private Builder() {}

    public ManComponent build() {
      return new DaggerManComponent(this);
    }
  }
}

可以看到,这里是有一个Builder类,我们在注入的时候,调用DaggerManComponent.create();DaggerManComponent.builder().build();其实是等价的。
都是调用了ManComponent的构造函数,返回了一个ManComponent,同时也调用了initialize(),initialize就是得到了一个MembersInjector<ManActivity>对象,injectMan其实也是调用的MembersInjector<ManActivity>.injectMembers()
所以我们这里先看看initialize:

private void initialize(final Builder builder) {
  this.carProvider = Car_Factory.create(Engine_Factory.create());

  this.manActivityMembersInjector = ManActivity_MembersInjector.create(carProvider);
}

这里又涉及到了,其他三个由apt生成的java类,分别是ManActivity_MembersInjectorCar_FactoryEngine_Factory

public final class Engine_Factory implements Factory<Engine> {
  private static final Engine_Factory INSTANCE = new Engine_Factory();

  @Override
  public Engine get() {
    return new Engine();
  }

  public static Factory<Engine> create() {
    return INSTANCE;
  }
}

public final class Car_Factory implements Factory<Car> {
  private final Provider<Engine> engineProvider;

  public Car_Factory(Provider<Engine> engineProvider) {
    assert engineProvider != null;
    this.engineProvider = engineProvider;
  }

  @Override
  public Car get() {
    return new Car(engineProvider.get());
  }

  public static Factory<Car> create(Provider<Engine> engineProvider) {
    return new Car_Factory(engineProvider);
  }
}

首先可以看到Factory<T>继承了Provider<T>接口,里面有一个get方法。
其次,这里的Car_Factory.create()其实就是直接new了一个Car_Factory对象出来。get就是new一个Car对象。

@Generated(
  value = "dagger.internal.codegen.ComponentProcessor",
  comments = "https://google.github.io/dagger"
)
public final class ManActivity_MembersInjector implements MembersInjector<ManActivity> {
  private final Provider<Car> mCarProvider;

  public ManActivity_MembersInjector(Provider<Car> mCarProvider) {
    assert mCarProvider != null;
    this.mCarProvider = mCarProvider;
  }

  public static MembersInjector<ManActivity> create(Provider<Car> mCarProvider) {
    return new ManActivity_MembersInjector(mCarProvider);
  }

  @Override
  public void injectMembers(ManActivity instance) {
    if (instance == null) {
      throw new NullPointerException("Cannot inject members into a null reference");
    }
    instance.mCar = mCarProvider.get();
  }

  public static void injectMCar(ManActivity instance, Provider<Car> mCarProvider) {
    instance.mCar = mCarProvider.get();
  }
}

首先这里是实现了一个MembersInjector<T>接口, 里面有一个injectMembers()方法,这个方法主要就是返回实例对象的。
从这里可以得知,我们注入的时候,是不能用private来修饰注入对象的,因为那样的话在生成的代码中是无法获取到对象的。

小结

通过分析生成的代码,我们知道了三个接口Factory<T>MembersInjector<T>Factory<T>又是继承于Provider<T>

Factory<T>可以理解成是生产实例对象的地方:
构造方法由@Inject修饰过的类XX,会生成一个实现了Factory的类XX_Factory,该类中主要是通过get()方法来获取对象。

MembersInjector<T>可以理解成是需要注入对象的成员:
在示例中,是ManActivity需要Car,所以这里是生成了ManActivity_MembersInjector implements MembersInjector<ManActivity>
该类中主要是通过injectMembers(ManActivity instance)方法,将Provider<T>.get()获取到的对象赋值给了ManActivity.T

最后再来小结一下DaggerXXXComponent,该类是直接实现了XXXComponent接口的。
Component一直被认为是Dagger2中依赖注入的桥梁。这里由于没有涉及到Module,所以Component也没有起到很大的作用。
所以也就有了第三种注入的方式:

ManActivity_MembersInjector.create(Car_Factory.create()).injectMembers(this);

这一节只用来了最简单的方式来注入,所以生成的代码也是很好理解的。
打算一步一步的深入分析,同时也加深对于Dagger2的理解。
如果有错误的地方还请大家提出,共同讨论。

Dagger2分析 【2】

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

推荐阅读更多精彩内容