Scala基于Scalatest实现仅单元测试阶段执行打印的方法

有两种简洁规范的处理方式，根据打印代码的所在位置选择即可：

方案1：打印逻辑仅在测试代码中使用（优先推荐） #

直接替换裸println为ScalaTest内置的info日志方法，这类输出由测试框架统一管控，仅在单元测试执行时会输出到控制台，程序正常运行时不会加载测试类，完全不会产生相关输出。
替换后的代码如下：

info("DataFrame results:")
dataFrame.show(100, false)

说明：info输出会和对应测试用例的结果绑定，比裸println的输出可读性更强，方便定位内容所属的用例；且dataFrame.show()本身是向标准输出流打印内容，由于这段代码仅存在于测试代码中，生产环境不会执行这段逻辑，不需要额外做输出拦截。

方案2：打印逻辑在公共/业务代码中，需要测试时输出、生产时静默 #

方式A：轻量无依赖实现 #

编写一个简单的调试输出工具类，通过运行时类路径判断当前是否为测试环境，自动决定是否输出：

import org.apache.spark.sql.DataFrame

object DebugOutput {
  // 检测类路径下是否存在ScalaTest核心类，判断是否为测试运行环境
  private val runningInTest: Boolean = try {
    Class.forName("org.scalatest.Suite")
    true
  } catch {
    case _: ClassNotFoundException => false
  }

  def showDfForTest(df: DataFrame, maxRows: Int = 100, truncate: Boolean = false): Unit = {
    if (runningInTest) {
      println("DataFrame results:")
      df.show(maxRows, truncate)
    }
  }
}

使用时直接替换原来的打印代码为DebugOutput.showDfForTest(dataFrame)即可。

注意：Maven/sbt默认构建规则下，ScalaTest属于test作用域依赖，不会被打包进生产部署包，该环境判断逻辑不会出现误判。

方式B：项目已引入日志框架（生产环境推荐） #

直接将这类调试打印统一用SLF4J/Log4j等日志门面输出，日志级别设为DEBUG：

val log = org.slf4j.LoggerFactory.getLogger(getClass)
log.debug("DataFrame results:")
dataFrame.show(100, false)

通过配置文件区分环境输出规则：

• 生产环境（src/main/resources下的日志配置）：仅输出INFO及以上级别日志，DEBUG级别的内容完全不输出
• 测试环境（src/test/resources下的日志配置）：开启DEBUG级别输出，测试运行时可以看到对应内容

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