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

时间:2016-05-24 14:32:30

标签: scala playframework guice

我使用conf/application.conf播放网络应用程序(没什么不寻常的)。 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
    ...
}

在当前配置中,FooImpl无法在不运行应用程序的情况下进行测试。我希望能够在单元测试中实例化FooImpl。 [从我的角度来看]完美的解决方案应该是这样的:

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实现绑定。

我想出的唯一解决方案是编写自己的模块,该模块遍历配置属性并将它们绑定为命名依赖项(来自this doc的示例的变体)。但我相信存在更好的方法。

4 个答案:

答案 0 :(得分:2)

我使用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;

}

希望这有帮助。

答案 1 :(得分:1)

不久前,我开发了针对Enum

上映射的简单注入配置变量的小型guice扩展

guice-config

答案 2 :(得分:1)

我在大约一年后遇到了同样的问题,这次提出了以下解决方案(非常类似于the one proposed by @stranger-in-the-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 {
    ""
  }
}

在这种情况下,不应使用Names.named(path),而应使用Names.named(getPrefix(entry.getValue) + path)

答案 3 :(得分:0)

要从播放配置中注入多个属性,您可以这样做。从Play配置中创建一个地图,并将其作为属性传递给Guice活页夹。

public class Module extends AbstractModule {

    private Environment environment;
    private Configuration configuration;

    public Module(Environment environment,Configuration configuration){
        this.environment = environment;
        this.configuration = configuration;
    }

    @Override
    public void configure() {
        Configuration helloConf = configuration.getConfig("myconfig");
        Map<String, Object> map = helloConf.asMap();
        Properties properties = new Properties();
        properties.putAll(map);        
        Names.bindProperties(binder(), properties);
    }
}