iOS小组件无法复制文本？AppIntent遇阻怎么办

2024-08-04 08:09:07

iOS 小组件复制文本难题：AppIntent 遇阻，如何破？

你是否也曾为 iOS 小组件中复制文本而烦恼？AppIntent 看似为开发者提供了一把利器，却在复制文本这件事上屡屡碰壁。本文将带你深入分析问题根源，并提供一种基于 URL Scheme 的解决方案，助你轻松攻克这一难题。

AppIntent 复制文本失效之谜

在 iOS 16 中，AppIntent 横空出世，为开发者提供了一种在小组件中执行操作的全新方式。然而，当我们试图使用 AppIntent 将文本复制到 UIPasteboard 时，却常常遭遇滑铁卢。

让我们看一段常见的代码：

struct CopyTextIntent: AppIntent {
    static var title: LocalizedStringResource = "Copy Resource"
    
    static var isDiscoverable: Bool { false }
    
    var resource: String
    
    init(resource: String) {
        self.resource = resource
    }
    
    init() {
        self.resource = "\'_'/"
    }
    
    func perform() async throws -> some ReturnsValue<String> {
        let pasteboard = UIPasteboard.general
        pasteboard.string = resource
        
        return .result(value: resource)
    }
}

这段代码逻辑清晰，目标明确：将 resource 字符串复制到剪贴板。然而，当我们在小组件中点击按钮触发这段代码时，它并不会如预期般将文本复制到剪贴板，而是悄无声息地失败，甚至抛出令人费解的错误信息：

saving pasteboard failed with error: Error Domain=PBErrorDomain Code=11 "The pasteboard name com.apple.UIKit.pboard.general is not valid." UserInfo={NSLocalizedDescription=The pasteboard name com.apple.UIKit.pboard.general is not valid.}

错误信息背后的真相

错误信息提示我们 UIPasteboard 的名称无效，但这究竟意味着什么呢？难道是我们代码写错了？

其实，问题并非出在 UIPasteboard 本身，而在于 AppIntent 的运行机制。AppIntent 旨在为小组件提供轻量级的操作，其执行环境并非我们所熟悉的应用程序进程，而是独立的扩展进程。简单来说，AppIntent 代码就像是被隔离在一个沙盒中，无法直接访问应用程序的剪贴板。

URL Scheme: 搭建沟通的桥梁

既然 AppIntent 无法直接操作剪贴板，那么我们该如何实现文本复制呢？答案是利用应用程序自身的复制功能，而 URL Scheme 则是搭建 AppIntent 和应用程序之间沟通桥梁的关键。

我们可以通过以下步骤实现：

创建自定义 URL Scheme: 为应用程序定义一个自定义 URL Scheme，用于触发文本复制操作。
在 AppIntent 中打开自定义 URL: 在 AppIntent 的 perform() 方法中，使用 UIApplication.shared.open() 方法打开预设的自定义 URL，并将需要复制的文本作为参数传递。
在应用程序中处理 URL: 在应用程序的 application(_:open:options:) 方法中拦截自定义 URL，解析参数，并将文本复制到剪贴板。

以下是代码示例：

1. 在 Info.plist 文件中添加自定义 URL Scheme:

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLName</key>
        <string>com.yourdomain.yourapp</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>myapp</string>
        </array>
    </dict>
</array>

2. 修改 AppIntent 代码:

struct CopyTextIntent: AppIntent {
    // ...

    func perform() async throws -> some ReturnsValue<String> {
        guard let url = URL(string: "myapp://copy?text=\(resource)") else {
            throw "Invalid URL" 
        }

        if UIApplication.shared.canOpenURL(url) {
            UIApplication.shared.open(url)
        }

        return .result(value: resource)
    }
}

3. 在 AppDelegate 中处理 URL:

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    guard let scheme = url.scheme,
          scheme == "myapp",
          let host = url.host,
          host == "copy",
          let text = URLComponents(url: url, resolvingAgainstBaseURL: false)?.queryItems?.first(where: { $0.name == "text" })?.value
    else { return false }

    UIPasteboard.general.string = text
    return true
}