Kotlin中使用by lazy初始化类级变量是否会阻碍单元测试而应避免？

你遇到的测试问题本质是类依赖硬编码导致的耦合问题，和懒加载特性本身无关，下面是具体的原理说明和解决方案：

问题根源 #

如果直接在类内部硬编码依赖的实例化逻辑，不管是否使用by lazy都无法正常mock：

// 错误示例：依赖硬编码在类内部，无法mock
class OrderService {
    private val payApi by lazy { AlipayApi(AppConfig.getConfig()) }
}

上述写法就算去掉by lazy，直接写成private val payApi = AlipayApi(AppConfig.getConfig())，一样存在无法mock的问题，锅完全不在懒加载特性上。

可测试的by lazy使用方案 #

方案1：构造参数注入懒加载依赖（最推荐） #

把依赖的实例化控制权交给外部，类的构造参数直接接收Lazy类型的依赖：

// 生产代码
class OrderService(private val payApi: Lazy<AlipayApi>) {
    private val api by payApi
    
    fun createOrder() {
        api.pay()
    }
}

• 生产环境初始化：val service = OrderService(lazy { AlipayApi(realConfig) })
• 单元测试初始化：直接传入mock好的实例即可，使用lazyOf可以直接包装已有的mock对象：

  val mockApi = mockk<AlipayApi>()
  val testService = OrderService(lazyOf(mockApi))
  // 后续正常测试即可
  

如果想保留生产环境直接初始化的便利性，可以给构造参数加默认值：

class OrderService(
    private val payApi: Lazy<AlipayApi> = lazy { AlipayApi(AppConfig.getConfig()) }
) {
    private val api by payApi
}

生产环境直接OrderService()就能用，完全不影响原有开发体验。

方案2：开放懒加载属性的覆写权限 #

如果不想调整构造参数，可以把懒加载属性设置为open，测试时继承类覆写对应属性即可：

// 生产代码
open class OrderService {
    protected open val payApi by lazy { AlipayApi(AppConfig.getConfig()) }
}

// 测试代码
class TestOrderService: OrderService() {
    override val payApi = mockk<AlipayApi>()
}

如果你的项目用了Spring之类的框架，也可以配合all-open插件避免手动给类加open关键字。

总结 #

by lazy是非常实用的懒加载特性，只要做好依赖解耦，完全不会影响单元测试。因为测试问题就放弃该特性属于因噎废食，只要调整依赖的注入方式，就能同时拥有懒加载的便利和可测试性。

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