Android单排上王者系列之Dagger2注入原理解析

本篇文章已授权微信公众号 guolin_blog （郭霖）独家发布

MVP模式讲解

在MVP中使用Dagger2

Dagger2的注入原理解析

在上篇博客中我们介绍了Dagger2该如何在项目中使用，这篇博客将继续分析Dagger2实现的原理，代码依然采用上篇的代码，看这里。

Dagger2的注入原理

原理的讲解我们通过小明来带我们学习。

小明在看了MVP的实战解析和Dagger2的使用后知道了Dagger2该如何在MVP模式中使用，但是小明是一个要求上进的好同学，小明并不满足于如何使用，小明想钻研钻研源码，看看如何实现的。

小明在钻研Dagger2的时候突然意识到Dagger2是采用注解的形式完成任务的，使用注解其实是不明智的选择，会大大消耗性能，影响应用的运行速度。小明看到这里有点疑惑了，既然注解这么影响性能，那为什么Dagger2还要使用注解呢？为什么Dagger2还这么被广泛的使用呢？

于是小明到github上查看Dagger2的介绍

官方介绍是

A fast dependency injector for Android and Java.

Dagger2是一个Android和Java中的快速注射器。

小明又疑惑了注解反射怎么是快速的呢？

小明没有灰心又继续查看代码，终于发现Dagger2是和其他依赖注入框架是有区别的，Dagger2是通过apt插件在编译阶段生成注入代码的，也就是说反射只是在编译阶段使用了，而在应用运行的时候其实运行的是真正的Java代码并没有涉及到注解反射，小明终于明白了，难怪Dagger2是快速注入框架。

小明有了这个重大发现后决定一鼓作气把Dagger2生成的代码给理清楚。

编译阶段生成代码

小明通过在Android studio中通过执行Build->Rebuild Project，在app/build/generated/source/apt目录下发现生成了

LoginPresenterComp_Factory类

代码如下

public final class LoginPresenterCompl_Factory implements Factory<LoginPresenterCompl> {
    private final Provider<ILoginView> viewProvider;

    public LoginPresenterCompl_Factory(Provider<ILoginView> viewProvider) {
        assert viewProvider != null;
        this.viewProvider = viewProvider;
    }

    @Override
    public LoginPresenterCompl get() {
        return new LoginPresenterCompl(viewProvider.get());
    }

    public static Factory<LoginPresenterCompl> create(Provider<ILoginView> viewProvider) {
        return new LoginPresenterCompl_Factory(viewProvider);
    }
}

为了对比小明又把LoginPresenterCompl的代码也找了出来

代码如下

public class LoginPresenterCompl implements ILoginPresenter {
    @Inject
    public LoginPresenterCompl(ILoginView view){
        loginView = view ;
        user = new User("张三","123456") ;
    }
    ......
}

仔细看看LoginPresenterCompl_Factory这个类，发现其中有三个方法

  • 构造方法

构造方法中的参数viewProvider一个Provider类型的，而Provider的泛型参数是ILoginView，这个参数就是我们实例化LoginPresenterCompl需要的参数，在上篇中我们知道了该参数是一个依赖，是由MainModule提供的。

  • get()方法

在该方法中初始化了我们正在需要的LoginPresenterCompl对象

  • create()方法

在该方法中实例化了LoginPresenterCompl_Factory本类对象

小明想既然上面的viewProvider是由MainModule提供的，那么就来看看MainModule对应的注入类吧

MainModule_ProvideILogViewFactory

代码如下

public final class MainModule_ProvideILogViewFactory implements Factory<ILoginView> {
  private final MainModule module;

  public MainModule_ProvideILogViewFactory(MainModule module) {
    assert module != null;
    this.module = module;
  }

  @Override
  public ILoginView get() {
    return Preconditions.checkNotNull(
        module.provideILogView(), "Cannot return null from a [email protected] @Provides method");
  }

  public static Factory<ILoginView> create(MainModule module) {
    return new MainModule_ProvideILogViewFactory(module);
  }
}

对应的MainModule代码如下

@Module
public class MainModule {
    private final ILoginView view ;
    public MainModule(ILoginView view){
        this.view = view ;
    }
    @Provides
    ILoginView provideILogView(){
        return view ;
    }
}

