在java中删除对System.out的访问

Question

我维护一个应用程序，它充当多个单独程序的容器。这些程序有自己专用的日志记录工具，即它们记录的所有内容都会记录到一个特殊的日志文件中。

尽管如此，应用程序开发人员似乎喜欢到处抛出 System.out.println 和 e.printStackTrace 调用，从而无法保持干净的状态。运行容器时的控制台。

如何防止这些应用程序污染 System.out 和 System.err？

---

实现说明：

• 应用程序使用Log4j进行日志记录；
• 容器还使用控制台进行日志记录，但它严格保留用于生命周期事件和问题，因此我仍然需要控制台；
• 应用程序使用自定义类加载器加载，但不应用安全检查。

---

更新：

简单地重定向 System.out 是行不通的，因为它会重定向所有输出，所以类似这样的事情会失败：

    System.setOut(new PrintStream(new OutputStream() {

        @Override
        public void write(int b) {

            throw new Error("Not on my watch you don't");

        }
    }));

    Logger logger = Logger.getLogger(Runner.class);
    logger.info("My log message");

这应该会成功。

更新 2：

的代码来加载和配置应用程序。

App app = new UrlClassLoader(...).loadClass(className)).newInstance();
app.setLogger(loggerForClass(app));

使用类似于从系统类加载器加载 Log4j

Answer 1

假设您可以控制容器输出，您可以执行以下操作：

import java.io.*;
public class SysOut {
    public static void main(String[] args) throws Exception {
            PrintStream pw = new PrintStream(new FileOutputStream("a.txt"));
            PrintStream realout = System.out;
            System.setOut(pw);
            System.out.println("junk");
            realout.print("useful");
}
}

$ java SysOut 
useful
$ cat a.txt 
junk

Answer 2

您可以使用 System.setOut() 和 System.setErr() 将 stdout 和 stderr 重定向到打印流。

Answer 3

虽然 Java 定义了标准 System.out 和 System.err，但可以用您自己的流覆盖它们。请参阅 http://www.devx.com/tips/Tip/5616

基本上你可以设置新的流，要么通过管道传输到日志记录，要么只是让数据消失殆尽。我更喜欢后者，因为它可以立即消除开发人员对 System.out 的依赖，并避免他们在其中编写的任何内容都会消失。

**更新：
我刚刚重新阅读了您在问题中的规定，发现您仍然需要容器应用程序的控制台。如果您围绕标准流编写一个包装器，这可能仍然有效，这样您就可以检查每个调用并查看它是否来自父应用程序（并将其传递）或子应用程序（并阻止它）

Answer 4

使用厌恶疗法。每当签入任何包含令人不快的结构的代码时，都会安排“检查员”进行访问。

Nice cubicle you got ere, be shame if anyfing appened to it.

Answer 5

如果您有无头构建机制，ant 等，那么您可以将 CheckStyle 添加到构建中，并配置 checkstyle 以便在代码中发现任何 System.out.println 或 e.printStackTrace 时使构建失败。

如果您没有无头构建，我建议您构建一个，因为这意味着您拥有可重复、可预测的构建。

Answer 6

System.setOut 将重定向所有输出 - 但您提供的 PrintStream 可以决定如何处理输出。因此，我确信您可以提供这样一个流，该流实际上只会从您的应用程序打印语句。

唯一棘手的部分实际上是能够检测什么是有效的调用，什么是无效的。一种有效但可能非常慢的方法是调用 Thread.currentThread().getStackTrace() 并查看哪些代码（或至少是包）正在调用您（只需返回 if这不是一个有效的）。但我不建议这样做，因为性能损失将是惊人的，特别是在每个字节读取时都这样做。

更好的想法可能是在所有有效的容器线程中设置 ThreadLocal 标志。然后，您可以实现如下所示的 PrintStream：

public class ThreadValidity extends ThreadLocal<Boolean>
{
    private static final INSTANCE = new ThreadValidity();

    @Override Boolean initialValue() { return false; }
    public static ThreadValidity getInstance() { return INSTANCE; }
}

class VerifyingPrintStream extends PrintStream
{
    private boolean isValidThread()
    {
        return ThreadValidity.instance().get();
    }

    public void println(String s)
    {
        if (!isValidThread()) return;
        super.println(s);
    }

    public void println(Object o)
    {
        if (!isValidThread()) return;
        super.println(o);
    }

    // etc
}

或者，如果您能够更改容器代码中的 println，事情会变得更容易。您可以将所有控制台写入交给特定的工作人员；并让这个工作人员“窃取”System.out（将其存储在自己的字段中并直接使用它来写入输出），同时将实际的 System.out 设置为无操作写入器。

Answer 7

这里的关键是在重定向输出流之前配置 log4j，例如

BasicConfigurator.configure();
System.setOut(...);
System.setErr(...);

System.out.println("I fail");
Logger.getLogger(...).info("I work");

Answer 8

将 System.out 和 System.err 流转换为特殊实现，每次写入字符时都会抛出 RuntimeException(“使用日志记录而不是 System.out”)。

如果你的容器很重要，他们很快就会明白这个想法:)

（为了获得额外的奖励，请抛出 OutOfMemoryException ;-)）

Answer 9

我所做的是将 System.out 和 System.err 的 PrintStream 分别重定向到 commons-logging 作为 INFO 和 ERROR 级别日志记录。

如果您希望某些线程能够写入控制台或者您希望日志也发送到控制台，那么这会变得更加棘手，但这是可以完成的。

Answer 10

在替换它们之前，您实际上可以获取并存储 System.out/err。

OutputStream out=System.getOut();  // I think the names are right
System.setOut(some predefined output stream, null won't work);
out.println("Hey, this still goes to the output");
System.out.println("Oh noes, this does not");

我使用它来拦截代码库中的所有 System.out.println，并在输出的每一行前面加上它来自的方法名称/行号。

Answer 11

关闭 System.out 和 System.err 流。

Answer 12

我们使用 log4j 技巧，但将日志记录到单独的文件（stdout.log、stderr.log）。将它们的输出与真正理解日志记录的部分混合在一起是没有用的......