总结删除文件或文件夹的7种方法-JAVA IO基础总结第4篇

2,842 阅读7分钟

本文是Java IO总结系列篇的第4篇,前篇的访问地址如下:

如果您阅读完成,觉得此文对您有帮助,请给我点个赞,您的支持是我不竭的创作动力。

为了方便大家理解,我特意制作了本文对应的视频:总结删除文件或者文件夹的7种方法

一、删除文件或文件夹的四种基础方法

下面的四个方法都可以删除文件或文件夹,它们的共同点是:当文件夹中包含子文件的时候都会删除失败,也就是说这四个方法只能删除空文件夹

需要注意的是:传统IO中的File类和NIO中的Path类既可以代表文件,也可以代表文件夹。

  • File类的delete()
  • File类的deleteOnExit()
  • Files.delete(Path path)
  • Files.deleteIfExists(Path path);

它们之间的差异:

成功的返回值是否能判别文件夹不存在导致失败是否能判别文件夹不为空导致失败备注
File类的delete()true不能(返回false)不能(返回false)传统IO
File类的deleteOnExit()void不能,但不存在就不会去执行删除不能(返回void)传统IO,这是个坑,避免使用
Files.delete(Path path)voidNoSuchFileExceptionDirectoryNotEmptyExceptionNIO,笔者推荐使用
Files.deleteIfExists(Path path);truefalseDirectoryNotEmptyExceptionNIO
  • 由上面的对比可以看出,传统IO方法删除文件或文件夹,再删除失败的时候,最多返回一个false。通过这个false无法发掘删除失败的具体原因,是因为文件本身不存在删除失败?还是文件夹不为空导致的删除失败?
  • NIO 的方法在这一点上,就做的比较好,删除成功或失败都有具体的返回值或者异常信息,这样有利于我们在删除文件或文件夹的时候更好的做程序的异常处理
  • 需要注意的是传统IO中的deleteOnExit方法,笔者觉得应该避免使用它。它永远只返回void,删除失败也不会有任何的Exception抛出,所以我建议不要用,以免在你删除失败的时候没有任何的响应,而你可能误以为删除成功了。
//false只能告诉你失败了 ,但是没有给出任何失败的原因
@Test
void testDeleteFileDir1()  {
   File file = new File("D:\\data\\test");
   boolean deleted = file.delete();
   System.out.println(deleted);
}

//void ,删除失败没有任何提示,应避免使用这个方法,就是个坑
@Test
void testDeleteFileDir2()  {
   File file = new File("D:\\data\\test1");
   file.deleteOnExit();
}


//如果文件不存在,抛出NoSuchFileException
//如果文件夹里面包含文件,抛出DirectoryNotEmptyException
@Test
void testDeleteFileDir3() throws IOException {
   Path path = Paths.get("D:\\data\\test1");
   Files.delete(path);   //返回值void
}

//如果文件不存在,返回false,表示删除失败(文件不存在)
//如果文件夹里面包含文件,抛出DirectoryNotEmptyException
@Test
void testDeleteFileDir4() throws IOException {
   Path path = Paths.get("D:\\data\\test1");
   boolean result = Files.deleteIfExists(path);
   System.out.println(result);
}

归根结底,建议大家使用java NIO的Files.delete(Path path)Files.deleteIfExists(Path path);进行文件或文件夹的删除。

二、如何删除整个目录或者目录中的部分文件

上文已经说了,那四个API删除文件夹的时候,如果文件夹包含子文件,就会删除失败。那么,如果我们确实想删除整个文件夹,该怎么办?

前提准备

为了方便我们后面进行试验,先去创建这样一个目录结构,“.log”结尾的是数据文件,其他的是文件夹

可以使用代面的代码进行创建

private  void createMoreFiles() throws IOException {
   Files.createDirectories(Paths.get("D:\\data\\test1\\test2\\test3\\test4\\test5\\"));
   Files.write(Paths.get("D:\\data\\test1\\test2\\test2.log"), "hello".getBytes());
   Files.write(Paths.get("D:\\data\\test1\\test2\\test3\\test3.log"), "hello".getBytes());
}

2.1. walkFileTree与FileVisitor

  • 使用walkFileTree方法遍历整个文件目录树,使用FileVisitor处理遍历出来的每一项文件或文件夹
  • FileVisitor的visitFile方法用来处理遍历结果中的“文件”,所以我们可以在这个方法里面删除文件
  • FileVisitor的postVisitDirectory方法,注意方法中的“post”表示“后去做……”的意思,所以用来文件都处理完成之后再去处理文件夹,所以使用这个方法删除文件夹就可以有效避免文件夹内容不为空的异常,因为在去删除文件夹之前,该文件夹里面的文件已经被删除了。
