InputStream中通过mark和reset方法重复利用缓存

时间：2023-03-09 19:55:28
InputStream中通过mark和reset方法重复利用缓存
通过缓存InputStream可重复利用一个InputStream，但是要缓存一整个InputStream内存压力可能是比较大的。如果第一次读取InputStream是用来判断文件流类型，文件编码等用的，往往不需要所有的InputStream的数据，或许只需要前n个字节，这样一来，缓存一整个InputStream实际上也是一种浪费。 

其实InputStream本身提供了三个接口： 
第一个，InputStream是否支持mark，默认不支持。
  1. public boolean markSupported() {
  2. return false;
  3. }

第二个，mark接口。该接口在InputStream中默认实现不做任何事情。

  1. public synchronized void mark(int readlimit) {}

第三个，reset接口。该接口在InputStream中实现，调用就会抛异常。

  1. public synchronized void reset() throws IOException {
  2. throw new IOException("mark/reset not supported");
  3. }

从三个接口定义中可以看出，首先InputStream默认是不支持mark的，子类需要支持mark必须重写这三个方法。 
第一个接口很简单，就是标明该InputStream是否支持mark。 

调用mark方法会记下当前调用mark方法的时刻，InputStream被读到的位置。 
调用reset方法就会回到该位置。 
举个简单的例子：

  1. String content = "BoyceZhang!";
  2. InputStream inputStream = new ByteArrayInputStream(content.getBytes());
  3. // 判断该输入流是否支持mark操作
  4. if (!inputStream.markSupported()) {
  5. System.out.println("mark/reset not supported!");
  6. }
  7. int ch;
  8. boolean marked = false;
  9. while ((ch = inputStream.read()) != -1) {
  10. //读取一个字符输出一个字符
  11. System.out.print((char)ch);
  12. //读到 'e'的时候标记一下
  13. if (((char)ch == 'e')& !marked) {
  14. inputStream.mark(content.length());  //先不要理会mark的参数
  15. marked = true;
  16. }
  17. //读到'!'的时候重新回到标记位置开始读
  18. if ((char)ch == '!' && marked) {
  19. inputStream.reset();
  20. marked = false;
  21. }
  22. }
  23. //程序最终输出：BoyceZhang!Zhang!

看了这个例子之后对mark和reset接口有了很直观的认识。 
mark接口的参数readlimit作用 
我们知道InputStream是不支持mark的。要想支持mark子类必须重写这三个方法，我想说的是不同的实现子类，mark的参数readlimit作用不尽相同。 
常用的FileInputStream不支持mark。 
1. 对于BufferedInputStream，readlimit表示：InputStream调用mark方法的时刻起，在读取readlimit个字节之前，标记的该位置是有效的。如果读取的字节数大于readlimit，可能标记的位置会失效。 

在BufferedInputStream的read方法源码中有这么一段：

  1. } else if (buffer.length >= marklimit) {
  2. markpos = -1;   /* buffer got too big, invalidate mark */
  3. pos = 0;        /* drop buffer contents */
  4. } else {            /* grow buffer */

为什么是可能会失效呢？ 
因为BufferedInputStream读取不是一个字节一个字节读取的，是一个字节数组一个字节数组读取的。 
例如，readlimit=35，第一次比较的时候buffer.length=0（没开始读）<readlimit 
然后buffer数组一次读取48个字节。这时的read方法只会简单的挨个返回buffer数组中的字节，不会做这次比较。直到读到buffer数组最后一个字节（第48个）后，才重新再次比较。这时如果我们读到buffer中第47个字节就reset。mark仍然是有效的。虽然47>35。 

2. 对于InputStream的另外一个实现类：ByteArrayInputStream，我们发现readlimit参数根本就没有用，调用mark方法的时候写多少都无所谓。

  1. public void mark(int readAheadLimit) {
  2. mark = pos;
  3. }
  4. public synchronized void reset() {
  5. pos = mark;
  6. }

因为对于ByteArrayInputStream来说，都是通过字节数组创建的，内部本身就保存了整个字节数组，mark只是标记一下数组下标位置，根本不用担心mark会创建太大的buffer字节数组缓存。 

3. 其他的InputStream子类没有去总结。原理都是一样的。 

所以由于mark和reset方法配合可以记录并回到我们标记的流的位置重新读流，很大一部分就可以解决我们的某些重复读的需要。 
这种方式的优点很明显：不用缓存整个InputStream数据。对于ByteArrayInputStream甚至没有任何的内存开销。 
当然这种方式也有缺点：就是需要通过干扰InputStream的读取细节，也相对比较复杂。