Scala单例对象Mock失效问题：MockitoSugar无法拦截依赖调用

问题场景 #

为Object1的main函数编写单元测试时，使用MockitoSugar Mock UtilObject未生效，程序仍执行原方法逻辑。相关代码如下：

业务代码 #

object Object1 {
  def main(sysArgs: Array[String]): Unit = {
     val inputDF: DataFrame = UtilObject.getInput()
  }
}

object UtilObject {
  def getInput(): DataFrame = {
   // 实际业务逻辑
  }
}

测试代码 #

"object1Main" should "make correct calls" in {
  val inputArgs = Array("abc")
  val util = mock[UtilObject.type]

  when(util.getInput()).thenReturn(inputData)
  
  Object1.main(inputArgs)
}

问题根源 #

Scala的object是编译期单例，对应Java的静态类结构，MockitoSugar无法直接Mock静态成员；同时业务代码中硬编码调用UtilObject.getInput()，没有预留依赖替换的入口，导致Mock的实例根本不会被Object1使用。

解决方案 #

方案1：重构代码引入依赖注入（推荐） #

将UtilObject的逻辑抽象为特质，让Object1依赖抽象而非具体单例，预留测试时替换依赖的入口：

重构后业务代码

// 抽象输入获取逻辑的特质
trait InputProvider {
  def getInput(): DataFrame
}

// 原单例实现该特质
object UtilObject extends InputProvider {
  override def getInput(): DataFrame = {
    // 原业务逻辑
  }
}

object Object1 {
  // 提供默认依赖，测试时可替换
  private[Object1] var inputProvider: InputProvider = UtilObject

  def main(sysArgs: Array[String]): Unit = {
     val inputDF: DataFrame = inputProvider.getInput()
  }
}

重构后测试代码

"object1Main" should "call getInput correctly" in {
  val inputArgs = Array("abc")
  val mockProvider = mock[InputProvider]
  when(mockProvider.getInput()).thenReturn(inputData)

  // 替换Object1中的依赖实例
  Object1.inputProvider = mockProvider
  
  Object1.main(inputArgs)

  // 验证调用行为
  verify(mockProvider).getInput()
}

方案2：使用PowerMock Mock静态类（备选） #

若无法重构业务代码，可借助PowerMock扩展Mockito能力来Mock静态类，但会增加测试复杂度，不推荐长期使用：

依赖配置（build.sbt）

libraryDependencies ++= Seq(
  "org.powermock" % "powermock-module-junit4" % "2.0.9" % Test,
  "org.powermock" % "powermock-api-mockito2" % "2.0.9" % Test
)

调整后的测试代码

import org.powermock.api.mockito.PowerMockito
import org.powermock.core.classloader.annotations.PrepareForTest
import org.scalatestplus.junit.JUnitRunner
import org.junit.runner.RunWith

@RunWith(classOf[JUnitRunner])
@PrepareForTest(Array(classOf[UtilObject.type]))
class Object1Test extends AnyWordSpec with MockitoSugar {

  "object1Main" should "invoke UtilObject.getInput" in {
    val inputArgs = Array("abc")
    // Mock静态类
    PowerMockito.mockStatic(classOf[UtilObject.type])
    when(UtilObject.getInput()).thenReturn(inputData)
    
    Object1.main(inputArgs)

    // 验证静态方法调用
    PowerMockito.verifyStatic(classOf[UtilObject.type])
    UtilObject.getInput()
  }
}

总结 #

优先选择重构引入依赖注入的方案，既解决测试问题，也提升代码的可扩展性和可维护性；PowerMock仅作为无法重构时的临时解决方案。

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