从结构中不难看出被@Provider注解修饰的方法会对应的生成Factory类，这个类中最主要的方法是get()方法，在该方法中调用了MainModule的provideILogView方法，而该方法是为了我们提供LoginPresenterCompl实例化参数的，LoginPresenterCompl的实例化是在LoginPresenterCompl_Factory的get()方法中完成的。

实例化代码如下

@Override
public LoginPresenterCompl get() {
    return new LoginPresenterCompl(viewProvider.get());
}

在代码中可以看出实例化过程中参数是由viewProvider.get()提供的。咦！！！！

在MainModule_ProvideILogViewFactory中的get()方法其实返回了我们实例化的参数。

那么这个viewProvider是不是我们的MainModule_ProvideILogViewFactory呢？

viewProvider是一个Provider类型，而MainModule_ProvideILogViewFactory实现了Factory接口，那Provider和Factory有没有联系呢？

看这段代码

public interface Factory<T> extends Provider<T> {
}

发现Factory接口继承了Provider接口，所以其实viewProvider就是MainModule_ProvideILogViewFactory类型。

看到这里小明终于明白了LoginPresenterCompl_Factory类和MainModule_ProvideILoginViewFactory类的关系了，也明白了实例化过程了。

但是这些类的初始化和相关方法是如何被调用的，在哪里被调用的呢？

还有两个重要的类小明没有看到。MainComponent和对应的DaggerMainComponent。

代码如下

MainComponent代码

@Component(modules = MainModule.class)
public interface MainComponent {
    public void inject(LoginActivity activity) ;
}

DaggerMainComponent代码

public final class DaggerMainComponent implements MainComponent {
  private Provider<ILoginView> provideILogViewProvider;

  private Provider<LoginPresenterCompl> loginPresenterComplProvider;

  private MembersInjector<LoginActivity> loginActivityMembersInjector;

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

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

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

    this.provideILogViewProvider = MainModule_ProvideILogViewFactory.create(builder.mainModule);

    this.loginPresenterComplProvider = LoginPresenterCompl_Factory.create(provideILogViewProvider);

    this.loginActivityMembersInjector =
        LoginActivity_MembersInjector.create(loginPresenterComplProvider);
  }

  @Override
  public void inject(LoginActivity activity) {
    loginActivityMembersInjector.injectMembers(activity);
  }

  public static final class Builder {
    private MainModule mainModule;

    private Builder() {}

    public MainComponent build() {
      if (mainModule == null) {
        throw new IllegalStateException(MainModule.class.getCanonicalName() + " must be set");
      }
      return new DaggerMainComponent(this);
    }

    public Builder mainModule(MainModule mainModule) {
      this.mainModule = Preconditions.checkNotNull(mainModule);
      return this;
    }
  }
}

通过上面代码可以看出DaggerMainComponent实现了MainComponent接口并实现了其中的inject()方法。同时也提供了其他的辅助方法。

小明决定从方法调用顺序开始入手查看

DaggerMainComponent.builder().mainModule(new MainModule(this)).build().inject(this);

注入过程

还记得在LoginActivity中添加的这个方法吗，分析DaggerMainComponent就从这段代码入手。

  • 1、DaggerMainComponent调用了builder方法

小明找到builder()方法看看这个方法到底做了什么事

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

发现这个方法创建并返回了Builder对象

Builder是什么东东呢？仔细看代码Build是DaggerMainCompone的内部类。

  • 2、DaggerMainComponent.builder().mainModule(new MainModule(this))

紧接着又调用了mainModule并将MainModule的对象传了进来。

mainModule()方法是Builder中的一个方法，代码如下

public Builder mainModule(MainModule mainModule) {
    this.mainModule = Preconditions.checkNotNull(mainModule);
    return this;
}

其中做了什么事呢？就是将传进来的MainModule对象赋值给本类的mainModule对象，并返回本类对象

  • 3、DaggerMainComponent.builder().mainModule(new MainModule(this)).build()

紧接着又调用了Builder的build()方法

public MainComponent build() {
    if (mainModule == null) {
        throw new IllegalStateException(MainModule.class.getCanonicalName() + " must be set");
    }
    return new DaggerMainComponent(this);
}

该方法通过new DaggerMainComponent(this)创建了DaggerMainComponent对象并将其返回。

那么new DaggerMainComponent(this)做了什么事呢？

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

其中调用了initialize方法并将builder对象传入。

initialize()方法如下

