FilterOutputStream 是 Java I/O 中用于装饰输出流的基类,通过重写 write 方法拦截并修改写入行为,支持加密、压缩、日志等自定义逻辑,需注意 flush/close 重写、异常处理及线程安全。

FilterOutputStream 是 Java I/O 中用于包装其他输出流、添加额外处理逻辑的装饰器基类。它本身不直接实现具体功能,而是提供一个模板,让你通过继承它来自定义写入行为,比如加密、压缩、日志记录、数据转换等。
核心机制:重写 write 方法是关键
FilterOutputStream 的设计意图是“拦截并修改”底层流的写入过程。它的三个 write() 方法(单字节、字节数组、指定范围)默认都委托给内部持有的 out 流。要自定义行为,你必须重写至少一个 write 方法,按需处理数据后再调用 super.write(...) 或直接操作 out。
- 重写
write(int b):处理单字节写入,适合逐字节变换(如大小写翻转、异或加密) - 重写
write(byte[] b, int off, int len):更高效,适合批量处理(如 Base64 编码、添加校验头) - 通常不需要重写无参
write(byte[] b),因为它默认调用带偏移和长度的版本
自定义示例:添加写入日志的 LogOutputStream
下面是一个简单但实用的例子——在每次写入前打印日志,便于调试或监控:
public class LogOutputStream extends FilterOutputStream {
private final String tag;
public LogOutputStream(OutputStream out, String tag) {
super(out);
this.tag = tag;
}
@Override
public void write(int b) throws IOException {
System.out.printf("[%s] write byte: 0x%02X%n", tag, b);
super.write(b); // 继续写入到底层流
}
@Override
public void write(byte[] b, int off, int len) throws IOException {
System.out.printf("[%s] write %d bytes from offset %d%n", tag, len, off);
super.write(b, off, len);
}
}
使用方式:new LogOutputStream(new FileOutputStream("data.txt"), "FILE")。每次调用 write 都会先输出日志,再真正落盘。
当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。
立即学习“Java免费学习笔记(深入)”;
注意事项与常见陷阱
-
不要忽略 flush() 和 close():如果自定义逻辑涉及缓冲(如加密块处理),需重写
flush()确保剩余数据写出;close()通常应调用super.close()释放底层资源 -
避免在 write 中抛出未检查异常:FilterOutputStream 的 write 声明抛出
IOException,自定义逻辑出错应封装为IOException而非RuntimeException - 慎用 synchronized:FilterOutputStream 本身不是线程安全的,若需多线程写入,应在外部同步,或在自定义类中明确加锁(注意性能影响)
-
别绕过 super.write:除非你完全接管写入(如只记录不输出),否则漏掉对
super.write的调用会导致数据丢失
进阶思路:组合多个 FilterOutputStream
FilterOutputStream 支持链式包装。例如:把原始数据先用 CipherOutputStream(JDK 提供)加密,再用自定义的 LogOutputStream 记录,最后写入文件:
OutputStream fileOut = new FileOutputStream("secret.dat");
OutputStream cipherOut = new CipherOutputStream(fileOut, cipher);
OutputStream logOut = new LogOutputStream(cipherOut, "ENCRYPTED");
logOut.write(data); // 日志 → 加密 → 文件
这种组合方式体现了装饰器模式的灵活性,各层职责清晰,易于复用和测试。

















