「深入理解Java I/O：FilterInputStream」

  咦咦咦，各位小可爱，我是你们的好伙伴——bug菌，今天又来给大家普及Java之IO流啦，别躲起来啊，听我讲干货还不快点赞，赞多了我就有动力讲得更嗨啦！所以呀，养成先点赞后阅读的好习惯，别被干货淹没了哦~

🏆本文收录于「滚雪球学Java」专栏，专业攻坚指数级提升，助你一臂之力，带你早日登顶🚀，欢迎大家关注&&收藏！持续更新中，up！up！up！！

环境说明：Windows 10 + IntelliJ IDEA 2021.3.2 + Jdk 1.8

前言

  Java I/O 是 Java 编程语言的核心功能之一，提供了丰富的输入输出操作。在 Java I/O 中，FilterInputStream 是一个非常有用的类，它允许对输入流进行装饰，以增强其功能。本文将深入讲解 FilterInputStream 的实现原理以及在实际开发中的应用。

摘要

  FilterInputStream 是 InputStream 的子类，它提供了对输入流的装饰功能，可以通过组合多个 FilterInputStream 对输入流进行多层装饰，以实现更加复杂的功能。

  本文将详细介绍 FilterInputStream 的原理以及如何使用它进行输入流装饰。

FilterInputStream

FilterInputStream 的原理

  FilterInputStream 接收一个 InputStream 对象并提供了对输入流的装饰功能。它包装了一个现有的 InputStream 并向其添加一些额外的功能。FilterInputStream 的所有方法都委托给其被包装的 InputStream 对象。在装饰过程中，我们可以在方法调用前或调用后进行一些额外的操作。

  每个 FilterInputStream 子类都需要实现至少四种方法：read()、read(byte[] b, int off, int len)、skip(long n) 和 available()。这些方法应该根据被装饰的 InputStream 的规范进行实现。

FilterInputStream 的应用

  在实际开发中，我们可以通过 FilterInputStream 对输入流进行装饰，以增强其功能。例如，在读取文件时，我们可以使用 FileInputStream 作为基础输入流：

FileInputStream fileInputStream = new FileInputStream("./template/hello.txt");

  如果需要读取加密文件，则可以使用 CipherInputStream 对 FileInputStream 进行装饰：

Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding");
cipher.init(Cipher.DECRYPT_MODE, key);
CipherInputStream cis = new CipherInputStream(fis, cipher);

  通过 CipherInputStream，我们可以使用 Java Cryptography Extension (JCE) 进行文件解密。

  在实际开发中，我们还可以实现自定义的 FilterInputStream，以扩展 InputStream 的功能。例如，在读取文件时，我们可以实现自定义的 FilterInputStream，以统计文件读取的字节数：

package com.example.javase.io.filterInputStream;

import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;

/**
 * @author bug菌
 * @version 1.0
 * @date 2023/10/13 17:01
 */
public class CountingInputStream extends FilterInputStream {
    private long count = 0;

    public CountingInputStream(InputStream in) {
        super(in);
    }

    public int read() throws IOException {
        int b = super.read();
        if (b != -1) {
            this.count++;
        }
        return b;
    }

    public int read(byte[] b, int off, int len) throws IOException {
        int n = super.read(b, off, len);
        if (n != -1) {
            this.count += n;
        }
        return n;
    }

    public long skip(long n) throws IOException {
        long skip = super.skip(n);
        this.count += skip;
        return skip;
    }

    public long getCount() {
        return count;
    }
}

代码分析：

  如上代码实现了一个名为CountingInputStream的类，它是FilterInputStream的子类，表示一个计数输入流，可以记录输入流读取的字节数。该类中有三个方法分别是read()、read(byte[] b, int off, int len)和skip(long n)，这些方法都通过调用父类FilterInputStream的相应方法实现了读取数据，并在读取的过程中记录读取的字节数。同时还有一个getCount()方法，可以返回当前已读取的字节数。其中，read()方法每次读取一个字节，并递增计数；read(byte[] b, int off, int len)方法每次读取指定长度的字节数组，并递增计数；skip(long n)方法是跳过指定字节数并记录已跳过的字节数。

  通过 CountingInputStream，我们可以统计读取文件的字节数：

CountingInputStream cis = new CountingInputStream(new FileInputStream("test.txt"));
byte[] buffer = new byte[1024];
int bytesRead = 0;
while ((bytesRead = cis.read(buffer)) != -1) {
    // process buffer
}
long count = cis.getCount();

