iOS/iPadOS 中的 SwiftUI + DocumentGroup：如何重命名当前打开的文档

Posted 2023-02-24

【中文标题】iOS/iPadOS 中的 SwiftUI + DocumentGroup：如何重命名当前打开的文档

【英文标题】：SwiftUI + DocumentGroup in iOS/iPadOS: how to rename the currently open document

【发布时间】：2021-04-13 08:45:30

【问题描述】：

我的问题是关于 SwiftUI 的 DocumentGroup：在 Xcode 中使用一个简单的、基于模板的项目（使用新的多平台、基于文档的应用程序模板），我可以创建新文档、编辑它们等。另外，“外部" 应用程序，我可以像这样操作文档文件 - 移动它、复制它、重命名它等等。

默认情况下，所有新文档都使用“无标题”名称进行初始化；在主应用程序入口点，我可以访问文件的 URL：

var body: some Scene 
    DocumentGroup(newDocument: ShowPLAYrDocument())  file in
        // For example, this gives back the actual doc file URL:
        let theURL = file.fileURL
        ContentView(document: file.$document)
    

第一个问题：文档“打开”后，即代码在ContentView范围内运行时，如何编辑/更改实际文件名？ SwiftUI 文档的缺乏使得寻找此类问题的答案变得非常困难 - 我想我已经在整个互联网上大肆抨击，但似乎没有人遇到这类问题，如果他们这样做，他们发布的问题没有答案 - 我自己在其他问题上发布了几个问题，甚至没有任何 cmets，更不用说答案了。

我还有一个问题，我认为这有点相关：例如，我在“文件”应用程序中看到，某些文件类型在选择时可以在该文件的“信息”窗格下显示其他扩展信息（例如示例：视频文件以像素、持续时间和编解码器信息显示尺寸）；我的应用程序的文档包含几个值（在保存的数据中），我希望用户能够在文档选择器中“一目了然”，而无需打开文件本身，其方式与“文件”应用程序描述的方式类似.

我的第二个问题是：这可能吗？如果可以，我至少可以从哪里开始寻找答案？我的猜测是，这对于 SwiftUI 来说是不可能的现在，所以它必须与“常规” Swift 集成？

提前感谢您的任何指导。

【参考方案1】：

好的，事情是这样的：我“有点”设法实现了我所追求的目标，尽管（在我看来）这不是最“正确”的方法，而且仍然存在问题与过程有关 - 尽管目前我将其归咎于（显然已知的）错误的 DocumentGroup 实现，这也导致了其他问题（请see this question 了解有关该问题的更多详细信息）。

我“有点”设法更改文件名的方式如下代码所示：

@main
struct TestApp: App 
    
    @State var previousFileURL: String = ""
    
    var body: some Scene 
        DocumentGroup(newDocument: TestDocument())  file in
            ContentView(document: file.$document)
                .onAppear() 
                    previousFileURL = file.fileURL!.path
                
                .onDisappear() 
                    let newFileName = "TheNewFileName.testDocument"
                    let oldFileName = URL(fileURLWithPath: previousFileURL).lastPathComponent
                    
                    var newURL = URL(fileURLWithPath: previousFileURL).deletingLastPathComponent()
                    newURL.appendPathComponent(newFileName)
                        
                    do 
                        try FileManager.default.moveItem(atPath: oldURL.path, toPath: newURL.path)
                     catch 
                        print("Error renaming file! Threw: \(error.localizedDescription)")
                                        
                
        
    

它的作用是：它在视图初始化后（在previousFileURL）中将文档的初始URL“存储”在状态变量中，方法是在.onAppear修饰符中分配它（我这样做是因为我有不知道如何获取对 DocumentGroup 闭包中传递的 file 的引用）。 然后，通过使用.onDisappear 修饰符，我使用FileManager 的moveItem 来分配新名称——只需将文件从以前的URL“移动”到新生成的URL（实际上应该重命名文件） );提供的示例代码使用硬编码字符串newFileName，但在我的实际代码中（实际上在这里发布太长）我从存储在实际文档中的值中提取这个新文件名，其中turn 是应用程序用户可以在文档打开时编辑的字符串（有意义吗？）。

问题

这目前有一个非常烦人的问题：在一组情况下（即，当应用程序刚刚启动，并且使用“加号”按钮创建了一个新文档时），代码的行为与我预期的一样to - 它打开新文档，我可以（使用“内容视图”）编辑（并存储）将成为文件名的字符串，当我“关闭它”时（使用 NavigationView 上的后退按钮），它会适当地更新文件名，我可以通过在文档浏览器中实际查看文件来确认。

但是...如果我重新打开同一个文件，或者使用另一个文件，或者只是在不关闭应用程序的情况下再次完成创建新文件的整个过程等，那么显然 DocumentGroup 会搞砸向上 FileManager 到 moveItem 操作实际上复制文件（使用新名称）但不会删除或实际重命名“旧”文件的程度，因此您最终得到两个文件：一个具有新名称和一个具有“旧”/以前的名称。

即使我检查旧文件是否存在也会发生这种情况：当它达到这些条件时，FileManager.default.fileExists 实际上会找到前一个/旧文件，但是当它“移动”到新名称时它会复制它而不是重命名它。奇怪，但我假设这是因为我在上面的链接中提到的（明显的）错误。

希望这会为有更多经验和理解的人提供更好的答案，他们将（希望）在这里分享。

【讨论】：

我遇到了同样的问题，我几乎挖遍了整个互联网，一无所获。这可能是我能得到的最接近的。在您的解决方案中，previousFileURL 似乎是整个应用程序的全局变量。也许将其移至 ContentView 级别？

