FileManager 的简介 #

FileManager 是 iOS 和 macOS 开发中提供的一个强大的类，用于管理文件系统的操作。它提供了对文件和文件夹进行创建、删除、移动、复制以及检索其属性等多种功能的接口。

FileManager 是 Foundation 框架的一部分，是 用户文件系统交互的核心工具。

1. FileManager 的体系结构 #

FileManager 由以下几个部分组成：

关键方法和属性 #

以下是 FileManager 的几个核心方法和属性：

以下是对 FileManager 的接口按功能分类的详细整理，包括方法名称以及对应的中文说明。分类基于 FileManager 的主要功能模块，包括文件操作、目录操作、文件系统信息、枚举和遍历操作等。

1. 文件操作

• 创建、删除、复制、移动文件及文件夹的基础管理。

2. 目录操作

• 创建文件夹、列举内容、获取子路径等。

3. 文件检查

• 检测文件是否存在，以及文件基本操作权限。

4. 文件属性

• 获取文件的大小、日期、权限等属性，或者设置某些属性。

5. 沙盒路径

• 获取用户目录、文档目录、缓存目录、临时路径等。

6. 数据写入与读取

• 管理文件的内容。

7. 遍历和枚举

• 遍历文件与子目录，递归或非递归模型支持。

1. 文件操作接口 #

2. 目录操作接口 #

3. 文件检查和验证接口 #

4. 文件系统属性接口 #

5. 常见的沙盒和目录路径接口 #

6. 数据读取与写入接口 #

7. 目录遍历和枚举接口 #

8. 符号链接和硬链接操作接口 #

9. 数据迁移与备份接口 #

10. iCloud 文件操作接口 #

11. 可用 iOS/macOS 的属性与共享组接口 #

注意事项 #

以下为 FileManager 使用中的开发者常见注意点：

1. 沙盒环境限制：

   • iOS 应用运行在沙盒环境下，开发者只能访问自己应用的沙盒目录，比如 Documents、Library、Caches 等。
   • 无法访问其他应用的目录或系统级目录。

2. 文件操作权限：

   • 在创建目录或文件时，需要检查操作权限是否满足，尤其在 macOS 上，如果涉及全局目录（例如 /Library），需要管理员权限。

3. 错误处理：

   • 几乎所有 FileManager 方法都可能抛出错误（如路径不存在、权限问题等），因此建议在操作文件时使用 do-catch 语句来捕获错误。

4. 数据安全性：

   • 在存储敏感数据时，应确保文件和路径具备适当的权限控制（如 NSFileProtectionComplete）。

5. 跨平台适用性：

   • 部分方法（例如 homeDirectoryForCurrentUser 和 isUbiquitousItem(at:)）仅适用于 macOS 或在启用了特定功能（如 iCloud）后才可用。

2. 使用 FileManager 的步骤 #

2.1 获取 FileManager 的共享实例 #

FileManager 是一个共享实例类，通过其 default 属性可以获取实例。

let fileManager = FileManager.default

通过此实例可以执行各种文件操作。

2.2 获取常见的沙盒路径 #

iOS 和 macOS 应用运行在一个 沙盒环境 中，无法直接访问系统文件。常见的沙盒目录包括：

示例代码：获取常见目录 #

let fileManager = FileManager.default

// 获取文档目录路径
if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    print("Documents Directory: \(documentsDirectory)")
}

// 获取缓存目录路径
if let cachesDirectory = fileManager.urls(for: .cachesDirectory, in: .userDomainMask).first {
    print("Caches Directory: \(cachesDirectory)")
}

// 获取临时目录路径
let tempDirectory = fileManager.temporaryDirectory
print("Temporary Directory: \(tempDirectory)")

2.3 创建文件夹 #

示例代码： #

let fileManager = FileManager.default

// 创建自定义文件夹（路径为沙盒内 Documents 文件夹下）
if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let newFolderURL = documentsDirectory.appendingPathComponent("NewFolder")
    
    do {
        try fileManager.createDirectory(at: newFolderURL, withIntermediateDirectories: true, attributes: nil)
        print("Folder created at: \(newFolderURL)")
    } catch {
        print("Failed to create folder: \(error.localizedDescription)")
    }
}

2.4 检查文件是否存在 #

示例代码： #

let filePath = "/path/to/your/file.txt"
if fileManager.fileExists(atPath: filePath) {
    print("File exists.")
} else {
    print("File does not exist.")
}

