Kotlin 中删除目录及其子文件和子目录

1. 简介

在许多应用中，删除指定目录下的文件和子目录是一个常见需求，比如文件管理工具、清理脚本等。Kotlin 提供了简洁高效的 API 来处理这类文件操作。

本文将介绍如何使用 Kotlin 删除目录中的所有文件和子目录，并涵盖异常处理、递归删除以及扩展函数的最佳实践。

⚠️ 重要提醒：文件删除是不可逆的操作！尤其在线上环境执行前，请务必确认路径正确并做好数据备份。

2. Kotlin 中的文件删除机制

Kotlin 直接继承了 Java 的 I/O 能力，因此我们可以无缝使用 Java 的文件 I/O API 进行操作。核心类为 java.io.File。

✅ 关键点：
要删除一个目录，该目录必须为空 —— 这意味着我们必须先递归地删除其所有内容（包括嵌套的子目录和文件），才能最终删除目录本身。

3. 删除单个文件

我们从最基础的操作开始：删除单个文件。

fun deleteFile(filePath: String) {
    val file = File(filePath)
    if (file.exists() && file.isFile) {
        file.delete()
    }
}

📌 说明：

使用 exists() 判断文件是否存在；
isFile 防止误删目录；
delete() 返回 Boolean，但此处未处理返回值（实际项目建议判断是否删除成功）。

✅ 单元测试验证

@Test
fun `given file path when deleteFile called then file is deleted`() {
    val tempFile = createTempFile()
    assertTrue(tempFile.exists())

    deleteFile(tempFile.absolutePath)

    assertFalse(tempFile.exists())
}

这个测试创建了一个临时文件，调用删除方法后验证其已被移除。

4. 递归删除目录及其内容

要彻底删除一个非空目录，必须遍历其内容并逐层删除。典型做法是使用递归：

fun deleteDirectory(directory: File) {
    if (directory.exists() && directory.isDirectory) {
        directory.listFiles()?.forEach { file ->
            if (file.isDirectory) {
                deleteDirectory(file)
            } else {
                file.delete()
            }
        }
        directory.delete()
    }
}

📌 执行流程：

检查目录是否存在且为目录类型；
获取所有子项（文件或目录）；
若是子目录，则递归调用自身；
若是文件，直接删除；
最后删除当前目录。

✅ 测试用例

@Test
fun `given directory when deleteDirectory called then directory and its contents are deleted`() {
    val tempDir = createTempDir()
    val tempFileInDir = File(tempDir, "tempFile.txt").apply { createNewFile() }
    assertTrue(tempDir.exists())
    assertTrue(tempFileInDir.exists())

    deleteDirectory(tempDir)

    assertFalse(tempDir.exists())
    assertFalse(tempFileInDir.exists())
}

该测试构造了一个包含文件的临时目录，验证整个结构被成功删除。

❌ 常见踩坑：忘记递归导致 delete() 失败（非空目录无法直接删除）

5. 异常处理

文件删除可能因权限不足、文件被占用等原因失败。良好的实践是捕获潜在异常：

fun safeDeleteDirectory(directory: File) {
    try {
        deleteDirectory(directory)
    } catch (e: IOException) {
        e.printStackTrace() // 实际项目中建议使用日志框架
    }
}

✅ 安全性测试

@Test
fun `given a non-existent file should not throw`() {
    val file = File("imaginary-file.txt")

    assertDoesNotThrow {
        safeDeleteDirectory(file)
    }
}

此测试确保传入无效路径时不会抛出异常，提升代码健壮性。

📝 提示：生产环境中建议记录日志而非打印堆栈，例如使用 SLF4J 或 Timber。

6. 使用扩展函数优化代码风格

Kotlin 的扩展函数让我们可以为现有类添加新行为，使代码更符合 Kotlin 风格。

6.1 Kotlin 内置的 `deleteRecursively()` 方法

实际上，Kotlin 标准库已经提供了开箱即用的解决方案：

val success = File("/path/to/directory").deleteRecursively()

✅ 优点：

简洁一行搞定；
自动递归删除所有内容；
返回 Boolean 表示是否删除成功。

⚠️ 缺点：

不支持中间插入自定义逻辑（如删除前记录日志、跳过某些文件）；
错误处理粒度较粗，无法精确控制异常行为。

👉 适用于简单场景，无需额外控制逻辑。

6.2 自定义扩展函数：`deleteContentsRecursively()`

当需要更高灵活性时，我们可以基于 walkBottomUp() 实现自己的版本：

fun File.deleteContentsRecursively(): Boolean {
    if (!this.exists()) return false
    if (!this.isDirectory) return this.delete()
    return this.walkBottomUp().all { it.delete() }
}

📌 关键特性：

walkBottomUp()：从最深层节点开始向上遍历，天然适合递归删除（先删子项再删父目录）；
all { it.delete() }：确保每一项都删除成功，否则返回 false；
支持链式扩展，语义清晰。

✅ 测试验证

@Test
fun `given directory when deleteDirectory called then directory and its contents are deleted recursively`() {
    val tempDir = createTempDir()
    val innerTempDir = File(tempDir, "innerTempDir").apply { mkdir() }
    val tempFileInDir = File(innerTempDir, "tempFile.txt").apply { createNewFile() }

    assertTrue(tempDir.exists())
    assertTrue(innerTempDir.exists())
    assertTrue(tempFileInDir.exists())

    tempDir.deleteContentsRecursively()

    assertFalse(tempDir.exists())
    assertFalse(innerTempDir.exists())
    assertFalse(tempFileInDir.exists())
}

测试覆盖了多层嵌套结构，证明扩展函数能正确处理复杂目录树。

💡 小技巧：你还可以在 walkBottomUp() 中加入过滤条件，实现“保留某些文件”的软删除逻辑。

7. 总结

本文系统介绍了在 Kotlin 中删除目录及其内容的多种方式：

方式	适用场景	推荐程度
手动递归删除	学习原理、精细控制	✅ 掌握必备
`deleteRecursively()`	快速实现、无定制需求	✅ 日常推荐
自定义扩展函数	需要插桩、审计、过滤等逻辑	✅ 高级用法

📌 最佳实践建议：

开发阶段多写单元测试，避免误删；
生产环境加开关控制或日志审计；
对敏感路径做白名单校验；
考虑使用 java.nio.file.Path 和 Files 类进行更现代的文件操作（后续可拓展）。

🔗 示例代码已托管至 GitHub：https://github.com/Baeldung/kotlin-tutorials/tree/master/core-kotlin-modules/core-kotlin-files

合理运用这些技术，不仅能写出安全可靠的文件清理逻辑，也能让你的 Kotlin 代码更具表达力与专业性。

Persistence

REST

Security