java - 寻找 Dagger 辅助注入(inject)的示例

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);
    }
  }
  ...
}

现在，我没有在客户端的构造函数中注入(inject) ImageDownloader，而是简单地注入(inject) ImageDownloader.Factory 并调用它的 create() 方法。

如您所见，这非常冗长。它还有一堆重复和样板。使用 @Inject 注释字段本身存在一些障碍，所以我们暂时忽略这种可能性。

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

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@)。

我的 ImageDownloader 是一个由一个类注入(inject)的类，该类由另一个类注入(inject)，另一个类又由另一个类注入(inject)，...，在 @Module 。这一切都以某种方式*有效，并且所有类都在构建时找到。现在，要添加一个模块，我必须明确地让对象图知道它。

我一定遗漏了一些东西 - 注入(inject)一个新类非常容易，但添加一个新模块却非常乏味。

我的问题是:在实践中如何进行辅助注入(inject)？有人有例子吗？如果需要，我应该如何使用 ImageModule？

* - “不知何故”确实暗示它对我来说有一定的魔力。

Answer 1

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

AutoFactory 的运行方式几乎与您预期的一样 - 它会生成您需要手动操作的工厂。这是一个非常早期的版本，我们计划有更多的灵 active ，但它会生成一个工厂类，该工厂类将采用包含一些 JSR-330 可注入(inject)依赖项和一些调用堆栈参数的类型，并将它们合并在一起以创建实例注释类型。

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

例如，如果您创建自己的类:

@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 标准的可注入(inject)类，您可以将其注入(inject)到依赖关系图中(在 Dagger 或 Guice 中)，它会为您创建这些对象，将调用堆栈状态与适本地提供依赖项。

您可以注入(inject)上述 Just-In-Time，或者您可以在空闲时通过 @Provides 方法提供它。

你甚至可以让工厂实现一个工厂接口(interface)，然后像这样简单地将两者绑定(bind)到一个 dagger 模块中:

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

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