【NIO】FileChannel

阳光穿透心脏的1/2处 2022-05-31 09:35 276阅读 0赞

# 前言 #

Github：[https://github.com/yihonglei/jdk-source-code-reading][https_github.com_yihonglei_jdk-source-code-reading]（java-nio）

Java NIO中的FileChannel是一个连接到文件的通道。可以通过文件通道读写文件。

FileChannel无法设置为非阻塞模式，它总是运行在阻塞模式下。

# 一 打开FileChannel #

在使用FileChannel之前，必须先打开它。但是，我们无法直接打开一个FileChannel，

需要通过使用一个FileInputStream、FileOutputStream或RandomAccessFile来获取一个FileChannel实例。

FileInputStream fis = new FileInputStream("C:\\mycode\\hello.txt");
    
    FileChannel inChannel = fis.getChannel();

# 二 从FileChannel读取数据 #

读取数据使用read方法，read有如下重载方法:

*  abstract int read(ByteBuffer dst);
 *  long read(ByteBuffer\[\] dsts);
 *  abstract long read(ByteBuffer\[\] dsts, int offset, int length);
 *  abstract int read(ByteBuffer dst, long position);

调用read()重载方法之一从FileChannel中读取数据。如:

ByteBuffer buffer = ByteBuffer.allocate(48); // Buffer分配

int bytesRead = inChannel.read(buffer); // 从通道读取数据到Buffer(缓冲区)

首先，分配一个Buffer，从FileChannel中读取的数据将被读到Buffer中。

然后，调用FileChannel.read()重载方法之一。该方法将数据从FileChannel读取到Buffer中。

read()方法返回的int值表示了有多少字节被读到了Buffer中。如果返回-1，表示到了文件末尾。

# 三 向FileChannel写数据 #

写入数据使用write方法，write有如下重载方法:

*  abstract int write(ByteBuffer src);
 *  long write(ByteBuffer\[\] srcs);
 *  abstract long write(ByteBuffer\[\] srcs, int offset, int length);
 *  abstract int write(ByteBuffer src, long position);

使用FileChannel.write()方法向FileChannel写数据，该方法的参数是一个Buffer。如:

// 分配指定大小的缓冲区
    
    ByteBuffer buffer = ByteBuffer.allocate(48);
    
    // 写入到Buffer: 将通道中的数据读取到缓冲区中
    
    while (inChannel.read(buffer) != -1) {
    
        // 切换成数据模式
    
        buffer.flip();
    
        // 从Buffer读取: 将缓冲区中的数据写入到通道中
    
        outChannel.write(buffer);
    
        // 清空缓冲区
    
        buffer.clear();
    
    }

注意FileChannel.write()是在while循环中调用的。因为无法保证write()方法一次能向FileChannel写入多少字节，

因此需要重复调用write()方法，直到Buffer中已经没有尚未写入通道的字节。

# 四 关闭FileChannel #

用完FileChannel后必须将其关闭。如:

channel.close();

但是，一般不推荐使用close直接关闭，建议使用try-with-resources方式关闭。

# 五 FileChannel实例 #

通过FileChannel复制文件实例:

package com.jpeony.nio.buffer;
    
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.FileOutputStream;
    import java.io.IOException;
    import java.nio.ByteBuffer;
    import java.nio.channels.FileChannel;
    
    /**
     * 使用Buffer读写数据一般遵循以下四个步骤：
     * 1）写入数据到Buffer，一般有可以从Channel中读取到缓冲区，也可以调用put方法写入。
     * 2）调用flip()方法，切换数据模式。
     * 3）从Buffer中读取数据
     * 4）调用clear()方法或者compact()方法
     * 当向buffer写入数据时，buffer会记录下写了多少数据。一旦要读取数据，需要通过flip()方法将Buffer从写模式切换到读模式。
     * 在读模式下，可以读取之前写入到buffer的所有数据。一旦读完了所有的数据，就需要清空缓冲区，让它可以再次被写入。
     * <p>
     * 有两种方式能清空缓冲区：
     * 1）clear()方法会清空整个缓冲区。
     * 2）compact()方法只会清除已经读过的数据。任何未读的数据都被移到缓冲区的起始处，新写入的数据将放到缓冲区未读数据的后面。
     *
     * @author yihonglei
     */
    public class BufferRWTest {
        /**
         * 文件复制实例
         */
        public static void main(String[] args) {
            // 源文件
            File fromFile = new File("/Users/yihonglei/tmp/hello.txt");
            // 目标文件
            File toFile = new File("/Users/yihonglei/tmp/hello-copy.txt");
    
            try (
                    // 根据源文件创建文件输入流
                    FileInputStream fis = new FileInputStream(fromFile);
                    // 根据目标文件创建文件输出流，如果文件不存在，自动创建
                    FileOutputStream fos = new FileOutputStream(toFile);
    
                    // 1、获取通道
                    FileChannel inChannel = fis.getChannel();
                    FileChannel outChannel = fos.getChannel();
            ) {
                // 2、分配指定大小的缓冲区
                ByteBuffer buffer = ByteBuffer.allocate(48);
    
                // 3、将通道中的数据读取到缓冲区
                while (inChannel.read(buffer) != -1) {
                    // 切换成读数据模式
                    buffer.flip();
    
                    // 4、从缓冲区读取数据写入到通道中
                    outChannel.write(buffer);
    
                    // 5、清空缓冲区
                    buffer.clear();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

# 六 FileChannel的position方法 #

有时可能需要在FileChannel的某个特定位置进行数据的读/写操作。可以通过调用position()方法获取FileChannel的当前位置。

也可以通过调用position(long newPosition)方法设置FileChannel的当前位置。

例子:

long pos = channel.position(); // 获取读/写位置

channel.position(pos +123); // 设置读/写位置

如果将位置设置在文件结束符之后，然后试图从文件通道中读取数据，读方法将返回-1为文件结束标志。

如果将位置设置在文件结束符之后，然后向通道中写数据，文件将撑大到当前位置并写入数据。

这可能导致"文件空洞"，磁盘上物理文件中写入的数据间有空隙。

# 七 FileChannel的size方法 #

FileChannel实例的size()方法将返回该实例所关联文件的大小。如:

long fileSize = channel.size();