private void initialize(final Builder builder) {
    this.provideILogViewProvider = MainModule_ProvideILogViewFactory.create(builder.mainModule);
    this.loginPresenterComplProvider = LoginPresenterCompl_Factory.create(provideILogViewProvider);
    this.loginActivityMembersInjector = LoginActivity_MembersInjector.create(loginPresenterComplProvider);
}

在initialize方法中小明终于看到了MainModule_ProvideILogViewFactory和LoginPresenterCompl_Factory的create方法被调用了。

首先通过传入的MainModule对象创建MainModule_ProvideILogViewFactory对象

provideILogViewProvider，然后将provideILogViewProvider对象作为参数来创建

LoginPresenterCompl_Factory对象。

前面已经讲过，MainModule_ProvideILogViewFactory是一个Factory对象，

而LoginPresenterCompl_Factory创建对象需要一个Provider对象，同时Factory继承了Provider，所以可以将其传入。

所以LoginPresenterComp_Factory的viewProvider对象

是一个MainModule_ProvideILogViewFactory对象，

这个概念前面也讲过，这里得到认证。

在这段代码中小明发现了LoginActivity_MembersInjector类，于是小明又将这个类找了出来

代码如下

public final class LoginActivity_MembersInjector implements MembersInjector<LoginActivity> {
  private final Provider<LoginPresenterCompl> loginPresenterProvider;

  public LoginActivity_MembersInjector(Provider<LoginPresenterCompl> loginPresenterProvider) {
    assert loginPresenterProvider != null;
    this.loginPresenterProvider = loginPresenterProvider;
  }

  public static MembersInjector<LoginActivity> create(
      Provider<LoginPresenterCompl> loginPresenterProvider) {
    return new LoginActivity_MembersInjector(loginPresenterProvider);
  }

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

  public static void injectLoginPresenter(
      LoginActivity instance, Provider<LoginPresenterCompl> loginPresenterProvider) {
    instance.loginPresenter = loginPresenterProvider.get();
  }
}

该类的cereate()方法需要一个Provider泛型是LoginPresenterCompl类型的参数，通过构造函数将其传入赋值给loginPresenterProvider变量。就这么简单。

  • 4、DaggerMainComponent.builder().mainModule(new MainModule(this)).build().inject(this)

最后调用了inject()方法

@Override
public void inject(LoginActivity activity) {
    loginActivityMembersInjector.injectMembers(activity);
}

在该方法中调用了LoginActivityMembersInjector中的injectMembers()方法。

injectMembers()方法内容如下

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

终于！！！！！！！在这个方法中实现了对LoginPresenterCompl对象的初始化。

至此，小明终于能清楚了Dagger2的注入原理了，小明表示清楚原理后妈妈再也不用担心Dagger2写错了。

如果没有正确的分析这个生成的注入类可能很难理解Dagger2实现注入的框架，可能看原理代码让有些同学不知所措，相信我，多分析几遍就OK了。

其实也不用纠结到底该如何使用Dagger2，只要我们理解了其实现的原理，具体如何使用看个人，能够做到灵活使用就OK了。

至此Dagger2的原理分析就完成了。

总结

回顾一下该系列的文章

MVP模式讲解

在MVP中使用Dagger2

Dagger2的注入原理解析

因为这三篇是连续的，代码都是在前一篇的基础上做的扩展，所以最好将三篇博客通读。

希望这三篇文章能够帮到需要的同学，共同进步！！！

最后全部代码点击这里

时间： 2024-10-07 04:11:55

Android单排上王者系列之Dagger2注入原理解析的相关文章

Android中的Apk的加固(加壳)原理解析和实现

Android中的Apk的加固(加壳)原理解析和实现 标签: android 2015-09-13 13:58 42287人阅读 评论(49) 收藏 举报 本文章已收录于:  Android知识库  分类: Android(140)  版权声明:本文为博主原创文章,未经博主允许不得转载. 目录(?)[+] 一.前言 今天又到周末了,憋了好久又要出博客了,今天来介绍一下Android中的如何对Apk进行加固的原理.现阶段.我们知道Android中的反编译工作越来越让人操作熟练,我们辛苦的开发出一个

Android应用市场省流量更新(增量升级)原理解析

