Scala (Play 2.4.x) 如何使用@inject() 注解调用类

Question

我正在查看 play-mailer 中的鳞状代码示例：https://github.com/playframework/play-mailer

基本上是这样的：

class MyComponent @Inject() (mailerClient: MailerClient) {
   ...
}

足够简单，编译时不兼容

然后我尝试“调用”它，但似乎没有一种方法可以满足编译器或获取 mailerClient 的工作实例。

object AnObject {
  val mailer = new MyComponent
  def sendEmail = mailer.doStuff
}

[info] Compiling 1 Scala source to ...
[error] /SomeOne/SomePath/SomeFile.scala:30: not enough arguments for constructor MyComponent: (mailerClient: play.api.libs.mailer.MailerClient) MyComponent.
[error] Unspecified value parameter mailerClient.
[error]   val mailer = new MyComponent
[error]                ^
[error] one error found
[error] (compile:compileIncremental) Compilation failed

虽然我可能会因为这个而接近：

How does @Inject in Scala work

这表明以下语法可以通过从构造函数中删除 @Inject 并将其放在字段上来工作。

@Inject var mailerClient: MailerClient = null

但是，当我们尝试运行任何需要该引用的东西时，我们仍然会得到 null。

我正在阅读我在@Inject 上可以找到的所有内容

( [警告] [咆哮] 由于这个确切的原因，我不喜欢这样的编译器魔法——巫术魔法非常棒，直到它停止工作，然后似乎没有人知道如何修复它。[/rant] [/warning] )

但我真正想知道的是如何正确、安全、有效地使用它。

Answer 1

这不是 scala 问题，而是 DI 问题。您应该阅读一些 guice 文档。

在 Play 2.4.x 中，需要使用依赖注入 (https://www.playframework.com/documentation/2.4.x/ScalaDependencyInjection) 来实现你的目标。

你的 AnObject 应该是：

@Singleton class AnObject @Inject()(mailer:MyComponent){
 def sendEmail = mailer.doStuff
}

Answer 2

由于您在原始 GitHub 存储库上关闭了您的问题，我不知道这个答案是否仍然必要，但由于您不完全了解 DI 框架的使用，我发现学习这项技能非常重要，我将尝试在这里解释它并列出一些好处。

首先，您实例化实例的方式不会让 DI 框架有机会注入您的依赖项。由于new 是语言关键字，因此DI 无法干扰，并且您的类所需的依赖项也无法注入。它是通过构造函数或字段注入来完成的。我将主要关注构造函数注入，因为这是 scala 世界中的“标准”。

如果您使用 @Injected 注释指定构造函数参数，则基本上是在告诉 DI 框架从容器中解析此依赖关系。 DI 框架会在其容器内查找该对象的条目。如果它不存在，它将创建它（并在此过程中解决它的依赖关系），如果它带有 @Singleton 注释，则还保存此实例以供将来使用。大多数 DI 框架要求您在大多数情况下指定起始类，但因为您使用的是 Play！框架这不是必需的。当您想在控制器中使用特定模块时，您可以这样做：

import javax.inject.Inject

import play.api.mvc.Controller

class Test @Inject() (val dependency: FooClass) extends Controller {
  ...
}

在这种情况下，FooClass 是您要注入控制器的依赖项的类名。假设 FooClass 有 Play 的 Application 作为依赖项，这将被注入，因为 Play 提供了几个预先绑定的预设，如 Application 和 ActorSystem。

这是可能的，因为 Play！框架使用DependencyInjectedRoutes。如果要在 Controller 之外创建 Actor，则需要在模块类中指定它，但这在 link 和 link 中有解释。

还有一个概念是在控制器内部使用Traits，然后将特征与实现类连接在一起，但我认为现在这有点太复杂了。

如果您想了解这种编写应用程序的方法的好处和成功案例，这里有一个很好的资源：@​​987654323@

如果您想了解有关此概念的内容：

• https://www.playframework.com/documentation/2.4.x/ScalaAkka
• https://www.playframework.com/documentation/2.4.x/ScalaDependencyInjection
• https://www.playframework.com/documentation/2.4.x/ScalaCompileTimeDependencyInjection

我希望这可以解决问题！如果您有任何问题，请尽管提问！

Answer 3

我遇到了同样的问题。我想创建一个具有邮件功能的类或对象，然后我可以在我想从任何控制器发送电子邮件时调用它。

我认为您所问的相当于如何在游戏框架之外使用mailerclient。据我了解，你不能。即使您在 app/controllers 文件夹中创建了一个类，它也只是一个常规的 scala 类，与 play 框架中的魔法无关。 @Inject 仅适用于控制器或模块。因为如果你创建一个独立的类，你必须在实例化它的时候自己注入一些东西。除非您正在构建模块或扩展控制器。您是否注意到 AppController 曾经是对象，而现在它是一个类？使用时不需要实例化它。我相信框架做了一些事情来通过配置（注入）来实例化它。

所以如果你想达到最初的设计目标，你要么编写一个模块，发布它，然后在所有控制器中使用它；或者使用 scala 中的一些其他电子邮件库来封装电子邮件发送功能。

Answer 4

（我没有足够的声誉来发表评论，所以发布作为答案）

@aparo 发布的答案应标记为正确/批准的答案，因为它确实解决了问题。您说这并不能解决最初的问题，因为它将依赖项移至另一个类，但这只是部分正确，因为其他类只需要为您提供MyComponent 而不是MailerClient。虽然依赖注入需要一直使用到最终控制器（在 Play 的情况下），但您通常不必注入多个单个对象。

这方面的证据可以看到in a question I posted，因为我当时的心态和你一样。在我的示例中，我的控制器只需要一个 UserSearch 依赖项，DatabaseConfigurationProvider 依赖项由 guice 处理，因此我不需要在任何地方再次声明它。