2.5 文件的存储与读取 #

1. 写入文本文件 #

if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let fileURL = documentsDirectory.appendingPathComponent("example.txt")
    let data = "Hello, FileManager!".data(using: .utf8)
    
    // 创建文件
    fileManager.createFile(atPath: fileURL.path, contents: data, attributes: nil)
    print("File created: \(fileURL)")
}

2. 读取文件数据 #

if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let fileURL = documentsDirectory.appendingPathComponent("example.txt")
    
    if let fileData = fileManager.contents(atPath: fileURL.path),
       let fileContent = String(data: fileData, encoding: .utf8) {
        print("File content: \(fileContent)")
    }
}

2.6 移动文件或重命名 #

示例代码： #

if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let sourceURL = documentsDirectory.appendingPathComponent("example.txt")
    let destinationURL = documentsDirectory.appendingPathComponent("renamed_example.txt")
    
    do {
        try fileManager.moveItem(at: sourceURL, to: destinationURL)
        print("File moved/renamed to: \(destinationURL)")
    } catch {
        print("Failed to move file: \(error.localizedDescription)")
    }
}

2.7 删除文件或文件夹 #

示例代码： #

if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let fileURL = documentsDirectory.appendingPathComponent("example.txt")
    
    do {
        try fileManager.removeItem(at: fileURL)
        print("File deleted: \(fileURL)")
    } catch {
        print("Failed to delete file: \(error.localizedDescription)")
    }
}

2.8 获取文件属性 #

你可以通过 attributesOfItem(atPath:) 方法检索文件的详细属性（如创建时间、文件大小等）。

示例代码： #

if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    let fileURL = documentsDirectory.appendingPathComponent("example.txt")
    
    do {
        let attributes = try fileManager.attributesOfItem(atPath: fileURL.path)
        print("File attributes: \(attributes)")
        
        if let fileSize = attributes[.size] as? Int64 {
            print("File size: \(fileSize) bytes")
        }
    } catch {
        print("Failed to get file attributes: \(error.localizedDescription)")
    }
}

3. FileManager 使用注意事项 #

1. 沙盒环境

   • iOS 应用只能访问自己的沙盒，不能直接访问系统的文件。
   • 除非使用 File Provider 等扩展访问外部文件。

2. 权限管理

   • 对于隐私敏感文件（如照片、麦克风等数据的存储和访问），需要填写 Info.plist 并请求用户权限。

3. 异常处理

   • 几乎所有 FileManager 操作都可能导致错误，例如路径不存在、权限不足等。建议通过 do-catch 处理所有异常。

4. 临时文件管理

   • 存储临时数据时，使用 temporaryDirectory。系统会自动清理，但需要确保在不用时删除临时文件。

4. 应用场景 #

1. 存储用户文档，例如笔记、文本文件、图片。
2. 缓存网络下载内容到沙盒的 Caches 中。
3. 临时生成文件，在特定任务完成后移除它们。
4. 读取和解析日志文件或配置文件。

通过 FileManager，你可以轻松管理应用程序中的文件和目录操作。

FileManager.SearchPathDomainMask 是一个枚举类型，定义了文件系统的域（Domain）范围，用于在检索目录路径时指定特定的作用域，例如用户目录、系统目录等。这些选项在调用 FileManager 的方法（如 urls(for:in:) 或 NSHomeDirectory()）时会用到。

它主要与 FileManager.SearchPathDirectory 一起使用，用于指定调用的目录位置（例如：文档目录、缓存目录），并限定查找的作用域（域对象）。

SearchPathDomainMask 的选项 #

以下是 SearchPathDomainMask 的可用值及其含义：

SearchPathDomainMask 常和 urls(for:in:) 或 path(for:in:) 方法一起使用。

1. .userDomainMask #

• 沙盒文件系统。

• 用途： 访问属于当前用户的文件目录（文档、缓存、临时文件等）。

• 示例：

  if let documentsDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first {
      print("Documents Directory: \(documentsDirectory)")
  }
  

• urls(for:in:) 返回用户在沙盒中的文件夹，适用于 iOS 应用程序，这也是当前绝大部分情况下使用的域。

2. .localDomainMask #

• 多用户共享目录。
• 用途： 本地目录，可供所有用户访问的共享文件资源。
• 示例（macOS 平台）：

  if let localLibraryDirectory = FileManager.default.urls(for: .libraryDirectory, in: .localDomainMask).first {
      print("Local Library Directory: \(localLibraryDirectory)")
  }
  