一.前言 最近在看热修复相关的框架,之前我们已经看过了阿里的Dexposed和AndFix这两个框架了,不了解的同学可以点击这里进行查看:Dexposed框架原理解析 和 AndFix热修复框架原理解析,然后还有最近很火的一个是腾讯的Tinker热修复框架,再看他的原理实现的时候,发现了他使用到了开源的文件差分工具bsdiff/bspatch,所以就单独用这篇文章来详细介绍一下这个工具,因为这个工具有一个很大的用途就是增量更新,也就是我们看到现在大部分的应用市场推出的省流量更新应用的效果: 看到

Android中插件开发篇之----应用换肤原理解析

一.前言 今天又到周末了,感觉时间过的很快呀.又要写blog了.那么今天就来看看应用的换肤原理解析.在之前的一篇博客中我说道了Android中的插件开发篇的基础:类加载器的相关知识.没看过的同学可以转战: http://blog.csdn.net/jiangwei0910410003/article/details/41384667 二.原理介绍 现在市场上有很多应用都有换肤的功能,就是能够提供给用户一些皮肤包,然后下载,替换.而且有些皮肤是要收费的.对于这个功能的话,其实没有什么技术难度的,但

Android中的Apk的加固(加壳)原理解析和实现（转）

一.前言 今天又到周末了,憋了好久又要出博客了,今天来介绍一下Android中的如何对Apk进行加固的原理.现阶段.我们知道Android中的反编译工作越来越让人操作熟练,我们辛苦的开发出一个apk,结果被人反编译了,那心情真心不舒服.虽然我们混淆,做到native层,但是这都是治标不治本.反编译的技术在更新,那么保护Apk的技术就不能停止.现在网上有很多Apk加固的第三方平台,最有名的应当属于:爱加密和梆梆加固了.其实加固有些人认为很高深的技术,其实不然,说的简单点就是对源Apk进行加密,然后

【Hadoop系列】linux SSH原理解析

本文中斜体加粗代表shell指令,操作环境 CentOS6.5 linux root免密码登录链接:[Hadoop系列]linux下 root用户免密码登录远程主机 ssh. linux 非root用户免密码登录:XXXXXXX(暂未写好) Linux下,使用ssh协议登录远程计算机.让我们先来了解下什么是SSH. 一.什么是SSH? 简单说,SSH是一种网络协议,用于计算机之间的加密登录.如果一个用户从本地计算机,使用SSH协议登录另一台远程计算机,我们就可以认为,这种登录是安全的,即使被中途

Android安全之旅系列博客导读

总结下近一年的学习经历,以中国的新年为节点.时间从2015年年后到今天,2015年年末. 首先我必须要感谢前辈的书籍和高质量的博客. 1.重新学习了一遍<Linux内核源代码情景分析上下册>,毛德操著,并记录学习历程,写下了博客. 2.重新学习了一遍<Android系统源代码情景分析>,罗升阳著,并记录从开机启动到Home界面的展示整个流程. 3.学习了一个小型java虚拟机的源代码,并调试修改源代码中的错误,最后可以运行了.参考链接https://github.com/cloud

爱加密Android APk 原理解析

爱加密Android APK加壳原理解析 一.什么是加壳? 加壳是在二进制的程序中植入一段代码,在运行的时候优先取得程序的控制权,做一些额外的工作.大多数病毒就是基于此原理.PC EXE文件加壳的过程如下: 二.加壳作用 加壳的程序可以有效阻止对程序的反汇编分析,以达到它不可告人的目的.这种技术也常用来保护软件版权,防止被软件破解. 三.Android Dex文件加壳原理 PC平台现在已存在大量的标准的加壳和解壳工具,但是Android作为新兴平台还未出现APK加壳工具.Android Dex文

android图片压缩上传系列－service篇

本篇文章是继续上篇android图片压缩上传系列-基础篇文章的续篇.主要目的是:通过Service来执行图片压缩任务来讨论如何使用Service,如何处理任务量大的并发问题. 了解下Service 大家都知道如果有费时任务,这时需要将任务放到后台线程中执行,如果对操作的结果需要通过ui展示还需要在任务完成后通知前台更新.当然对于这种情况,大家也可以在Activity中启动线程,在线程中通过Handler和sendMessage来通知Activity并执行更新ui的操作,但是更好的方法是将这些操作

android和struts2实现android文件上传

1.开发准备如下2个工具类 package org.lxh.util; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStream; import java.net.InetAddress; import java.net.Socket; import java.net.URL; import java.util.Map; /** * 上传文件到服务器 * * @auth