如何在Java API编程风格中编写调试代码

Question

我正在编写API，我需要将其作为jar文件传递给下一位开发人员，他/她将在其程序中使用该文件。在API中编写由使用它的代码控制的调试代码的好方法是什么？

非常感谢。

Answer 1

我想你说的是调试日志吧？使用log4j

if (log.isDebugEnabled()) {
    log.debug("xxxxxxxxxxxxxxxxxxxxxxx");
}

更新：log4j可以为特定类配置log level：在log4j.properties中放置以下内容

log4j.logger.com.test.Test=DEBUG

Answer 2

不同级别的API日志:调试级用于获取细节，信息用于有用的东西，警告糟糕的things.

• Provide测试方法，通过接口公开您的，以允许轻松模拟。

1. 提供了扩展点(使用相同的接口)，以尽可能多地满足不可预见的需求。(您不会得到所有的functionality.
2. Provide，但就是这样。)
3. 提供了代码样本和/或单元测试，这些代码样本和/或单元测试使用了大量的API编写的文档，这些文档解释了为什么事情是这样工作的。代码解释了它是如何工作的。

Answer 3

如果您刚刚发布了一个JAR，那么如果一开始就不依赖于log4j，而是让您的插件的用户插入他们自己的"LoggerFactory“，那就太好了。您在代码中获得的所有“记录器”都是通过该工厂获得的，就像您从log4j中检索它们一样(例如，通过传递类名)，并且应该具有类似的级别。

这样，想要使用log4j的客户仍然可以使用，而使用其他记录器的客户可以立即将其插入。