FileInputStream和FileOutputStream詳解


一.引子
  文件,作為常見的數據源。關於操作文件的字節流就是 FileInputStream & FileOutputStream。它們是Basic IO字節流中重要的實現類。
二、FileInputStream源碼分析

  FileInputStream源碼如下:

/**
 * FileInputStream 從文件系統的文件中獲取輸入字節流。文件取決於主機系統。
 *  比如讀取圖片等的原始字節流。如果讀取字符流,考慮使用 FiLeReader。
 */
public class FileInputStream extends InputStream{
    /* 文件描述符類---此處用於打開文件的句柄 */
    private final FileDescriptor fd;
    /* 引用文件的路徑 */
    private final String path; 
    /* 文件通道,NIO部分 */
    private FileChannel channel = null;
    private final Object closeLock = new Object();
    private volatile boolean closed = false;
 
    private static final ThreadLocal<Boolean> runningFinalize =
        new ThreadLocal<>();
 
    private static boolean isRunningFinalize() {
        Boolean val;
        if ((val = runningFinalize.get()) != null)
            return val.booleanValue();
        return false;
    }
 
    /* 通過文件路徑名來創建FileInputStream */
    public FileInputStream(String name) throws FileNotFoundException {
        this(name != null ? new File(name) : null);
    }
 
    /* 通過文件來創建FileInputStream */
    public FileInputStream(File file) throws FileNotFoundException {
        String name = (file != null ? file.getPath() : null);
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkRead(name);
        }
        if (name == null) {
            throw new NullPointerException();
        }
        if (file.isInvalid()) {
            throw new FileNotFoundException("Invalid file path");
        }
        fd = new FileDescriptor();
        fd.incrementAndGetUseCount();
        this.path = name;
        open(name);
    }
 
    /* 通過文件描述符類來創建FileInputStream */
    public FileInputStream(FileDescriptor fdObj) {
        SecurityManager security = System.getSecurityManager();
        if (fdObj == null) {
            throw new NullPointerException();
        }
        if (security != null) {
            security.checkRead(fdObj);
        }
        fd = fdObj;
        path = null;
        fd.incrementAndGetUseCount();
    }
 
    /* 打開文件,為了下一步讀取文件內容。native方法 */
    private native void open(String name) throws FileNotFoundException;
 
    /* 從此輸入流中讀取一個數據字節 */
    public int read() throws IOException {
        Object traceContext = IoTrace.fileReadBegin(path);
        int b = 0;
        try {
            b = read0();
        } finally {
            IoTrace.fileReadEnd(traceContext, b == -1 ? 0 : 1);
        }
        return b;
    }
 
    /* 從此輸入流中讀取一個數據字節。native方法 */
    private native int read0() throws IOException;
 
    /* 從此輸入流中讀取多個字節到byte數組中。native方法 */
    private native int readBytes(byte b[], int off, int len) throws IOException;
 
    /* 從此輸入流中讀取多個字節到byte數組中。 */
    public int read(byte b[]) throws IOException {
        Object traceContext = IoTrace.fileReadBegin(path);
        int bytesRead = 0;
        try {
            bytesRead = readBytes(b, 0, b.length);
        } finally {
            IoTrace.fileReadEnd(traceContext, bytesRead == -1 ? 0 : bytesRead);
        }
        return bytesRead;
    }
 
    /* 從此輸入流中讀取最多len個字節到byte數組中。 */
    public int read(byte b[], int off, int len) throws IOException {
        Object traceContext = IoTrace.fileReadBegin(path);
        int bytesRead = 0;
        try {
            bytesRead = readBytes(b, off, len);
        } finally {
            IoTrace.fileReadEnd(traceContext, bytesRead == -1 ? 0 : bytesRead);
        }
        return bytesRead;
    }
 
     
    public native long skip(long n) throws IOException;
 
    /* 返回下一次對此輸入流調用的方法可以不受阻塞地從此輸入流讀取(或跳過)的估計剩余字節數。 */
    public native int available() throws IOException;
 
    /* 關閉此文件輸入流並釋放與此流有關的所有系統資源。 */
    public void close() throws IOException {
        synchronized (closeLock) {
            if (closed) {
                return;
            }
            closed = true;
        }
        if (channel != null) {
           fd.decrementAndGetUseCount();
           channel.close();
        }
 
        int useCount = fd.decrementAndGetUseCount();
 
        if ((useCount <= 0) || !isRunningFinalize()) {
            close0();
        }
    }
 
    public final FileDescriptor getFD() throws IOException {
        if (fd != null) return fd;
        throw new IOException();
    }
 
    /* 獲取此文件輸入流的唯一FileChannel對象 */
    publicFileChannel getChannel() {
        synchronized(this) {
            if(channel == null) {
                channel = FileChannelImpl.open(fd, path, true, false, this);
                fd.incrementAndGetUseCount();
            }
            returnchannel;
        }
    }
 
    privatestaticnativevoidinitIDs();
 
    privatenativevoidclose0() throwsIOException;
 
    static{
        initIDs();
    }
 
    protected void finalize() throws IOException {
        if((fd != null) &&  (fd != FileDescriptor.in)) {
            runningFinalize.set(Boolean.TRUE);
            try{
                close();
            } finally{
                runningFinalize.set(Boolean.FALSE);
            }
        }
    }
}
View Code