@Test
void testDeleteFileDir5() throws IOException {
   createMoreFiles();
   Path path = Paths.get("D:\\data\\test1\\test2");

   Files.walkFileTree(path,
      new SimpleFileVisitor<Path>() {
         // 先去遍历删除文件
         @Override
         public FileVisitResult visitFile(Path file,
                                  BasicFileAttributes attrs) throws IOException {
            Files.delete(file);
            System.out.printf("文件被删除 : %s%n", file);
            return FileVisitResult.CONTINUE;
         }
         // 再去遍历删除目录
         @Override
         public FileVisitResult postVisitDirectory(Path dir,
                                         IOException exc) throws IOException {
            Files.delete(dir);
            System.out.printf("文件夹被删除: %s%n", dir);
            return FileVisitResult.CONTINUE;
         }

      }
   );

}

下面的输出体现了文件的删除顺序

文件被删除 : D:\data\test1\test2\test2.log
文件被删除 : D:\data\test1\test2\test3\test3.log
文件夹被删除 : D:\data\test1\test2\test3\test4\test5
文件夹被删除 : D:\data\test1\test2\test3\test4
文件夹被删除 : D:\data\test1\test2\test3
文件夹被删除 : D:\data\test1\test2

我们既然可以遍历出文件夹或者文件,我们就可以在处理的过程中进行过滤。比如:

  • 按文件名删除文件或文件夹,参数Path里面含有文件或文件夹名称
  • 按文件创建时间、修改时间、文件大小等信息去删除文件,参数BasicFileAttributes 里面包含了这些文件信息。

2.2.Files.walk

如果你对Stream流语法不太熟悉的话,这种方法稍微难理解一点,但是说实话也非常简单。

  • 使用Files.walk遍历文件夹(包含子文件夹及子其文件),遍历结果是一个Stream<Path>
  • 对每一个遍历出来的结果进行处理,调用Files.delete就可以了。
@Test
void testDeleteFileDir6() throws IOException {
   createMoreFiles();
   Path path = Paths.get("D:\\data\\test1\\test2");

   try (Stream<Path> walk = Files.walk(path)) {
      walk.sorted(Comparator.reverseOrder())
         .forEach(DeleteFileDir::deleteDirectoryStream);
   }

}

private static void deleteDirectoryStream(Path path) {
   try {
      Files.delete(path);
      System.out.printf("删除文件成功:%s%n",path.toString());
   } catch (IOException e) {
      System.err.printf("无法删除的路径 %s%n%s", path, e);
   }
}

问题:怎么能做到先去删除文件,再去删除文件夹? 。 利用的是字符串的排序规则,从字符串排序规则上讲,“D:\data\test1\test2”一定排在“D:\data\test1\test2\test2.log”的前面。所以我们使用“sorted(Comparator.reverseOrder())”把Stream顺序颠倒一下,就达到了先删除文件,再删除文件夹的目的。

下面的输出,是最终执行结果的删除顺序。

删除文件成功:D:\data\test1\test2\test3\test4\test5
删除文件成功:D:\data\test1\test2\test3\test4
删除文件成功:D:\data\test1\test2\test3\test3.log
删除文件成功:D:\data\test1\test2\test3
删除文件成功:D:\data\test1\test2\test2.log
删除文件成功:D:\data\test1\test2

2.3.传统IO-递归遍历删除文件夹

传统的通过递归去删除文件或文件夹的方法就比较经典了

//传统IO递归删除
@Test
void testDeleteFileDir7() throws IOException {
   createMoreFiles();
   File file = new File("D:\\data\\test1\\test2");
   deleteDirectoryLegacyIO(file);

}


private void deleteDirectoryLegacyIO(File file) {

   File[] list = file.listFiles();  //无法做到list多层文件夹数据
   if (list != null) {
      for (File temp : list) {     //先去递归删除子文件夹及子文件
         deleteDirectoryLegacyIO(temp);   //注意这里是递归调用
      }
   }

   if (file.delete()) {     //再删除自己本身的文件夹
      System.out.printf("删除成功 : %s%n", file);
   } else {
      System.err.printf("删除失败 : %s%n", file);
   }
}

需要注意的是:

  • listFiles()方法只能列出文件夹下面的一层文件或文件夹,不能列出子文件夹及其子文件。
  • 先去递归删除子文件夹,再去删除文件夹自己本身

欢迎关注我的博客,里面有很多精品合集

  • 本文转载注明出处(必须带连接,不能只转文字):字母哥博客

觉得对您有帮助的话,帮我点赞、分享!您的支持是我不竭的创作动力! 。另外,笔者最近一段时间输出了如下的精品内容,期待您的关注。