[Android 学习笔记] Dagger2 依赖注入由浅入深 (1)

1. 在 gradle 中添加依赖

在主项目的 build.gradle 中添加 Dagger2 库的依赖

dependencies {
    compile 'com.google.dagger:dagger:2.16'
    annotationProcessor 'com.google.dagger:dagger-compiler:2.16'
}

2. Dagger2 最简单用法, 手工赋值

Demo 中只有两个简单的类 SimpleActivity 和 UserServer, SimpleActivity 有个 UserServer 类型的 server 变量, 通过添加 @Inject 注解为其赋值:

public class SimpleActivity extends AppCompatActivity {

    @Inject
    UserServer server;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}
public class UserServer {

    @Inject
    public UserServer() {
    }
}

Android Studio 编译后 Dagger2 库在 DaggerTest/app/build/generated/source/apt/debug 路径下生成了两个辅助类

import dagger.MembersInjector;
import javax.inject.Provider;

public final class SimpleActivity_MembersInjector implements MembersInjector<SimpleActivity> {
  private final Provider<UserServer> serverProvider;

  public SimpleActivity_MembersInjector(Provider<UserServer> serverProvider) {
    this.serverProvider = serverProvider;
  }

  public static MembersInjector<SimpleActivity> create(Provider<UserServer> serverProvider) {
    return new SimpleActivity_MembersInjector(serverProvider);
  }

  @Override
  public void injectMembers(SimpleActivity instance) {
    injectServer(instance, serverProvider.get());
  }

  public static void injectServer(SimpleActivity instance, UserServer server) {
    instance.server = server;
  }
}

import dagger.internal.Factory;

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

  @Override
  public UserServer get() {
    return provideInstance();
  }

  public static UserServer provideInstance() {
    return new UserServer();
  }

  public static UserServer_Factory create() {
    return INSTANCE;
  }

  public static UserServer newUserServer() {
    return new UserServer();
  }
}

SimpleActivity_MembersInjector 类中的 injectMembers 方法实现了为 server 变量赋值. UserServer_Factory 类正如其名, 是 UserServer 的一个工厂类, 它实现了 Factory 接口, 查看源码发现 Factory 接口是一个空接口, 它继承了 Provider 接口:

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

public interface Provider<T> {
    T get();
}

然后在 SimpleActivity 类中就可以调用自动生成的两个类去给 UserServer 变量赋值:


public class SimpleActivity extends AppCompatActivity {

    @Inject
    UserServer server;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Provider<UserServer> serverProvider = UserServer_Factory.create();
        SimpleActivity_MembersInjector.create(serverProvider).injectMembers(this);
    }
}

由于写的 UserServer 类很简单, 只有一个无参的构造方法, 所以自动生成的 UserServer_Factory 类也很简单, 给 UserServer 类赋值也很简单.
下面还有更简单的方法.

3. 引入 @Component 注解

我们再定义一个接口, 接口实现很简单, 重点是在类定义上的@Component注解

import dagger.Component;

@Component
public interface SimpleActivityComponent {
    void inject(SimpleActivity activity);
}

编译后依然在 DaggerTest/app/build/generated/source/apt/debug 目录下会再生成一个辅助类:

public final class DaggerSimpleActivityComponent implements SimpleActivityComponent {
  private DaggerSimpleActivityComponent(Builder builder) {}

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

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

  @Override
  public void inject(SimpleActivity activity) {
    injectSimpleActivity(activity);
  }

  private SimpleActivity injectSimpleActivity(SimpleActivity instance) {
    SimpleActivity_MembersInjector.injectServer(instance, new UserServer());
    return instance;
  }

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

    public SimpleActivityComponent build() {
      return new DaggerSimpleActivityComponent(this);
    }
  }
}

DaggerSimpleActivityComponent 的 injectSimpleActivity 方法调用了 SimpleActivity_MembersInjector 类的 injectServer 方法, 直接 new 了一个 UserServer 对象, 没有用到前面提到的 UserServer_Factory 类.

这时在 SimpleActivity 类中再给 UserServer 变量赋值就可以改成如下:

public class SimpleActivity extends AppCompatActivity {

    @Inject
    UserServer server;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 手工注入
        Provider<UserServer> serverProvider = UserServer_Factory.create();
        SimpleActivity_MembersInjector.create(serverProvider).injectMembers(this);

        // 通过 @Component 注解生成 DaggerSimpleActivityComponent 类来注入
        DaggerSimpleActivityComponent.create().inject(this);
    }
}

如果 SimpleActivity 中有多个变量需要注入, 通过这种方法也只需要一行, 不用和各个需要注入的类打交道.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 什么的依赖注入 在软件工程中,依赖注入是实现控制反转的方式之一。百度百科中对于控制反转的解释如下:控制反转(Inv...
    小甜李子阅读 1,707评论 5 3
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,786评论 18 399
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,080评论 19 139
  • 简介 Redis Cluster 是 在 3.0 版本正式推出的高可用集群方案,相比Redis Sentinel,...
    晚歌歌阅读 308评论 0 0
  • 为什么题目叫做坚持?因为我干什么都是三天打鱼两天晒网。某一天受了触动,可能就会心血来潮写点什么,不过这种热度持续不...
    筱竹华倩阅读 200评论 0 2