commons-io的Java文件处理常用方法

Java文件处理常用方法

归纳整理一些常用的处理文件的方法

Java Apache FileUtils

Maven依赖引入

    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.6</version>
    </dependency>

常用的方法

package com.cn.ybwn.file;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.FileFileFilter;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.filefilter.IOFileFilter;

import java.io.*;
import java.net.URL;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.zip.CRC32;

/**
 * @author 25724
 * @date 2023/3/16 9:36
 * @description
 */

public class FileUtilsTest {
    private static File parent = new File("D://test");

    public void getDirTest() {
        //获得基本的信息
        //获取临时目录 java.io.tmpdir,getUserDirectoryPath返回路径字符串
        System.out.println(FileUtils.getTempDirectory());
        //获取用户主目录 user.home,getUserDirectoryPath返回路径字符串
        System.out.println(FileUtils.getUserDirectory());
        //以可读的方式，返回文件的大小EB, PB, TB, GB, MB, KB or bytes
        System.out.println(FileUtils.byteCountToDisplaySize(10000000));
        System.out.println(FileUtils.byteCountToDisplaySize(1));
    }

    public void openStream() throws IOException {
        //获取文件输入和输出的文件流
        //文件是目录或者不存在，都会跑出异常
        InputStream in = FileUtils.openInputStream(new File("D://test/test1"));
        OutputStream out = FileUtils.openOutputStream(new File("D://test/test2"));
        //是否追加的形式添加内容
        out = FileUtils.openOutputStream(new File("D://test/test3"), true);
    }

