Play Framework编译时DI下控制器单元测试报错求助

问题场景 #

我在Play Framework中采用编译时依赖注入（Compile Time DI），通过自定义Bindings[IO]类管理所有依赖，控制器未使用@Inject注解：

final class ProvisioningController(bindings: Bindings[IO],
  val controllerComponents: ControllerComponents) extends ControllerBase {
  ......
}

对应的单元测试代码：

class ProvisioningControllerSpec extends ControllerBaseSpec with Results {

  implicit val timeout: Timeout = 5.seconds // Change the duration as needed

    "ProvisioningController#appConfig" should {
    "return the active AppConfig as JSON" in {
      val controller             = new ProvisioningController(bindings.appConfig, Helpers.stubControllerComponents())
      val result: Future[Result] = controller.appConfig.apply(FakeRequest())
      val bodyText: JsValue      = contentAsJson(result)
      bodyText mustBe "ok"
    }
  }
}

运行应用时出现以下错误：

[info] 1) No implementation for controllers.impl.ProvisioningController (with no qualifier annotation) was bound, and could not find an injectable constructor. Injectable classes must have either one (and only one) constructor annotated with @Inject or a zero-argument constructor that is not private.
[info]   at controllers.impl.ProvisioningController.class(ProvisioningController.scala:16)
[info]   while locating controllers.impl.ProvisioningController
[info]     for the 3rd parameter of router.Routes.<init>(Routes.scala:28)
[info]   at play.api.inject.RoutesProvider$.bindingsFromConfiguration(BuiltinModule.scala:139):
[info] Binding(class router.Routes to self) (via modules: com.google.inject.util.Modules$OverrideModule -> play.api.inject.guice.GuiceableModuleConversions$$anon$4)

问题根源 #

错误核心是：虽然你用了编译时DI，但Play默认仍会通过Guice（运行时DI）尝试实例化控制器——路由生成的代码默认依赖Guice注入控制器实例，而你的控制器没有@Inject注解，也无无参构造函数，导致Guice无法创建实例。

解决步骤 #

1. 切换路由生成器为静态模式 #

在build.sbt中配置路由生成器为StaticRoutesGenerator，让路由类生成接受控制器实例的构造函数，而非依赖Guice注入：

routesGenerator := StaticRoutesGenerator

2. 自定义ApplicationLoader接管DI流程 #

创建自定义的ApplicationLoader，手动构建所有依赖、控制器和路由，完全替代Guice的自动注入：

import play.api._
import play.api.mvc._
import play.api.routing.Router
import controllers.impl.ProvisioningController
import router.Routes

class CompileTimeDIApplicationLoader extends ApplicationLoader {
  override def load(context: ApplicationLoader.Context): Application = {
    // 初始化自定义Bindings
    val bindings = new Bindings[IO](context.environment, context.configuration)
    
    // 构建ControllerComponents实例
    val controllerComponents = DefaultControllerComponents(
      actionBuilder = DefaultActionBuilder(stubBodyParser(AnyContentAsEmpty)),
      parsers = PlayBodyParsers(context),
      messagesApi = DefaultMessagesApi(context),
      langs = DefaultLangs(context),
      fileMimeTypes = DefaultFileMimeTypes(context),
      executionContext = context.actorSystem.dispatcher,
      messagesActionBuilder = DefaultMessagesActionBuilderImpl(DefaultActionBuilder(stubBodyParser(AnyContentAsEmpty)), DefaultMessagesApi(context))
    )
    
    // 手动实例化控制器
    val provisioningController = new ProvisioningController(bindings, controllerComponents)
    
    // 构建路由，传入所有控制器实例
    val router = new Routes(
      httpErrorHandler = context.httpErrorHandler,
      // 按路由文件中的顺序传入其他控制器实例（如果有）
      provisioningController = provisioningController
    )
    
    // 构建并返回Application实例
    new DefaultApplication(
      environment = context.environment,
      configuration = context.configuration,
      loader = this,
      router = router,
      httpErrorHandler = context.httpErrorHandler,
      applicationLifecycle = context.applicationLifecycle,
      actorSystem = context.actorSystem,
      materializer = context.materializer
    )
  }
}

然后在application.conf中指定这个自定义Loader：

play.application.loader = "your.package.CompileTimeDIApplicationLoader"

3. 修正单元测试的参数错误 #

测试代码中构造控制器时，错误地传入了bindings.appConfig（类型不匹配），应该传入完整的Bindings[IO]实例：

// 初始化测试用的Bindings
val testBindings = new Bindings[IO](Environment.simple(), Configuration.empty)
val controller = new ProvisioningController(testBindings, Helpers.stubControllerComponents())

4. 禁用Guice自动注入（可选） #

如果需要彻底禁用Guice，可以在application.conf中添加：

play.modules.enabled -= "play.api.inject.guice.GuiceModule"

核心注意点 #

• 编译时DI需要完全手动控制所有组件的创建与依赖传递，不能依赖Guice的自动查找
• 路由必须通过构造函数传入控制器实例，而非让框架自动注入
• 自定义ApplicationLoader是编译时DI模式下的核心入口，负责串联所有应用组件

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