1. 三個核心方法

  三個核心方法,也就是Override(重寫)了抽象類InputStream的read方法。int read() 方法,即

    public int read() throws IOException

  代碼實現中很簡單,一個try中調用本地native的read0()方法,直接從文件輸入流中讀取一個字節。IoTrace.fileReadEnd(),字面意思是防止文件沒有關閉讀的通道,導致讀文件失敗,一直開着讀的通道,會造成內存泄露。

  int read(byte b[]) 方法,即

    public int read(byte b[]) throws IOException

  代碼實現也是比較簡單的,也是一個try中調用本地native的readBytes()方法,直接從文件輸入流中讀取最多b.length個字節到byte數組b中。

  int read(byte b[], int off, int len) 方法,即

    public int read(byte b[], int off, int len) throws IOException

  代碼實現和 int read(byte b[])方法 一樣,直接從文件輸入流中讀取最多len個字節到byte數組b中。
2. 值得一提的native方法
  上面核心方法中為什么實現簡單,因為工作量都在native方法里面,即JVM里面實現了。native倒是不少一一列舉吧:

    native void open(String name) // 打開文件,為了下一步讀取文件內容

    native int read0() // 從文件輸入流中讀取一個字節

    native int readBytes(byte b[], int off, int len) // 從文件輸入流中讀取,從off句柄開始的len個字節,並存儲至b字節數組內。

    native void close0() // 關閉該文件輸入流及涉及的資源,比如說如果該文件輸入流的FileChannel對被獲取后,需要對FileChannel進行close。

  其他還有值得一提的就是,在jdk1.4中,新增了NIO包,優化了一些IO處理的速度,所以在FileInputStream和FileOutputStream中新增了FileChannel getChannel()的方法。即獲取與該文件輸入流相關的 java.nio.channels.FileChannel對象。

FileOutputStream 源碼如下:

/**
 * 文件輸入流是用於將數據寫入文件或者文件描述符類
 *  比如寫入圖片等的原始字節流。如果寫入字符流,考慮使用 FiLeWriter。
 */