    public void FileOperation() throws IOException {
        //创建文件，如果文件存在则更新时间；如果不存在，创建一个空文件
        //创建空文件的方式为：
        FileUtils.touch(new File("D://test/test4"));

        //文件内容的对比
        FileUtils.contentEquals(new File("D://test/test1"), new File("D://test/test2"));
        //忽略换行符，第三个参数是字符集
        FileUtils.contentEqualsIgnoreEOL(new File("D://test/test1"), new File("D://test/test2"), null);

        //根据URL获取文件
        FileUtils.toFile(new URL("file://D://test/test1"));
        FileUtils.toFiles(null);
        FileUtils.toURLs(new File[]{new File("D://test/test1")});

        //文件拷贝
        //第三个参数是否更新时间
        FileUtils.copyFileToDirectory(new File("/test1"), new File("/dir"), true);
        FileUtils.copyFile(new File("/source"), new File("/target"), true);

        //目录拷贝
        File srcDir = new File("/source");
        File destDir = new File("/target");

        FileUtils.copyDirectoryToDirectory(new File("/source"), new File("/target"));
        FileUtils.copyDirectory(new File("/source"), new File("/target"));
        //仅仅拷贝目录
        FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
        // 创建.txt过滤器
        IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
        IOFileFilter txtFiles = FileFilterUtils.andFileFilter(FileFileFilter.FILE, txtSuffixFilter);
        // 创建包含目录或者txt文件的过滤器
        FileFilter filter = FileFilterUtils.orFileFilter(DirectoryFileFilter.DIRECTORY, txtFiles);
        // Copy using the filter
        FileUtils.copyDirectory(srcDir, destDir, filter);

        //文件拷贝
        FileUtils.copyInputStreamToFile(new FileInputStream("/test"), new File("/test"));
        FileUtils.copyURLToFile(new URL("file:/test"), new File("/test"));

        //删除文件
        //删除目录下所有的内容
        FileUtils.deleteDirectory(new File("/test"));
        //如果是目录，会级联删除；不会抛出异常
        FileUtils.deleteQuietly(new File("/test"));

        //判断文件是否存在
        FileUtils.directoryContains(new File("/dir"), new File("/file"));

        //清除目录中的内容,不会删除该目录；
        //先verifiedListFiles检查目录，检查目录是否为目录、是否存在，然后调用listFiles，如果返回null，则抛出异常
        //遍历目录中的文件，如果是目录则递归删除；如果是文件则强制删除，删除失败（文件不存在或无法删除）都会抛出异常
        FileUtils.cleanDirectory(new File("/dir"));

        //等待一个文件xx秒，知道文件创建后才返回。每max(100,remainning)循环检查一次
        while (FileUtils.waitFor(new File("/dir"), 60)) {
        }

        //读取目标文件，内部调用IOUtils.toString(inputstream,"utf-8")
        String str = FileUtils.readFileToString(new File("/dir"), "utf-8");

        //内部调用IOUtils.toByteArray(in)
        byte[] bytes = FileUtils.readFileToByteArray(new File("/dir"));

        //内部调用IOUtils.readLines(in, Charsets.toCharset(encoding));
        List<String> strs = FileUtils.readLines(new File("/dir"), "utf-8");

        //内部调用IOUtils.lineIterator(in, encoding)
        FileUtils.lineIterator(new File("/dir"), "utf-8");

        //四个参数分别为：目标文件，写入的字符串，字符集，是否追加
        FileUtils.writeStringToFile(new File("/target"), "string", "utf-8", true);

        FileUtils.write(new File("/target"), "target char sequence", "utf-8", true);

        //(file,字符数组)
        FileUtils.writeByteArrayToFile(new File("/target"), "bytes".getBytes());
        //(file,字符数组，是否追加)
        FileUtils.writeByteArrayToFile(new File("/target"), "bytes".getBytes(), true);
        //(file,字符数组，起始位置，结束位置)
        FileUtils.writeByteArrayToFile(new File("/target"), "bytes".getBytes(), 0, 10);
        //(file,字符数组，起始位置，结束位置，是否追加)
        FileUtils.writeByteArrayToFile(new File("/target"), "bytes".getBytes(), 0, 10, true);

        //writeLines多了一个lineEnding参数
        FileUtils.writeLines(new File("/target"), "utf-8", FileUtils.readLines(new File("/target"), "utf-8"));

        //强制删除
        FileUtils.forceDelete(new File("/target"));

        //在JVM
        FileUtils.forceDeleteOnExit(new File("/target"));

        //强制创建文件目录，如果文件存在，会抛出异常
        FileUtils.forceMkdir(new File("/target"));

        //强制创建父级目录
        FileUtils.forceMkdirParent(new File("/xxxx/target"));

        //如果是文件，直接读取文件大小；如果是目录，级联计算文件下的所有文件大小
        //返回Long
        FileUtils.sizeOf(new File("/target"));
        //返回BigInteger
        FileUtils.sizeOfAsBigInteger(new File("/target"));
        FileUtils.sizeOfDirectory(new File("/target"));
        FileUtils.sizeOfDirectoryAsBigInteger(new File("/target"));

        //对比文件新旧
        FileUtils.isFileNewer(new File("/target"), new File("/file"));

        FileUtils.isFileOlder(new File("/target"), new Date());

        FileUtils.checksum(new File("/target"), new CRC32());
        FileUtils.checksumCRC32(new File("/target"));

        FileUtils.moveDirectory(new File("/target"), new File("/file"));
        FileUtils.moveDirectoryToDirectory(new File("/target"), new File("/file"), true);
        FileUtils.moveFile(new File("/target"), new File("/file"));
        FileUtils.moveFileToDirectory(new File("/target"), new File("/dir"), true);
        FileUtils.moveToDirectory(new File("/target"), new File("/dir"), true);

        FileUtils.isSymlink(new File("/target"));
    }


    public void findFiles() {
        //返回文件的列表
        List<File> files = (List<File>) FileUtils.listFiles(parent, new String[]{"test1", "test2"}, true);
        //返回文件迭代器
        Iterator<File> files_iter = FileUtils.iterateFiles(parent, new String[]{"test1", "test3"}, true);
        //把collection<File>转换成File[]
        FileUtils.convertFileCollectionToFileArray(files);
    }
}