Play控制器单元测试中注入Mock服务对象的问题排查

你遇到的核心问题是没有将Guice绑定指向具体的Mock实例——你之前的bind[MyService]只是声明了绑定类型，但没告诉Guice要用你创建的Mock对象来替代真实服务。下面是一步步的修正方案：

1. 准备Mock服务实例 #

首先，用Mockito创建MyService的Mock对象，并预设你需要的方法行为（比如getAll方法的返回值）：

import org.mockito.Mockito._
import scala.concurrent.Future

// 创建Mock实例
val mockMyService = mock[MyService]
// 预设方法行为：比如当调用getAll时，返回预期的成功结果
when(mockMyService.getAll()).thenReturn(Future.successful(/* 这里放你预期的返回数据，比如List.empty或者测试用的实体列表 */))

2. 正确配置Guice应用，绑定Mock实例 #

在GuiceApplicationBuilder的overrides方法中，明确将MyService绑定到你创建的Mock实例，而不是只绑定类型：

import play.api.inject.guice.GuiceApplicationBuilder

val app = new GuiceApplicationBuilder()
  .overrides(bind[MyService].toInstance(mockMyService)) // 关键：绑定到具体Mock实例
  .build()

3. 修改测试代码，使用配置好的应用 #

结合你原有的测试代码，调整后完整的测试类如下：

import org.scalatestplus.play._
import play.api.mvc._
import play.api.test._
import play.api.test.Helpers._
import org.mockito.Mockito._
import scala.concurrent.ExecutionContext.Implicits.global
import play.api.libs.json.Json

class MyControllerTest extends PlaySpec with GuiceOneAppPerSuite {

  "MyController" should {
    "not return 404 and return expected success JSON" when {
      "hitting the /ads route" in {
        // 1. 创建并配置Mock服务
        val mockMyService = mock[MyService]
        // 根据你的控制器逻辑，预设对应方法的返回值
        when(mockMyService.getAll()).thenReturn(Future.successful(/* 替换成你预期的业务数据 */))

        // 2. 构建注入了Mock服务的应用
        val appWithMock = new GuiceApplicationBuilder()
          .overrides(bind[MyService].toInstance(mockMyService))
          .build()

        // 3. 执行请求并验证结果
        val fakeRequest = FakeRequest(GET, "/ads")
        val futureResult = route(appWithMock, fakeRequest).get
        status(futureResult) mustBe OK
        contentAsJson(futureResult) mustBe Json.obj("status" -> "success")
      }
    }
  }
}

额外提示 #

• 如果你的控制器依赖ExecutionContext，确保测试环境中有可用的EC（比如导入scala.concurrent.ExecutionContext.Implicits.global）。
• 如果你需要在多个测试用例中复用Mock服务，可以把Mock实例的创建和预设逻辑提取到beforeEach或beforeAll方法中。
• 测试完成后，记得验证Mock方法的调用情况（比如用verify(mockMyService).getAll()确认方法被调用过），让测试更严谨。

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