寻找匕首辅助注射的例子

java dependency-injection dagger assisted-inject

2022-09-01 19:18:39

我有一个类，它从对象图中获取一些依赖项，并在运行时从调用方获取其他依赖项。

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

现在，我不是在客户端的构造函数中注入，而是简单地注入并调用其方法。ImageDownloaderImageDownloader.Factorycreate()

如您所见，这是非常冗长和漫长的。它还有一堆重复和样板。使用注释字段本身存在一些障碍，因此让我们暂时忽略这种可能性。@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);
      }
  }
  ...
}

（再次，从匕首discuss@）。

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

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

我的问题是：辅助注射在实践中是如何进行的？有人有例子吗？我应该如何使用，如果有的话？ImageModule

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

答案 1

因此，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;
  }
}

答案 2

正如@xsveda所说，对于辅助注射，您可能希望使用辅助注射。我在这篇博文中写过它，但我会在这里添加一个完整的例子，让事情变得更容易。

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

compileOnly 'com.squareup.inject:assisted-inject-annotations-dagger2:0.5.0'
kapt 'com.squareup.inject:assisted-inject-processor-dagger2:0.5.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
  }
}

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

不幸的是，我们仍然有一个额外的步骤：

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

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

有了这个，你基本上可以像平常一样注入工厂并要求你的对象。