Play Framework 2.5.x：在模块中注入环境

Question

Play 应用包含一个在应用启动期间初始化 DB/Tables 的自定义模块。 从 v2.5.x 开始，需要注入应用程序模式（prod、test、dev）而不是使用 Current。我尝试在模块代码中应用以下注入参数，但看到编译错误。

trait MyInit[Environment] {
  val env: Environment
}

class MyInitClass[Environment] @Inject() (
  val env: Environment
) extends MyInit[Environment] {
  initializeDB()

  def initializeDB() = {
    Logger.info("MyINIT: Creating database...")
    MyDBService.createDatabase()
    Logger.info("MyINIT: Creating tables...")
    MyDBService.createTables()
  }
}

class MyModule(environment: Environment,
             configuration: Configuration) extends AbstractModule with ScalaModule {
  def configure() = {
    bind[MyInit[Environment]].to[MyInitClass[Environment]].asEagerSingleton()
  }
}

在 Play 2.5.x (Scala) 中的模块初始化期间是否有规定的查找环境/模式的方法？

Answer 1

我将重写您的代码，以消除这里可能出现的小混乱。这正是您对类型参数进行了小幅重命名的代码：

import javax.inject.Inject
import play.api.Logger
import play.api.Environment
import play.api.Configuration
import com.google.inject.AbstractModule

trait MyInit[T] {
  val env: T
}

class MyInitClass[T] @Inject() (val env: T) extends MyInit[T] {
  initializeDB()

  def initializeDB() = {
    Logger.info("MyINIT: Creating database...")
    MyDBService.createDatabase()
    Logger.info("MyINIT: Creating tables...")
    MyDBService.createTables()
  }
}

我重命名了类型参数以避免与play.api.Environment 混淆。我觉得这不是您想要的，因为MyInitClass 不会在任何地方主动收到play.api.Environment。

如果你想做一些初始化，为什么不使用更简单直接的方法：

import com.google.inject.AbstractModule
import play.api.{Configuration, Environment, Mode}

class DatabaseInitializerModule(
  environment: Environment,
  configuration: Configuration
) extends AbstractModule {

  def configure() = {
    environment.mode match {
      case Mode.Dev =>
        // Start dev database
      case Mode.Test =>
        // Start test database
      case Mode.Prod =>
        // Start prod database
    }
  }
}

---

编辑：

替换GlobalSettings.onStart 的更惯用和推荐的方法是described at the docs：

GlobalSettings.beforeStart 和GlobalSettings.onStart：启动时需要发生的任何事情现在都应该在依赖注入类的构造函数中发生。一个类将在依赖注入框架加载它时执行它的初始化。如果您需要预先初始化（因为您需要在应用程序实际启动之前执行一些代码），define an eager binding。

所以，我们可以将你的代码改写成这样：

import javax.inject.Inject

import play.api.{Environment, Mode}
import com.google.inject.AbstractModule

class DatabaseInitializer @Inject()(environment: Environment) {
  environment.mode match {
    case Mode.Dev =>
    // Start dev database
    case Mode.Test =>
    // Start test database
    case Mode.Prod =>
    // Start prod database
  }
}

class DatabaseInitializerModule extends AbstractModule {
  override def configure() = {
    bind(classOf[DatabaseInitializer]).asEagerSingleton()
  }
}

请注意我是如何删除 trait 的，因为它在这里没有添加任何价值。