• 输出路径示例：

  /Library
  

3. .networkDomainMask #

• 基于网络的共享目录。
• 用途： 检索网络挂载的共享卷（macOS 上用于访问网络文件系统）。
• 示例（macOS 中）：

  if let networkCacheDirectory = FileManager.default.urls(for: .cachesDirectory, in: .networkDomainMask).first {
      print("Network Cache Directory: \(networkCacheDirectory)")
  }
  

• 输出路径示例：

  /Network/Library/Caches
  

4. .systemDomainMask #

• 系统资源目录。
• 用途： 表示系统级别不可修改的目录，只读访问（如系统库文件）。在应用程序沙盒中不可用。
• 示例（macOS 中）：

  if let systemLibraryDirectory = FileManager.default.urls(for: .libraryDirectory, in: .systemDomainMask).first {
      print("System Library Directory: \(systemLibraryDirectory)")
  }
  

• 输出路径示例：

  /System/Library
  

5. .allDomainsMask #

• 结合所有域。

• 用途： 获取所有域（用户、本地、网络、系统）下的目标目录。对于 iOS 应用而言通常不使用，因为沙盒限制无法访问其他域。

• 示例：

  let allDomains = FileManager.default.urls(for: .documentDirectory, in: .allDomainsMask)
  print("Directories in All Domains: \(allDomains)")
  

注意事项 #

1. iOS 的沙盒限制：

   • 在 iOS 上，应用程序只能访问 .userDomainMask 相关的目录（因为沙盒限制），无法访问 .localDomainMask、.networkDomainMask 和 .systemDomainMask。
   • 常用沙盒目录包括：
     • 文档目录：documentDirectory
     • 缓存目录：cachesDirectory
     • 临时目录：temporaryDirectory

2. macOS 支持更多域：

   • 在 macOS 上，FileManager.SearchPathDomainMask 的其他域（如 .localDomainMask 和 .networkDomainMask）更加常用，因为 macOS 上的文件系统没有 iOS 那样的沙盒限制。
   • Apple 的目录结构：
     • /Users/username/...（用户域）
     • /Library/...（本地域）
     • /System/...（系统域）
     • /Network/...（网络域）

3. 指定多个域：

   • 如果你需要操作多个域，可以通过按位或 (|) 的方式组合多个域。
   • 示例：

     let domains: FileManager.SearchPathDomainMask = [.userDomainMask, .localDomainMask]
     

总结 #

1. .userDomainMask（用户域）：沙盒范围，常用于 iOS。
2. .localDomainMask（本地域）：共享资源目录，常用于 macOS。
3. .networkDomainMask（网络域）：访问网络挂载资源，macOS 可用。
4. .systemDomainMask（系统域）：仅限操作系统使用，普通 App 无法访问。
5. .allDomainsMask：包含了上述所有域。

在实践中：

• 在开发 iOS 应用程序 时，主要使用 .userDomainMask。
• 在 macOS 开发 或涉及更多文件系统操作时，可以使用 .localDomainMask 和 .systemDomainMask 扩展功能。

实用场景：结合 SearchPathDirectory #

FileManager.SearchPathDomainMask 通常和 FileManager.SearchPathDirectory 结合使用，用于定位具体目录中需要操作的文件。

以下枚举提供了多种特定目录类型：

示例代码 #

let fileManager = FileManager.default

// 获取沙盒中文档目录
if let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first {
    print("Documents Directory (User Domain): \(documentsDirectory)")
}

// 获取沙盒中缓存目录
if let cachesDirectory = fileManager.urls(for: .cachesDirectory, in: .userDomainMask).first {
    print("Caches Directory: \(cachesDirectory)")
}

// 获取库目录
if let libraryDirectory = fileManager.urls(for: .libraryDirectory, in: .userDomainMask).first {
    print("Library Directory: \(libraryDirectory)")
}

结果示例（iOS 上沙盒路径） #

• 文档目录（documentDirectory + .userDomainMask）：

  /var/mobile/Containers/Data/Application/1234-5678-ABCD/Documents
  

• 缓存目录（cachesDirectory + .userDomainMask）：

  /var/mobile/Containers/Data/Application/1234-5678-ABCD/Library/Caches
  

• 库目录（libraryDirectory + .userDomainMask）：

  /var/mobile/Containers/Data/Application/1234-5678-ABCD/Library