Java NIO 学习--FileChannel

Posted 2022-12-15 智公博客

一、概述

NIO 中FileChannel可以理解为一个连接到文件的通道，可以通过FileChannel对文件进行读写；
FileChannel没有非阻塞模式，读写都只有阻塞的方式；

二、通过FileChannel读写文件

首先，必须获取到文件的FileChannel,可以通过InputStream/OutStream、RandomAcessFile获取FileChannel对象：

RandomAccessFile fromFile = new RandomAccessFile("D:/tmp/NIO/fromFile.txt", "rw");
//获取channel
FileChannel fromChannel = fromFile.getChannel();

使用read方法从通道读取数据到缓冲区，使用write将缓冲区的数据写入到通道中；
对于资源文件，操作完都是需要关闭的；以下是一个完成读写实例代码：

public static void main(String[] args) throws IOException 
        RandomAccessFile fromFile = new RandomAccessFile("D:/tmp/NIO/fromFile.txt", "rw");
        RandomAccessFile toFile = new RandomAccessFile("D:/tmp/NIO/toFile.txt", "rw");
        //获取channel
        FileChannel fromChannel = fromFile.getChannel();
        FileChannel toChannel = toFile.getChannel();

        //分配buffer
        ByteBuffer buffer = ByteBuffer.allocate(1024);

        while (fromChannel.read(buffer) != -1) 
            buffer.flip();
            while (buffer.hasRemaining()) 
                toChannel.write(buffer);
            
            buffer.clear();
        
        //关闭资源
        fromChannel.close();
        toChannel.close();
        fromChannel.close();
        toChannel.close();
    

缓冲区的hasRemainning方法返回一个boolean,标识缓冲区中是否还有数据没有读取，写入FileChannel必须在一个循环中，因为write方法无法保证缓冲区的数据一次全部写入；

三、通过FileChannel直接传输

在两个通道间传输数据，如果其中有一个是FileChannel，可以不使用缓冲区读出、写入的方式进行传输，可以使用FileChannel的transferFrom 和 transferTo 方法；

1. transferFrom

public long transferFrom(ReadableByteChannel src, long position, long count) throws IOException;

该方法可以从其他通道直接将数据传输到fileChannel,position参数表示从position开始先目标文件写入数据，count参表示最多写入的数据量，但是不一定会写入这个参数的数据量，如果来源通道没有那么多可读数据的话；该方法返回一个long值表示成功写入通道的数据量；

2. transferTo

public abstract long transferTo(long position, long count, WritableByteChannel target) throws IOException;

改方法与transferFrom相反，是将FileChannel的数据直接写入到目标通道，position参数表示从position位置开始读取数据写入，count参数表示要写入数据的大小，但是不一定写入这个参数的数据量，如果这个fileChannel没有那么多数据可以读取的话；该方法返回一个long值，表示实际写入目标通道的数据量；

以下是一个通过transferFrom/transferTo方法复制文件的实例代码：

public static void main(String[] args) throws IOException 

        RandomAccessFile fromFile = new RandomAccessFile("D:/tmp/NIO/fromFile.txt", "rw");
        RandomAccessFile inFile = new RandomAccessFile("D:/tmp/NIO/toFile.txt", "rw");

        FileChannel fromChannel = fromFile.getChannel();
        FileChannel inChannel = inFile.getChannel();

        int position = 0;
        long count = fromChannel.size();

        long successCount = inChannel.transferFrom(fromChannel, position, count);
        //long successCount = fromChannel.transferTo(position, count, inChannel);

        System.out.println(successCount);
    

四、文件锁定

FileChannel的锁，与一般的对象锁相似，都是劝告式锁；获取锁后，它不阻止任何形式的数据访问，而是与对象锁相似，程序中可以通过它进行多线程间协调（线程安全处理）；

通过FileChannel的lock方法，可以锁定整个文件或指定一部分；请求获取的锁有两种：共享锁和排它锁；共享锁可以获取多个，而排它锁只能获取到一个；

由于不同的操作系统对文件系统锁的实现方式不一样，有些实现了共享锁，而另外一些只实现了排它锁；

以下是一个获取文件锁的实例代码，可以通过同时运行多个观察效果：

public static void main(String[] args) throws Exception 
        RandomAccessFile fromFile = new RandomAccessFile("D:/tmp/NIO/fromFile.txt", "rw");
        FileChannel fromChannel = fromFile.getChannel();

        System.out.println("trying to lock file...");
        int start = 0;
        int end = 10;
        FileLock fileLock = fromChannel.lock(start, end, false);
        System.out.println("after lock");

        System.out.println("pause...");
        Thread.sleep(8000);

        System.out.println("releasing file lock");
        fileLock.release();
        System.out.println("after release.");

        fromChannel.close();
        fromFile.close();
    

lock 方法中，start、end参数指定锁定文件的部分，第三个boolean参数，true：表示获取共享锁，false：表示获取排它锁；
还有一个lock()无参的方法，实际是调用：

public final FileLock lock() throws IOException 
        return lock(0L, Long.MAX_VALUE, false);
    

由于不是全部操作系统都支持共享锁，所以就算请求获取共享锁，但是也可能会返回一个排它锁，可以通过isShare方法确定锁类型：

fileLock.isShared();

对此，我们不如直接只使用排它锁，而不是进行isShare逻辑的判断；

五、FileChannel的其他方法

1. position方法

可以使用position()方法获取当前通道的位置、position(long pos)方法设置position值；
该方法主要可以使用与指定某个位置开始读写数据；
如果将position值设置到文件结束之后，然后读取数据将返回-1;
而如果设置为文件结束后进行写入，就会导致“文件空洞”；“文件空洞”对于类似下载文件这样先让文件占用已知文件大小是有意义的；(对于这种与操作系统/文件系统相关的，这里不做讲解)

2.size方法

size方法返回一个long值，表示FileChannel关联文件的大小：

long fileSize = fileChannel.size();

3.truncate方法

该方法用于文件的截取，类是String的subString()方法，文件中指定长度后面的部分数据将别删除：

fileChannel.truncate(10); //截取文件前10个字节

4.force方法

该方法强制将FileChannel中未写入硬盘的数据写入到硬盘中：

fileChannel.force(true);

boolean参数表示是否将文件元数据也强制写入硬盘；