使用 Guice 在游戏框架中注入配置值

Question

我用conf/application.conf玩Web应用程序（没什么不寻常的）。Guice用于依赖注入。如何在类构造函数中注入属性值？代码如下。

class MyController @Inject() (private val foo: Foo) extends Controller {
    ...
}

@ImplementedBy(classOf[FooImpl])
trait Foo { 
    def bar: String
}

class FooImpl extends Foo {
    override val bar = current.configuration.getString("my.bar").get
    ...
}

在当前配置中，如果不运行应用程序，就无法测试FoImpl。我希望能够在单元测试中实例化FoImpl。完美的解决方案[从我的角度来看]应该是这样的：

class FooImpl @Inject() (@Named("my.bar") override val bar: String) extends Foo {
    ...
}

不幸的是，这段代码不起作用，因为Guice没有“my”。bar绑定：

没有绑定使用 @com.google.inject.name.Named（value=my.bar） 注释的 java.lang.String 的实现。

我想出的唯一解决方案是编写我自己的模块，该模块遍历配置属性并将它们绑定为命名依赖项（本文档中示例的变体）。但我相信存在更好的方法。

Answer 1

大约一年后，我遇到了同样的问题，这次我提出了以下解决方案(与@ q中的陌生人和@droidman提出的方案非常相似):

class InjectionModule extends AbstractModule {

  override def configure(): Unit = {

    val config: Config = TypesafeConfigReader.config
    config.entrySet().asScala.foreach { entry =>
      val path = entry.getKey
      entry.getValue.valueType() match {
        case ConfigValueType.NUMBER =>
          bind(classOf[Int])
            .annotatedWith(Names.named(path))
            .toInstance(config.getInt(path))
        case ConfigValueType.BOOLEAN =>
           bind(classOf[Boolean])
             .annotatedWith(Names.named(path))
             .toInstance(config.getBoolean(path))
        case ConfigValueType.STRING =>
           bind(classOf[String])
             .annotatedWith(Names.named(path))
             .toInstance(config.getString(path))
        case _ =>
      }
    }
  }
}

此外，可以通过将前缀附加到系统属性（哪些键值对是加载的配置的一部分）来扩展此方法：

private def getPrefix(configValue: ConfigValue): String = {
  val description = configValue.origin().description()
  if (description.contains("system properties")) {
    "sys."
  } else {
    ""
  }
}

在这种情况下，不要编写＜code＞Names。named（path）应该使用Names.named（getPrefix（entry.getValue）path）。

Answer 2

前段时间我开发了小guice扩展，用于在Enum上映射的简单注入配置变量

guice-config

Answer 3

我用Java实现了它。我希望您可以将它作为Scala实现的参考。

起初，我创建了一个模块：

public class MainModule extends AbstractModule {
    public final static String TIMEOUT_IN_MILLISECONDS_ANNOTATION = "timeout-promise";
    private final Configuration configuration;

    public MainModule(@SuppressWarnings("unused") Environment environment, Configuration configuration) {
        this.configuration = configuration;
    }

    @Override
    protected void configure() {
        long timeoutInMilliseconds = configuration.getLong("application.promise.timeout.in.milliseconds", 0L);
        bindConstant().annotatedWith(Names.named(TIMEOUT_IN_MILLISECONDS_ANNOTATION)).to(timeoutInMilliseconds);
    }
}

之后，我只是在不同的地方使用了注释：

class Service {

    @Inject
    @Named(MainModule.TIMEOUT_IN_MILLISECONDS_ANNOTATION)
    protected long timeoutInMilliseconds;

}

希望这有帮助。