publicclassSFileOutputStream extendsOutputStream{
    /* 文件描述符類---此處用於打開文件的句柄 */
    private final FileDescriptor fd;
    /* 引用文件的路徑 */
    private final String path;
    /* 如果為 true,則將字節寫入文件末尾處,而不是寫入文件開始處 */
    private final boolean append;
    /* 關聯的FileChannel類,懶加載 */
    private FileChannel channel;
    private final Object closeLock = new Object();
    private volatile boolean closed = false;
    private static final ThreadLocal<Boolean> runningFinalize =
        new ThreadLocal<>();
 
    private static boolean isRunningFinalize() {
        Boolean val;
        if ((val = runningFinalize.get()) != null)
            return val.booleanValue();
        return false;
    }
 
    /* 通過文件名創建文件輸入流 */
    public FileOutputStream(String name) throws FileNotFoundException {
        this(name != null ? new File(name) : null, false);
    }
 
    /* 通過文件名創建文件輸入流,並確定文件寫入起始處模式 */
    public FileOutputStream(String name, boolean append)
        throws FileNotFoundException
    {
        this(name != null ? new File(name) : null, append);
    }
 
    /* 通過文件創建文件輸入流,默認寫入文件的開始處 */
    public FileOutputStream(File file) throws FileNotFoundException {
        this(file, false);
    }
 
    /* 通過文件創建文件輸入流,並確定文件寫入起始處  */
    public FileOutputStream(File file, boolean append)
        throws FileNotFoundException
    {
        String name = (file != null ? file.getPath() : null);
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkWrite(name);
        }
        if (name == null) {
            throw new NullPointerException();
        }
        if (file.isInvalid()) {
            throw new FileNotFoundException("Invalid file path");
        }
        this.fd = new FileDescriptor();
        this.append = append;
        this.path = name;
        fd.incrementAndGetUseCount();
        open(name, append);
    }
 
    /* 通過文件描述符類創建文件輸入流 */
    public FileOutputStream(FileDescriptor fdObj) {
        SecurityManager security = System.getSecurityManager();
        if (fdObj == null) {
            throw new NullPointerException();
        }
        if (security != null) {
            security.checkWrite(fdObj);
        }
        this.fd = fdObj;
        this.path = null;
        this.append = false;
 
        fd.incrementAndGetUseCount();
    }
 
    /* 打開文件,並確定文件寫入起始處模式 */
    private native void open(String name, boolean append)
        throws FileNotFoundException;
 
    /* 將指定的字節b寫入到該文件輸入流,並指定文件寫入起始處模式 */
    private native void write(int b, boolean append) throws IOException;
 
    /* 將指定的字節b寫入到該文件輸入流 */
    public void write(int b) throws IOException {
        Object traceContext = IoTrace.fileWriteBegin(path);
        int bytesWritten = 0;
        try {
            write(b, append);
            bytesWritten = 1;
        } finally {
            IoTrace.fileWriteEnd(traceContext, bytesWritten);
        }
    }
 
    /* 將指定的字節數組寫入該文件輸入流,並指定文件寫入起始處模式 */
    private native void writeBytes(byte b[], int off, int len, boolean append)
        throws IOException;
 
    /* 將指定的字節數組b寫入該文件輸入流 */
    public void write(byte b[]) throws IOException {
        Object traceContext = IoTrace.fileWriteBegin(path);
        int bytesWritten = 0;
        try {
            writeBytes(b, 0, b.length, append);
            bytesWritten = b.length;
        } finally {
            IoTrace.fileWriteEnd(traceContext, bytesWritten);
        }
    }
 
    /* 將指定len長度的字節數組b寫入該文件輸入流 */
    public void write(byte b[], int off, int len) throws IOException {
        Object traceContext = IoTrace.fileWriteBegin(path);
        int bytesWritten = 0;
        try {
            writeBytes(b, off, len, append);
            bytesWritten = len;
        } finally {
            IoTrace.fileWriteEnd(traceContext, bytesWritten);
        }
    }
 
    /* 關閉此文件輸出流並釋放與此流有關的所有系統資源 */
    publicvoidclose() throwsIOException {
        synchronized(closeLock) {
            if(closed) {
                return;
            }
            closed = true;
        }
 
        if(channel != null) {
            fd.decrementAndGetUseCount();
            channel.close();
        }
 
        intuseCount = fd.decrementAndGetUseCount();
 
        if((useCount <= 0) || !isRunningFinalize()) {
            close0();
        }
    }
 
     public final FileDescriptor getFD()  throws IOException {
        if(fd != null) returnfd;
        thrownewIOException();
     }
 
    publicFile Channel getChannel() {
        synchronized(this) {
            if(channel == null) {
                channel = FileChannelImpl.open(fd, path, false, true, append, this);
 
                fd.incrementAndGetUseCount();
            }
            returnchannel;
        }
    }
 
    protected void finalize() throws IOException {
        if(fd != null) {
            if(fd == FileDescriptor.out || fd == FileDescriptor.err) {
                flush();
            } else{
 
                runningFinalize.set(Boolean.TRUE);
                try{
                    close();
                } finally{
                    runningFinalize.set(Boolean.FALSE);
                }
            }
        }
    }
 
    private native void close0() throws IOException;
 
    private static native void initIDs();
 
    static{
        initIDs();
    }
 
}
View Code

1. 三個核心方法

  三個核心方法,也就是Override(重寫)了抽象類OutputStream的write方法。void write(int b) 方法,即

    public void write(intb) throws IOException

  代碼實現中很簡單,一個try中調用本地native的write()方法,直接將指定的字節b寫入文件輸出流。IoTrace.fileReadEnd()的意思和上面FileInputStream意思一致。
  void write(byte b[]) 方法,即

    public void write(byteb[]) throws IOException

  代碼實現也是比較簡單的,也是一個try中調用本地native的writeBytes()方法,直接將指定的字節數組寫入該文件輸入流。

  void write(byte b[], int off, int len) 方法,即

    public void write(byte b[], int off, int len) throws IOException
  代碼實現和 void write(byte b[]) 方法 一樣,直接將指定的字節數組寫入該文件輸入流。
2. 值得一提的native方法

  上面核心方法中為什么實現簡單,因為工作量都在native方法里面,即JVM里面實現了。native倒是不少一一列舉吧:

    native void open(String name) // 打開文件,為了下一步讀取文件內容

    native void write(int b, boolean append) // 直接將指定的字節b寫入文件輸出流

    native native void writeBytes(byte b[], int off, int len, boolean append) // 直接將指定的字節數組寫入該文件輸入流。

    native void close0() // 關閉該文件輸入流及涉及的資源,比如說如果該文件輸入流的FileChannel對被獲取后,需要對FileChannel進行close。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM