如何在android中安全地将文件保存到磁盘？

Question

我编写了一个 Android 应用程序，可以将（可能）大文件保存到 SD 卡上。有时，我会在写入操作期间收到 IOException，这会导致文件处于损坏状态。基于此问题的答案：

问题：如何安全地写入文件？

我应该使用的策略是创建一个临时文件，然后在写入完成后复制该文件。我的问题是：

1）这是 Android 上最安全的方法吗？ （例如，您可以在android sd卡上复制文件吗？如果可以的话，操作是原子的吗？）

2）在资源（磁盘空间）有限的嵌入式系统中，有人知道安全写入磁盘的另一种策略吗？ （而不是创建两个大文件）

谢谢

Answer 1

我知道现在回答已经太晚了，但会帮助遇到此问题的任何人，并会发现它很有帮助。

您需要使用 AtomicFile。

以下代码片段可能会有所帮助。

public void writeFile(File file, byte[] data) {
    AtomicFile aFile = new AtomicFile(file);
    FileOutputStream fos = null;

    try {
        fos = aFile.startWrite();
        fos.write(data);
        // Close stream and commit new data.
        aFile.finishWrite(fos);
        fos = null;
    } catch (IOException e) {
        Log.e(TAG, "Cannot write file " + file.getPath(), e);
    } finally {
        if (fos != null) {
            // Something went wrong.
            // Close stream and roll back data.
            aFile.failWrite(fos);
        }
    }
}

Answer 2

在最合理的平台（Linux/Android 是其中之一）上安全创建文件的典型方法是创建一个临时文件，然后重命名该文件，如问题&您链接到的答案。请注意重命名的重点；重命名文件通常是同一文件系统内的原子操作，而复制文件则不是。此外，此方法仅需要足够的空间来容纳单个数据副本。

因此，您使用临时名称在目标目录中创建一个文件，然后使用 File.renameTo() 为其指定适当的名称。通过对临时文件使用标准命名约定，您始终可以找到并删除它们，即使您的应用程序由于设备关闭等原因意外终止。

如果您真的很偏执，您可能需要插入一些对 FileDescriptor.sync() 或等效...

编辑：

顺便说一句，您没有提及您收到的 IOException 类型以及您是否已跟踪下降其原因。如果是由于空间不足，没问题，但如果我们谈论的是有故障的 SD 卡，那么在这种情况下就没有“安全”之说。

编辑2：

为了检查可用空间，您可以创建一个 File 目标目录（即文件最终所在的目录）对象并调用 File.getFreeSpace()。请记住，此检查不提供任何保证 - 如果例如另一个进程将数据写入介质，您可能仍然会没有足够的空间。

Answer 3

正如 Pawan 的回答中提到的，建议使用 AtomicFile 来安全地写入文件。

但使用时仍然需要小心，有时它并不是那么“原子”。

您可以在 android.util、android.support.v4.util 和 androidx.core.util 中找到 AtomicFile 。但它们的实现在不同版本的API级别/support库/androidx库中是不同的，所以请注意在使用之前更改为您的依赖版本。

一般来说，您应该使用最新版本的 androidx 的 AtomicFile。它位于androidx.core:core中，并被androidx.appcompat:appcompat所依赖。

---

让我们看看当我们尝试在较低版本中使用 AtomicFile 写入文件时实际会发生什么。

API 级别: [17, 29] / 支持库: [22.1.0, 28.0.0] / androidx 核心: [1.0.0, 1.3.2]

public FileOutputStream startWrite() throws IOException {
    // Step 1: rename base file to backup file, or delete it.
    if (mBaseName.exists()) {
        if (!mBackupName.exists()) {
            if (!mBaseName.renameTo(mBackupName)) {
                Log.w("AtomicFile", "Couldn't rename file " + mBaseName
                    + " to backup file " + mBackupName);
                }
        } else {
            mBaseName.delete();
        }
    }

    // At this moment,the base file does not exist anyway.

    // Step 2: open output stream to base file.
    FileOutputStream str;
    try {
        str = new FileOutputStream(mBaseName);
    } catch (FileNotFoundException e) {
        // ...
    }
    return str;
}

正如你所看到的，AtomicFile 更喜欢返回在写入之前先创建基本文件。
这确实可以在写入基础文件失败时提供有效的恢复手段。但你只能说写操作是安全的，而不是原子的。

想象一下，如果系统在步骤 1 和 2 之间断电，会发生什么情况，基本文件将丢失，仅保留备份文件。

此外，由于 FileOutputStream 指向基本文件，因此写入也不是原子的。

---

但google在高版本中改进了AtomicFile的实现。

API 级别：30+ / androidx 核心：1.5.0+

public FileOutputStream startWrite() throws IOException {
    // Step 1: recover backup file, which was used in old version.
    if (mLegacyBackupName.exists()) {
        rename(mLegacyBackupName, mBaseName);
    }

    // Step 2: open output stream to new file, not the base file.
    try {
        return new FileOutputStream(mNewName);
    } catch (FileNotFoundException e) {
        // ...
    }
}

改进后的 AtomicFile 采用了另一种方法：当您将内容写入 startWrite() 返回的输出流时，您实际上写入了一个新文件（a后缀为.new的临时文件），调用finishWrite()后新文件将重命名为基础文件。

现在，基础文件的内容只有两种情况：

1. 写入失败，基础文件的内容保持不变。
2. 写作成功。

现在它是真正的原子了。

Answer 4

我不知道是否要复制它，但重命名临时文件是典型的做法。如果写入过程中出现异常，删除临时文件即可。