FileDescriptor詳解

FileDescriptor 介紹

FileDescriptor 是“文件描述符”。
FileDescriptor 可以被用來表示開放文件、開放套接字等。
以FileDescriptor表示文件來說：當FileDescriptor表示某文件時，我們可以通俗的將FileDescriptor看成是該文件。但是，我們不能直接通過FileDescriptor對該文件進行操作；若需要通過FileDescriptor對該文件進行操作，則需要新創建FileDescriptor對應的FileOutputStream，再對文件進行操作。

in, out, err介紹

(01) in  -- 標準輸入(鍵盤)的描述符
(02) out -- 標準輸出(屏幕)的描述符
(03) err -- 標準錯誤輸出(屏幕)的描述符

它們3個的原理和用法都類似，下面我們通過out來進行深入研究。

 

out 的作用和原理

out是標準輸出(屏幕)的描述符。但是它有什麼作用呢？
我們可以通俗理解，out就代表了標準輸出(屏幕)。若我們要輸出信息到屏幕上，即可通過out來進行操作；但是，out又沒有提供輸出信息到屏幕的接口(因爲out本質是FileDescriptor對象，而FileDescriptor沒有輸出接口)。怎麼辦呢？
很簡單，我們創建out對應的“輸出流對象”，然後通過“輸出流”的write()等輸出接口就可以將信息輸出到屏幕上。如下代碼：

try {
    FileOutputStream out = new FileOutputStream(FileDescriptor.out);
    out.write('A');
    out.close();
} catch (IOException e) {
}

執行上面的程序，會在屏幕上輸出字母'A'。

爲了方便我們操作，java早已爲我們封裝好了“能方便的在屏幕上輸出信息的接口”：通過System.out，我們能方便的輸出信息到屏幕上。
因此，我們可以等價的將上面的程序轉換爲如下代碼：
System.out.print('A');

 

下面講講上面兩段代碼的原理
查看看out的定義。它的定義在FileDescriptor.java中，相關源碼如下：

public final class FileDescriptor {

    private int fd;

    public static final FileDescriptor out = new FileDescriptor(1);
    
    private FileDescriptor(int fd) {
        this.fd = fd;
        useCount = new AtomicInteger();
    }

    ...
}

從中，可以看出
(01) out就是一個FileDescriptor對象。它是通過構造函數FileDescriptor(int fd)創建的。
(02) FileDescriptor(int fd)的操作：就是給fd對象(int類型)賦值，並新建一個使用計數變量useCount。
fd對象是非常重要的一個變量，“fd=1”就代表了“標準輸出”，“fd=0”就代表了“標準輸入”，“fd=2”就代表了“標準錯誤輸出”。

FileOutputStream out = new FileOutputStream(FileDescriptor.out); 就是利用構造函數FileOutputStream(FileDescriptor fdObj)來創建“Filed.out對應的FileOutputStream對象”。

關於System.out是如何定義的。可以參考" 深入瞭解System.out.println("hello world"); "
TODO

通過上面的學習，我們知道，我們可以自定義標準的文件描述符[即，in(標準輸入),out(標準輸出),err(標準錯誤輸出)]的流，從而完成輸入/輸出功能；但是，java已經爲我們封裝好了相應的接口，即我們可以更方便的System.in, System.out, System.err去使用它們。
另外，我們也可以自定義“文件”、“Socket”等的文件描述符，進而對它們進行操作。參考下面示例代碼中的testWrite(), testRead()等接口。

 

示例代碼

源碼如下(FileDescriptorTest.java)： 

 1 import java.io.PrintStream;
 2 import java.io.FileDescriptor;
 3 import java.io.FileInputStream;
 4 import java.io.FileOutputStream;
 5 import java.io.IOException;
 6 
 7 /**
 8  * FileDescriptor 測試程序
 9  *
10  * @author skywang
11  */
12 public class FileDescriptorTest {
13 
14     private static final String FileName = "file.txt";
15     private static final String OutText = "Hi FileDescriptor";
16     public static void main(String[] args) {
17         testWrite();
18         testRead();
19 
20         testStandFD() ;
21         //System.out.println(OutText);
22     }
23 
24     /**
25      * FileDescriptor.out 的測試程序
26      *
27      * 該程序的效果 等價於 System.out.println(OutText);
28      */
29     private static void testStandFD() {
30         // 創建FileDescriptor.out 對應的PrintStream
31         PrintStream out = new PrintStream(
32                 new FileOutputStream(FileDescriptor.out));
33         // 在屏幕上輸出“Hi FileDescriptor”
34         out.println(OutText);
35         out.close();
36     }
37 
38     /**
39      * FileDescriptor寫入示例程序
40      * 
41      * (01) 爲了說明，"通過文件名創建FileOutputStream"與“通過文件描述符創建FileOutputStream”對象是等效的
42      * (02) 該程序會在“該源文件”所在目錄新建文件"file.txt"，並且文件內容是"Aa"。
43      */
44     private static void testWrite() {
45         try {
46             // 新建文件“file.txt”對應的FileOutputStream對象
47             FileOutputStream out1 = new FileOutputStream(FileName);
48             // 獲取文件“file.txt”對應的“文件描述符”
49             FileDescriptor fdout = out1.getFD();
50             // 根據“文件描述符”創建“FileOutputStream”對象
51             FileOutputStream out2 = new FileOutputStream(fdout);
52 
53             out1.write('A');    // 通過out1向“file.txt”中寫入'A'
54             out2.write('a');    // 通過out2向“file.txt”中寫入'A'
55 
56             if (fdout!=null)
57                 System.out.printf("fdout(%s) is %s\n",fdout, fdout.valid());
58 
59             out1.close();
60             out2.close();
61 
62         } catch(IOException e) {
63             e.printStackTrace();
64         }
65     }
66 
67     /**
68      * FileDescriptor讀取示例程序
69      *
70      * 爲了說明，"通過文件名創建FileInputStream"與“通過文件描述符創建FileInputStream”對象是等效的
71      */
72     private static void testRead() {
73         try {
74             // 新建文件“file.txt”對應的FileInputStream對象
75             FileInputStream in1 = new FileInputStream(FileName);
76             // 獲取文件“file.txt”對應的“文件描述符”
77             FileDescriptor fdin = in1.getFD();
78             // 根據“文件描述符”創建“FileInputStream”對象
79             FileInputStream in2 = new FileInputStream(fdin);
80 
81             System.out.println("in1.read():"+(char)in1.read());
82             System.out.println("in2.read():"+(char)in2.read());
83 
84             if (fdin!=null)
85                 System.out.printf("fdin(%s) is %s\n", fdin, fdin.valid());
86 
87             in1.close();
88             in2.close();
89         } catch(IOException e) {
90             e.printStackTrace();
91         }
92     }
93 }

運行結果：

fdout(java.io.FileDescriptor@2b820dda) is true
in1.read():A
in2.read():a
fdin(java.io.FileDescriptor@675b7986) is true
Hi FileDescriptor