如何让测试专用函数仅对单元测试可见，禁止生产代码调用？

核心需求 #

让部分方法仅对单元测试代码开放，禁止生产代码调用，且不依赖可能被SecurityManager拦截的反射技巧。目标是实现类似@VisibleForTesting的强制约束效果，或是模拟Rust中测试代码嵌入被测模块、直接访问内部项的封装能力。

可行实现方式 #

1. 利用internal修饰符+同源集模块共享

这是Kotlin官方推荐的方式，核心是让测试代码与主代码属于同一模块的不同源集，共享internal成员的可见性：

• 在主代码中，用internal修饰测试专用方法：

  // src/main/kotlin/com/example/MyClass.kt
  class MyClass {
      internal fun testOnlyHelper() {
          // 仅测试需要的逻辑
      }
  }
  

• 测试代码直接放在同一模块的test源集下（如src/test/kotlin/com/example/MyClassTest.kt），无需额外配置即可直接调用internal方法：

  class MyClassTest {
      @Test
      fun testHelperFunction() {
          val myClass = MyClass()
          myClass.testOnlyHelper() // 测试代码可正常访问
      }
  }
  

• 效果：跨模块的生产代码完全无法访问该方法；同一模块的生产代码虽能访问，但可通过代码规范、评审来约束调用。

2. Android环境下用@RestrictTo+Lint强制拦截

如果是Android项目，可借助AndroidX的@RestrictTo注解配合Lint规则，直接在编译阶段阻止生产代码调用：

• 给测试专用方法添加注解：

  import androidx.annotation.RestrictTo
  import androidx.annotation.RestrictTo.Scope.TESTS
  
  class MyClass {
      @RestrictTo(TESTS)
      fun testOnlyHelper() { ... }
  }
  

• 在Gradle配置中，将该注解的违规行为设为编译错误：

  // build.gradle.kts
  android {
      lint {
          error("RestrictedApi")
      }
  }
  

• 效果：生产代码一旦调用该方法，会直接触发编译错误，从根源上阻止调用。

3. 用编译注解@TestOnly实现编译期约束

Kotlin标准库提供了实验性的@TestOnly注解，可通过编译参数控制可见性：

• 给测试专用方法添加注解：

  import kotlin.test.TestOnly
  
  class MyClass {
      @TestOnly
      fun testOnlyHelper() { ... }
  }
  

• 在Gradle中配置测试编译时启用该注解，生产编译时禁用：

  // build.gradle.kts
  kotlin {
      sourceSets {
          main {
              kotlin.options.freeCompilerArgs += "-Xopt-in=kotlin.test.TestOnly"
              // 生产编译时移除该参数，强制生产代码无法调用
          }
          test {
              kotlin.options.freeCompilerArgs += "-Xopt-in=kotlin.test.TestOnly"
          }
      }
  }
  

• 注意：该注解目前处于实验性阶段，需配合@OptIn(ExperimentalStdlibApi::class)或编译参数启用。

4. 模拟Rust的模块内测试：同文件隔离测试代码

可以将测试代码直接写在生产代码文件中，通过编译条件隔离：

// src/main/kotlin/com/example/MyClass.kt
class MyClass {
    private fun coreLogic() { ... }

    // 测试专用方法，仅在测试编译时编译
    @TestOnly
    internal fun exposeCoreLogicForTest() = coreLogic()
}

// 测试代码块，仅在测试源集编译时生效
@OptIn(ExperimentalStdlibApi::class)
@TestOnly
fun testMyClass() {
    val myClass = MyClass()
    myClass.exposeCoreLogicForTest()
}

• 效果：测试代码与生产代码在同一文件，但生产编译时会自动排除@TestOnly标记的代码，既实现了模块内测试的封装，又不会污染生产代码。

总结 #

Kotlin没有原生支持完全强制的"仅测试可见"修饰符，但通过上述方法组合，可实现接近需求的效果：

• 跨模块调用：用internal彻底阻止；
• 同模块生产代码调用：用@RestrictTo或@TestOnly配合编译规则强制拦截；
• 模拟Rust的模块内测试：用@TestOnly或同源集共享实现。

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