寻找Dagger辅助注射的例子

Question

来自dagger-discuss @：

我有一个类，它从对象图中获取一些依赖关系，而在运行时从调用者那里获取其他依赖关系。

public class ImageDownloader {
  // Get these dependencies from the injector.
  private final HttpClient httpClient;
  private final ExecutorService executorService;

  // Get these from the caller.
  private final URL imageUrl;
  private final ImageCallback callback;

  ...
}

我想出了一个解决方案，定义了一个工厂，

public class ImageDownloader {
  ...
  public static class Factory {
    private final HttpClient httpClient;
    private final ExecutorService executorService;

    @Inject
    public Factory(HttpClient httpClient, ExecutorService executorService) {
      this.httpclient = httpClient;
      this.executorService = executorService;
    }

    public ImageDownloader create(URL imageUrl, ImageCallback callback) {
      return new ImageDownloader(httpClient, executorService, iamgeUrl, callback);
    }
  }
  ...
}

现在，我不再注入ImageDownloader客户端的构造函数，而是直接注入ImageDownloader.Factory并调用其create()方法。

如您所见，这很冗长且冗长。它还有很多重复和样板。使用来注释字段本身存在一些障碍@Inject，因此让我们暂时忽略这种可能性。

Square人员使用提供程序提出了一个有趣的解决方案。定义一个Factory接口，

public class ImageDownloader {
  ...
  public interface Factory {
    ImageDownloader create(URL imageUrl, ImageCallback callback);
  }
}

然后在模块中提供

public class ImageModule {
  ...
  @Provides 
  public ImageModule.Factory provideImageModuleFactory(
      final Provider<HttpClient> httpClientProvider, 
      final Provider<ExecutorService> executorServiceProvider) {
    return new ImageDownloader.Factory() {
      public ImageDownloader create(URL imageUrl, ImageCallback callback) {
        return new ImageDownloader(httpClientProvider.get(), executorServiceProvider.get(),
            imageUrl, callback);
      }
  }
  ...
}

（再次，来自dagger-discuss @）。

My
ImageDownloader是一个由一个类注入的类，该类又由另一个类注入，而另一个类又由…引用，而另一个类在…中引用@Module。所有这些都以某种方式起作用*，并且所有类都在构建时找到。现在，要添加模块，我必须明确地让对象图知道它。

我必须缺少一些东西-注入新类很容易，但是添加新模块却很乏味。

我的问题是：实践中如何进行辅助注射？有人举个例子吗？我应该怎么用ImageModule？

*-“不知何故”确实暗示着对我来说部分是魔术。

Answer 1

因此，Google的Dagger /
Guice员工在一个包含AutoFactory（代码生成的辅助注入），AutoValue（代码生成的自定义值）的项目中创建了一个名为AutoFactory（http://github.com/google/auto）的东西。类型）和AutoService（自动生成Java服务元数据文件）。

AutoFactory几乎可以按您期望的方式运行-
它会生成您本应手动滚动的工厂。这是一个非常早期的版本，我们还计划了更多的灵活性，但是它将生成一个工厂类，该类将采用包含一些JSR-330可注入依赖项和一些调用堆栈参数的类型，并将它们合并在一起以创建以下对象的实例带注释的类型。

本质上，如果正确注释了工厂创建的类型，它将自动生成您编写的工厂。

例如，如果您创建班级：

@AutoFactory
public class ImageDownloader {
  // Get these dependencies from the injector.
  private final HttpClient httpClient;
  private final ExecutorService executorService;

  // Get these from the caller.
  private final URL imageUrl;
  private final ImageCallback callback;

  ImageDownloader(
      @Provided HttpClient httpClient,
      @Provided ExecutorService executorService,
      ImageCallback callback,
      URL imageUrl) {
    // assignments
  }
}

AutoFactory将生成：

@Generated("com.google.auto.factory.processor.AutoFactoryProcessor")
public final class ImageDownloaderFactory {
  private final Provider<ExampleClasses.HttpClient> httpClientProvider;
  private final Provider<java.util.concurrent.ExecutorService> executorServiceProvider;

  @Inject
  public ImageDownloaderFactory(
      Provider<ExampleClasses.HttpClient> httpClientProvider,
      Provider<java.util.concurrent.ExecutorService> executorServiceProvider) {
    this.httpClientProvider = httpClientProvider;
    this.executorServiceProvider = executorServiceProvider;
  }

  public ImageDownloader create(ImageCallback callback, URL imageUrl) {
    return new ImageDownloader(
        httpClientProvider.get(), 
        executorServiceProvider.get(), 
        callback, 
        imageUrl);
  }
}

（请注意，我们需要对输出源进行大量清理，但是上面的内容基本上是生成的内容，尽管格式不尽人意。）

然后，生成的类正确地是符合JSR-330的可注入类，您可以将其注入到依赖关系图中（在Dagger或Guice中），它将为您创建这些对象，将调用堆栈状态与提供的依赖项混合在一起适当地。

您可以注入上述“即时”，也可以@Provides在闲暇时通过某种方法提供。

您甚至可以让工厂实现工厂接口，然后将它们简单地在dagger模块中绑定在一起，如下所示：

@AutoFactory(implementing = MyFactoryInterface.class)
public class ImageDownloader {
  // ... otherwise as above...
}

@Module(...)
class MyModule {
  @Provides MyFactoryInterface factoryImpl(ImageDownloaderFactory impl) {
    return impl;
  }
}