InputStream源码分析

  1 /**
  2  * 该抽象类是所有字节输入流的超类。
  3  */
  4 public abstract class InputStream implements Closeable {
  5 
  6     // 该变量用于确定在skip方法中使用的最大缓存数组大小。
  7     private static final int MAX_SKIP_BUFFER_SIZE = 2048;
  8 
  9     /**
 10      * 从输入流中读取下一字节数据。返回的字节值为一个范围在0-255之间的int数。若由于到达流的尾部而没有字节可获取，则返回-1.
 11      * 直到数据可达，检测到流的末尾或者抛出一个异常，该方法才停止。
 12      *
 13      * @return     下一个字节，若到达输入流结尾，则返回-1.
 14      * @exception  IOException  if an I/O error occurs.
 15      */
 16     public abstract int read() throws IOException;
 17 
 18     /**
 19      * 从输入流中读取一些字节并将它们存储到缓存数组b中。
 20      * 若b的长度为0，则没有字节被读取，返回0；若由于流在文件的尾部，没有字节可读，则返回-1。
 21      * 读取的第一个字节保存到b[0]，下一个保存到b[1]，以此类推。读取字节的数组小于等于数组b的长度。
 22      * 
 23      * @param      b   缓存所读取的数据
 24      * @return     读取字节数到缓存的数目。由于到达流的结尾而不可读取数据时，返回-1.
 25      * @exception  IOException  若输入流已经关闭或者其他I/O错误发生所导致第一个字节不能被读取而抛出的异常。不考虑到达文件尾部的情况。
 26      * @exception  NullPointerException  b==null的情况
 27      * @see        java.io.InputStream#read(byte[], int, int)
 28      */
 29     public int read(byte b[]) throws IOException {
 30         return read(b, 0, b.length);
 31     }
 32 
 33     /**
 34      * 从输入流读取len个字节数据，并保存到数组中。读取的数组最多为len。真正读取的字节数目将作为返回值返回。
 35      * 若len=0，则没有字节需要读取，返回为0；若字节不可达，则返回-1。
 36      * 读取到的第一个字节保存到b[off]中，下一个保存在b[off+1]，以此类推。
 37      *
 38      * @param      b     缓存所读取的数据
 39      * @param      off   将读取的数据写入数组b的起始偏移地址
 40      * @param      len   读取的最大字节数组
 41      * @return     保存到buffer中真正的字节数，若由于到达流的结尾而无法读取数据，返回-1.
 42      * @exception  IOException If the first byte cannot be read for any reason
 43      * other than end of file, or if the input stream has been closed, or if
 44      * some other I/O error occurs.
 45      * @exception  NullPointerException b==null的情况.
 46      * @exception  IndexOutOfBoundsException 若off或len为负，或者len>b.length-off时，抛出该异常。
 47      * @see        java.io.InputStream#read()
 48      */
 49     public int read(byte b[], int off, int len) throws IOException {
 50         if (b == null) {
 51             throw new NullPointerException();
 52         } else if (off < 0 || len < 0 || len > b.length - off) {
 53             throw new IndexOutOfBoundsException();
 54         } else if (len == 0) {
 55             return 0;
 56         }
 57 
 58         int c = read();
 59         if (c == -1) {
 60             return -1;
 61         }
 62         b[off] = (byte)c;
 63 
 64         int i = 1;
 65         try {
 66             for (; i < len ; i++) {
 67                 c = read();
 68                 if (c == -1) {
 69                     break;
 70                 }
 71                 b[off + i] = (byte)c;
 72             }
 73         } catch (IOException ee) {
 74         }
 75         return i;
 76     }
 77 
 78     /**
 79      * 跳过输入流的n个字节的数据，并返回真正跳过的字节数目。若n为负，则没有字节被跳过。
 80      * 方法skip会创建一个字节数组，不断读取字节到该数组中，直到n个字节被读取或到达输入流的结尾。
 81      *
 82      * @param      n   被跳过的字节数目.
 83      * @return     真正被跳过的字节数目.
 84      * @exception  IOException  if the stream does not support seek,
 85      *                          or if some other I/O error occurs.
 86      */
 87     public long skip(long n) throws IOException {
 88 
 89         long remaining = n;
 90         int nr;
 91 
 92         if (n <= 0) {
 93             return 0;
 94         }
 95 
 96         int size = (int)Math.min(MAX_SKIP_BUFFER_SIZE, remaining);
 97         byte[] skipBuffer = new byte[size];
 98         while (remaining > 0) {
 99             nr = read(skipBuffer, 0, (int)Math.min(size, remaining));
100             if (nr < 0) {
101                 break;
102             }
103             remaining -= nr;
104         }
105 
106         return n - remaining;
107     }
108 
109     /**
110      * 返回一个可以在该输入流中读取（或跳过）的字节数的估计，而不阻塞此输入流的下一次调用。
111      *
112      * @return     an estimate of the number of bytes that can be read (or skipped
113      *             over) from this input stream without blocking or {@code 0} when
114      *             it reaches the end of the input stream.
115      * @exception  IOException if an I/O error occurs.
116      */
117     public int available() throws IOException {
118         return 0;
119     }
120 
121     /**
122      * 关闭输入流并释放与其相关的系统资源。
123      *
124      *
125      * @exception  IOException  if an I/O error occurs.
126      */
127     public void close() throws IOException {}
128 
129     /**
130      * 标记输入流中当前的位置。当调用reset方法可以回到上次标记的位置，使得后面可以重新读取相同的字节。
131      * 参数readlimit告诉输入流允许被读取的字节数目。超过该数目，则标记位失效（invalid）
132      *
133      * @param   readlimit   在标志位变为invalid之前，可被读取的最大字节数目.
134      * @see     java.io.InputStream#reset()
135      */
136     public synchronized void mark(int readlimit) {}
137 
138     /**
139      * 将流重定位到最后一次对此输入流调用mark方法时的位置。
140      * 当markSupported方法返回true，则
141      * 1、若mark方法自创建流以来从未被调用或者从流中读取的字节数目超过上次调用mark方法所定义的readlimit，则抛出IOException异常。
142      * 2、若未抛出IOException，则将该流重新设置为状态：最近一次调用mark后（若未调用过mark，则从文件开头开始）读取的所有字节重新提供
143      * 给read方法的后续调用者，如何从调用reset时起将作为下一输入数据的字节。
144      * 当markSupported方法返回false，则
145      * 1、调用reset方法会抛出IOException
146      * 2、若IOException未被抛出，则流将被重置到一个固定状态，该状态依赖于输入流的类型和被创建的方式。。。。
147      * The bytes that will be supplied to subsequent callers of the <code>read</code> method depend on the
148      * particular type of the input stream. 
149      *
150      * @exception  IOException  若流未被标记或者标记失效。
151      * @see     java.io.InputStream#mark(int)
152      * @see     java.io.IOException
153      */
154     public synchronized void reset() throws IOException {
155         throw new IOException("mark/reset not supported");
156     }
157 
158     /**
159      * 测试输入流是否支持test和reset方法。所支持的mark和reset是否是输入流实例的不变属性。
160      * InputStream的markSupported方法返回false。
161      *
162      * @return  若流实例支持mark和reset方法，返回true；否则返回false。
163      * @see     java.io.InputStream#mark(int)
164      * @see     java.io.InputStream#reset()
165      */
166     public boolean markSupported() {
167         return false;
168     }
169 
170 }