Play Framework中如何在JUnit测试类注入Database并实例化控制器？

嘿，我来帮你解决在JUnit测试中给Scala Play控制器注入play.api.db.Database依赖的问题。针对你的Messaging控制器场景，有两种常用的方案，你可以根据测试需求选择：

方案1：用Play Guice测试工具自动注入（推荐集成测试） #

如果你的测试需要真实的数据库交互（比如验证数据读写逻辑），Play框架的Guice测试工具可以帮你自动处理所有依赖注入，包括Database、Configuration和隐式的SecuredActions。

步骤示例： #

1. 确保测试类使用JUnit runner，并通过GuiceApplicationBuilder构建测试用的Play应用，配置轻量的内存数据库（比如H2）：

import org.junit.Test
import org.junit.runner.RunWith
import play.api.db.Database
import play.api.inject.guice.GuiceApplicationBuilder
import org.scalatestplus.junit.JUnitRunner

@RunWith(classOf[JUnitRunner])
class MessagingControllerTest {

  // 构建带H2内存数据库的测试应用
  private val testApp = new GuiceApplicationBuilder()
    .configure(
      "db.default.driver" -> "org.h2.Driver",
      "db.default.url" -> "jdbc:h2:mem:messaging-test;DB_CLOSE_DELAY=-1",
      "db.default.username" -> "sa",
      "db.default.password" -> ""
    )
    .build()

  @Test
  def testControllerWithDb(): Unit = {
    // 从应用注入器中直接获取控制器实例，所有依赖都会自动注入
    val messagingController = testApp.injector.instanceOf[Messaging]
    
    // 在这里执行你的测试逻辑，比如调用控制器的方法验证业务流程
    // 示例：val result = messagingController.someAction(FakeRequest())
    // ...
  }
}

说明： #

• 这种方式会启动一个轻量的Play测试应用，Guice会自动绑定所有依赖，包括你控制器里的Configuration、Database和隐式的SecuredActions（只要SecuredActions在你的Play模块中正确绑定了）。
• H2内存数据库不需要额外的数据库服务，测试结束后会自动销毁数据，非常适合集成测试。

方案2：手动模拟依赖（适合单元测试） #

如果你的测试只需要验证控制器的业务逻辑，不需要真实的数据库操作，可以用Mockito等工具模拟Database trait，手动实例化控制器。

步骤示例： #

1. 先添加Mockito的测试依赖（比如在build.sbt中加入"org.scalatestplus" %% "mockito-4-6" % "3.2.15.0" % Test"）
2. 编写测试代码：

import org.junit.Test
import org.junit.runner.RunWith
import org.mockito.Mockito._
import play.api.Configuration
import play.api.db.Database
import org.scalatestplus.junit.JUnitRunner
import org.scalatestplus.mockito.MockitoSugar

@RunWith(classOf[JUnitRunner])
class MessagingControllerTest extends MockitoSugar {

  @Test
  def testControllerWithMockedDependencies(): Unit = {
    // 模拟所有依赖项
    val mockConfig = mock[Configuration]
    val mockDb = mock[Database]
    val mockSecuredActions = mock[SecuredActions]
    
    // 手动实例化控制器，传入模拟的依赖
    val messagingController = new Messaging(mockConfig, mockDb)(mockSecuredActions)
    
    // 在这里执行单元测试，比如验证mockDb的方法是否被正确调用
    // 示例：messagingController.someDbAction()
    // verify(mockDb).withConnection(...)
    // ...
  }
}

说明： #

• 这种方式不需要启动Play应用，测试速度更快，适合单独测试控制器的逻辑，不需要涉及真实数据库交互。
• 你可以根据测试需求，给模拟的Database设置预期的返回值，或者验证方法调用次数。

额外注意点 #

• 如果SecuredActions是你自定义的隐式依赖，要确保它在测试中要么被正确模拟，要么在Play测试应用中能被Guice正确注入。
• 如果你需要测试真实的数据库操作，记得在测试前后清理数据，避免测试之间的干扰（比如用BeforeEach和AfterEach注解来执行初始化和清理逻辑）。

内容的提问来源于stack exchange，提问作者L Becker