测试用例演示

测试代码

  为了验证 FilterInputStream 的实现原理和应用效果，我们编写了以下测试用例：

package com.example.javase.io.filterInputStream;

import java.io.*;

/**
 * @author bug菌
 * @version 1.0
 * @date 2023/10/13 16:51
 */
public class FilterInputStreamDemo {

    public static void main(String[] args) throws IOException {
        // create file
        File file = new File("./template/hello.txt");
        FileOutputStream fos = new FileOutputStream(file);
        fos.write("hello world".getBytes());
        fos.close();

        // create counting input stream
        CountingInputStream cis = new CountingInputStream(new FileInputStream(file));

        // read input stream
        byte[] buffer = new byte[1024];
        int bytesRead = 0;
        while ((bytesRead = cis.read(buffer)) != -1) {
            // process buffer
        }
        // verify count
        System.out.println(cis.getCount());

        // delete file
        file.delete();
    }
}

  该测试用例创建一个文件，使用 CountingInputStream 统计文件读取的字节数，并验证结果是否正确。

代码解析

  如上测试用例是一个使用Java IO中的FilterInputStream实现计数器的例子。

  首先，代码创建了一个文件，并向其中写入了hello world字符串。接着，通过FileInputStream读取文件，并将其传递给CountingInputStream构造函数，这样CountingInputStream就能够在读取文件时计数。

  在while循环中，每次读取文件时都会读取到buffer数组中，然后可以在这里对buffer做一些处理。当读取到文件末尾时，read方法返回-1，循环结束。

  在循环结束后，可以通过调用CountingInputStream对象的getCount()方法来获取读取的字节数，并输出到控制台。

最后，代码删除了创建的文件。

测试结果

测试用例执行结果如下:

  成功的通过getCount()方法读取了文件内容的字节数，并输出到控制台。你们也可以动手核算下hello world字符串是否为11个字节数。

FilterInputStream 的注意事项

在使用 FilterInputStream 进行输入流装饰时，需要注意以下几点：

• FilterInputStream 的子类必须覆盖 InputStream 的所有方法，并根据被装饰的 InputStream 的规范进行实现。
• FilterInputStream 是线程安全的，可以被多个线程同时使用。
• FilterInputStream 可以被多层装饰，以实现更加复杂的功能。
• FilterInputStream 的性能可能会受到影响，特别是在多层装饰时，应该评估性能。

小结

  本文深入讲解了 FilterInputStream 的实现原理以及在实际开发中的应用。我们学习了 FilterInputStream 的类结构、装饰原理、应用示例、测试用例以及注意事项。希望本文能够对读者深入理解 Java I/O 以及 FilterInputStream 的使用有所帮助。

附录源码

  如上涉及所有源码均已上传同步在「Gitee」，提供给同学们一对一参考学习，辅助你更迅速的掌握。

总结

  Java I/O 是 Java 编程语言的核心功能之一，提供了丰富的输入输出操作。FilterInputStream 是一个非常有用的类，它提供了对输入流的装饰功能，可以通过组合多个 FilterInputStream 对输入流进行多层装饰，以实现更加复杂的功能。在实际开发中，我们可以实现自定义的 FilterInputStream，以扩展 InputStream 的功能。在使用 FilterInputStream 进行输入流装饰时，需要注意性能问题。

... ...

  ok，以上就是我这期的全部内容啦，如果还想学习更多，你可以看看如下的往期热文推荐哦，每天积累一个奇淫小知识，日积月累下去，你一定能成为令人敬仰的大佬。

「赠人玫瑰，手留余香」，咱们下期拜拜~~

☀️建议/推荐你

  无论你是计算机专业的学生，还是对编程有兴趣的小伙伴，都建议直接毫无顾忌的学习此专栏「滚雪球学Java」，bug菌郑重承诺，凡是学习此专栏的同学，均能获取到所需的知识和技能，全网最快速入门Java编程，就像滚雪球一样，越滚越大，指数级提升。

  最后，如果这篇文章对你有所帮助，帮忙给作者来个一键三连，关注、点赞、收藏，您的支持就是我坚持写作最大的动力。

  同时欢迎大家关注公众号:「猿圈奇妙屋」 ，以便学习更多同类型的技术文章，免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板、技术文章Markdown文档等海量资料。

📣关于我

我是bug菌，CSDN | 掘金 | infoQ | 51CTO 等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，华为云 | 阿里云| 腾讯云等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。