如何使用 testng、slf4s 和 logback 在 scala 单元测试中进行日志记录

Question

我是 Scala 的新手，对 Java 的最新发展不太熟悉，所以我遇到了我认为是一个基本问题。

我正在编写一些 Scala 代码，并使用 ScalaTest 和 TestNG 通过测试装置对其进行测试。测试中的代码使用 slf4s 来执行日志记录，并由 logback 支持。

在我的“build.sbt”文件中，我有我需要的所有库的依赖项：

scalaVersion := "2.9.1"

// Add test dependencies on scalatest and testng

libraryDependencies ++= Seq("org.scalatest" %% "scalatest" % "1.6.1" % "test", "org.testng" % "testng" % "6.1.1" % "test")

// Use the slf4j logging facade for logging
libraryDependencies += "org.slf4j" % "slf4j-api" % "1.6.3"

//use the slf4j connectors to implement the JCL logging facade in terms of slf4j (which in turn is implemented in terms of logback)
//confused yet?
libraryDependencies += "org.slf4j" % "jcl-over-slf4j" % "1.6.3"

//use logback for the back-end slf4j logging impl.
libraryDependencies ++= Seq("ch.qos.logback" % "logback-core" % "0.9.30", "ch.qos.logback" % "logback-classic" % "0.9.30")

//use slf4s to expose the slf4j logging facade in scala

libraryDependencies += "com.weiglewilczek.slf4s" %% "slf4s" % "1.0.7"

//Add the dispatch HTTP client dependency

libraryDependencies ++= Seq(
  "net.databinder" %% "dispatch-http" % "0.8.5"
)

//I can't figure out how to use the dispatch HTTP client library, so just use the apache one

libraryDependencies += "org.apache.httpcomponents" % "httpclient" % "4.1.2"

我像这样执行日志记录（为了可读性而简化代码）：

class MyClass extends Logging {
   def doSomething() {
      logger.debug("Hello world")
  }
}

当我运行一个测试来执行此代码时（使用“sbt test”命令）我做看不到调试消息，但我确实看到打印到控制台：

    SLF4J: The following loggers will not work because they were created
SLF4J: during the default configuration phase of the underlying logging system.
SLF4J: See also http://www.slf4j.org/codes.html#substituteLogger
SLF4J: MyClass

我在 src/test/resources 中有一个 logback.xml 文件，并且我知道日志记录本身正在工作，因为我看到 Apache HttpClient 库（使用 JCL）的输出）。

我错过了什么吗？我记录的信息有助于通过测试探索代码的行为，而且这似乎应该可行。我当然已经阅读了 http://www.slf4j.org/codes.html#substituteLogger 的页面 但我不知道在配置日志子系统之前我的记录器是如何创建的。

更新：这是我的 logback.xml 的内容：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
     ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} %line --- %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

Answer 1

我认为这是因为 SBT 并行运行测试，并且 Slf4j 中的一些初始化代码不是线程安全的（！）。
请参阅 http://jira.qos.ch/browse/SLF4J-167 ... 2年多前就已经报道过！

作为解决方法，我通过在测试运行之前加载根记录器来初始化 Slf4j。为此，只需将其添加到您的 SBT 设置中：

testOptions += Setup( cl =>
   cl.loadClass("org.slf4j.LoggerFactory").
     getMethod("getLogger",cl.loadClass("java.lang.String")).
     invoke(null,"ROOT")
)

Answer 2

问题是，虽然第一个线程正在初始化底层日志记录实现（阻塞），但对于所有其他并发线程， SubstituteLoggerFactory 已创建。该替代记录器工厂返回 SubstituteLogger 而不是实际的记录器实现。 SLF4J-167 中未解决此问题。

在 Java 中不太可能遇到这个问题，因为记录器对象通常被创建为静态变量，因此 LoggerFactory 在类加载期间被初始化。在 Scala 中，没有 static 修饰符，伴生对象是延迟初始化的。
此外，Scala 中的大多数测试框架都是并行执行测试的。

要解决此问题，您可以更改测试环境：正如 Bruno Bieth 建议的那样，您可以在测试开始之前初始化 LoggerFactory。您也可以在测试代码而不是构建设置中执行此操作。您还可以将测试设置为按顺序运行，但这样会降低速度。

或者，您可以急切地初始化在伴生对象中初始化的 Logger。丑陋，但在大多数情况下确保并发创建的 Foo 对象不会使用 SubstituteLogger 进行初始化。

class Foo {
  val logger = Foo.singletonLogger
}

object Foo {
  val singletonLogger = LoggerFactory.getLogger(getClass)
}

Answer 3

我有同样的问题。最终只是在类定义中实例化一个空记录器。

如果我将我的方法应用到你的代码中，那么

import com.weiglewilczek.slf4s.{Logger, Logging}

class MyClass with Logging {
   val _ = Logger("") // <--Solved problem

   def doSomething() {
      logger.debug("Hello world")
  }
}

请注意，我对 scala 非常陌生，所以我不知道我刚刚所做的事情的全部含义。

Answer 4

slf4s 1.0.7 依赖于 slf4j 1.6.1，您可以在[此处][1]中看到。尝试使用此版本而不是 1.6.3 作为您的其他 slf4j 依赖项。