[实训]Java中FileUtils类的使用

最新推荐文章于 2023-01-06 11:50:25 发布

转载最新推荐文章于 2023-01-06 11:50:25 发布 · 2.6k 阅读

文章标签：

#java #FileUtils类

学习专栏收录该内容

21 篇文章

订阅专栏

在java的日常开发中，有个常用包commons-io.jar，其中有对文件处理的工具类FileUtils。他提供了一些最常用的操作的封装好的方法，可以在开发中可以快速完成对文件的一些功能的处理。

在项目开发中，我主要使用了FileUtils类提供的对文件进行读写的部分方法，不需要自己根据java的file类进行编写代码，使用该类一行搞定。

如下为摘抄的部分方法的使用，基本根据方法名就能知道方法是干什么用的，借此机会学习一下其他方法的用法。

/**
 * FileUtils支持很多文件操作，如
 *
 * 文件写入
 * 读取文件
 * 创建目录
 * 拷贝文件和目录
 * 删除文件和目录
 * 从URL转换
 * 基于统配和过滤查看文件和目录
 * 比较文件内容
 * 文件的更新时间
 * 检查校验码
 *
 */
public class FileUtilsTest {
    private static File parent = new File("D://test");
    @Test
    public void getDirTest(){
        //获得基本的信息
        System.out.println(FileUtils.getTempDirectory());//获取临时目录 java.io.tmpdir,getUserDirectoryPath返回路径字符串
        System.out.println(FileUtils.getUserDirectory());//获取用户主目录 user.home,getUserDirectoryPath返回路径字符串

        //以可读的方式，返回文件的大小EB, PB, TB, GB, MB, KB or bytes
        System.out.println(FileUtils.byteCountToDisplaySize(10000000));
        System.out.println(FileUtils.byteCountToDisplaySize(1));
    }

    @Test
    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);//是否追加的形式添加内容
    }

    @Test
    public void FileOperation() throws IOException {
        //创建文件，如果文件存在则更新时间；如果不存在，创建一个空文件
        //创建空文件的方式为：
        // final OutputStream out = openOutputStream(file);
        // IOUtils.closeQuietly(out);
        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);//TODO 阅读doCopy源码

        //目录拷贝
        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);//仅仅拷贝目录

        IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");// 创建.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);//TODO 阅读doCopyDirectory源码

        //文件拷贝
        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"));//TODO verifiedListFiles  <------2016/11/24

        //等待一个文件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);

        //write可以接受charsequence类型的数据，string,stringbuilder和stringbuffer都是实现了charsequence接口
        FileUtils.write(new File("/target"),"target char sequence","utf-8",true);

        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);//(file,字符数组，起始位置，结束位置，是否追加)

        //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"));

        //如果是文件，直接读取文件大小；如果是目录，级联计算文件下的所有文件大小
        FileUtils.sizeOf(new File("/target"));//返回Long
        FileUtils.sizeOfAsBigInteger(new File("/target"));//返回BigInteger
        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"));
    }


    @Test
    public void findFiles(){
        //返回文件的列表
        List<File> files = (List<File>) FileUtils.listFiles(parent,new String[]{"test1","test2"},true);//TODO 重点看一下源码

        //返回文件迭代器
        Iterator<File> files_iter =  FileUtils.iterateFiles(parent,new String[]{"test1","test3"},true);

        //把collection<File>转换成File[]
        FileUtils.convertFileCollectionToFileArray(files);
    }
}