寻找Dagger辅助注射的例子

时间:2014-04-02 00:28:23

标签: java dependency-injection dagger assisted-inject

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

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

我一定错过了一些东西 - 注入新课很容易,但添加新模块非常繁琐。

我的问题是:如何在实践中完成辅助注射?谁有一个例子?如果有的话,我应该如何使用ImageModule

* - &#34;不知何故&#34;这确实意味着它对我来说有点神奇。

3 个答案:

答案 0 :(得分:17)

因此,Google的一些Dagger / Guice人员在项目中创建了一个名为AutoFactory(http://github.com/google/auto)的项目,其中包括AutoFactory(代码生成的辅助注入),AutoValue(代码生成的自定义值类型)和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方法提供。

您甚至可以让工厂实现工厂界面,然后简单地将两者绑定在一个匕首模块中,如下所示:

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

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

答案 1 :(得分:0)

您可以使用square/AssistedInject

使用Dagger进行辅助注射

也请在此处检查我的原始答案:https://stackoverflow.com/a/53719342/2862474

答案 2 :(得分:0)

正如@xsveda所说,对于辅助注射,您可能要使用AssistedInject。我在this blogpost中写过它,但是我将在此处添加一个完整的示例以使事情变得更容易。

您需要的第一件事是依赖项:

compileOnly 'com.squareup.inject:assisted-inject-annotations-dagger2:0.4.0'
kapt 'com.squareup.inject:assisted-inject-processor-dagger2:0.4.0'

这就是您的示例的样子:

class ImageDownloader @AssistedInject constructor(
  private val httpClient: HttpClient,
  private val executorService: ExecutorService,
  @Assisted private val imageUrl: URL,
  @Assisted private val callback: ImageCallback
) {

  @AssistedInject.Factory
  interface Factory {
    fun create(imageUrl: URL, callback: ImageCallback): ImageDownloader
  }
}

第一件事是,我们不使用@Inject来注释构造函数,而是使用@AssistedInject对其进行注释。然后,我们注释必须通过工厂的参数,这与AutoFactory期望的相反。最后,我们需要一个带有@AssistedInject.Factory注释的内部工厂接口,该接口具有一个接收辅助参数并返回我们感兴趣的实例的单一方法。

很遗憾,我们在这里还有一个额外的步骤:

@AssistedModule
@Module(includes = [AssistedInject_AssistedInjectModule::class])
interface AssistedInjectModule

即使这是一个有效的选择,我们也不一定需要专用的模块。但是我们也可以在组件中已安装的另一个模块中具有这些注释。这里的好处是我们只需要执行一次,然后任何工厂都将自动成为图形的一部分。

这样,您就可以像通常那样注入工厂并索要您的物品了。