【参考方案2】：

上述“解决方案”遇到的问题与 .fileImporter 修饰符的（已确认）错误有关 - 所以，这个“有效”，尽管它是 hacky。

【参考方案3】：

您是否在设备上测试过上述“hacky”解决方案？在模拟器上运行良好，但由于new access permission rules in ios 13，代码抛出“XXXXXX” couldn’t be moved because you don’t have permission to access “YYYYYY”.

我已经深入挖掘并尝试覆盖由XCode生成的Document.swift标准代码的标准init()和FileWrapper函数定义，将所需文件名设置为preferredFilename和filename属性FileWrapper ：

struct SomeDocument: FileDocument, Decodable, Encodable 
   
    static var readableContentTypes: [UTType]  [.SomeDocument] 
    
    var someData: SomeCodableDataType
    
    init() 
        self.someData = SomeCodableDataType()
        print("Creating.\n")
    
    
    init(configuration: ReadConfiguration) throws 
        guard let data = configuration.file.regularFileContents else 
            throw CocoaError(.fileReadCorruptFile)
        
        let savedPreferredName = configuration.file.preferredFilename
        let savedName = configuration.file.preferredFilename
        let fileRep = try JSONDecoder().decode(Self.self, from: data)
        self.someData = fileRep.someData
        print("Loading.\n  Filename: \(savedPreferredName ?? "none") or \(savedName ?? "none")\n")
    
    
    func fileWrapper(configuration: WriteConfiguration) throws -> FileWrapper 
        do 
            let fileRep = try JSONEncoder().encode(self)
            let fileWrapper = FileWrapper.init(regularFileWithContents: fileRep)
            fileWrapper.preferredFilename = fileName()
            fileWrapper.filename = fileName()
            print("Writing.\n  Filename \(fileWrapper.preferredFilename ?? "none") or \(fileWrapper.filename ?? "none").\n")
            return fileWrapper
         catch 
            throw CocoaError(.fileReadCorruptFile)
        
    
    
    func fileName() -> String 
        
        let timeFormatter = DateFormatter()
        timeFormatter.dateFormat = "yyMMdd'-'HH:mm"
        let timeStamp = timeFormatter.string(from: Date())
        
        let extention = ".ext"
        let newFileName = timeStamp + "-\(someData.someUniqueValue())" + extention
        
        return newFileName
    

这是控制台打印输出。我在括号 []:

中添加了用户操作

[CREATE DOC BY TAPPING +]
Creating.
[AUTOMATIC WRITE]
Writing.
  Filename 210628-16:49-SomeUniqueValue.ext or 210628-16:49-SomeUniqueValue.ext.
[AUTOMATIC LOAD]
Loading.
  Filename: none or none
  FileURL: /Users/bora/Library/Developer/CoreSimulator/Devices/F126086A-A752-4A71-B589-1B37DFC02746/data/Containers/Data/Application/D81C9D76-7986-4C0D-BA2C-1FDF69703875/Documents/Untitled 2.ext
  isEditable: true
[CLOSING DOC]
Writing.
  Filename 210628-16:49-SomeUniqueValue.ext or 210628-16:49-SomeUniqueValue.ext.
  
[REOPENING DOC]
Loading.
  Filename: none or none
  FileURL: /Users/bora/Library/Developer/CoreSimulator/Devices/F126086A-A752-4A71-B589-1B37DFC02746/data/Containers/Data/Application/D81C9D76-7986-4C0D-BA2C-1FDF69703875/Documents/Untitled 2.ext
  isEditable: true

所以在初始文档创建后，第一次写入（使用func fileWrapper(configuration: WriteConfiguration) throws -> FileWrapper），文件名被正确分配给FileWrapper。但是，当视图代码加载文档时，很明显没有使用FileWrapper 的文件名属性。当文档关闭（使用分配了名称的FileWrapper 写入）并再次打开时，同样的情况会重复。

这看起来像一个错误。我不明白为什么DocumetGroup 不使用FileWrapper 的文件名属性，而肯定使用同一FileWrapper 提供的数据内容。

我还没有在新的 SwiftUI (iOS14) 上尝试过这个。我会做并报告。

更新：现在在 iOS 14 上测试，在那里也不起作用。我想是时候雷达了。

【讨论】：

应该是有权限的东西。您必须使用 .startAccessingSecurityScopedResource() 和 .stopAccessingSecurityScopedResource() 来解决该问题。

是的，我读到了startAccessingSecurityScopedResource 并实现了它，但仍然存在问题。如果你不介意我问；是否有额外的步骤（如权利）来完成这项工作？

不是，不是。只要确保你在正确的“事物”上调用startAccessingSecurityScopedResource - 例如：你有一个变量（let url = "whatever_url_here"）中的URL，你这样做的方式是：url.startAccessingSecurityScopedResource();此外，不要“信任”来自文件系统的直接 URL - 您需要为文件创建一个书签并使用该书签来安全地访问应用程序沙箱之外的资源，即：var secureBookmarkData = Data() secureBookmarkData = try fileURL.bookmarkData()（伪代码；请检查sintaxis）

谢谢。我已经设法实现了书签以获得安全访问 - startAccessingSecurityScopedResource 返回 true。但是现在我想这次我得到了Error renaming file! Threw: “Untitled” couldn’t be moved because you don’t have permission to access “Folder Name”. 权利......

你有没有得到设备上工作的完整序列？我正在尝试通过这里的各种解决方案和 cmets 来理顺它，但在遵循实际可行的方法时遇到了麻烦。