引言

在macOS应用开发中，文本编辑功能是用户交互的核心场景之一。除了基础的输入、选择和删除操作，用户对撤销（Undo）和重做（Redo）的需求几乎与文本编辑本身同等重要。本文将深入探讨如何为NSTextField组件实现完整的撤销/重做功能，覆盖从基础原理到实际代码落地的全流程。

撤销/重做的技术基础：NSUndoManager

macOS的AppKit框架通过NSUndoManager类提供了统一的撤销/重做管理机制。其核心思想是将用户操作封装为可逆的”命令对象”，通过栈结构记录操作历史，并支持按时间顺序回溯或重演。

关键概念解析

操作分组：默认情况下，同一事件循环周期内的操作会被合并为一个逻辑组（如连续多次输入文本视为一个操作）
操作注册：通过registerUndoWithTargetobject:方法注册逆操作
栈管理：主栈（undo stack）存储待撤销操作，重做栈（redo stack）存储待重做操作
自动分组：可通过beginUndoGrouping和endUndoGrouping手动控制分组边界

实现步骤详解

1. 初始化NSUndoManager

在自定义的NSTextField子类或控制器类中初始化撤销管理器：

class TextFieldController: NSObject {
    private let undoManager = NSUndoManager()
    private weak var textField: NSTextField?
    init(textField: NSTextField) {
        self.textField = textField
        super.init()
        setupUndoManagement()
    }
    private func setupUndoManagement() {
        textField?.delegate = self
        // 设置撤销操作分组间隔（默认0.1秒）
        undoManager.levelsOfUndo = 100 // 最大撤销步数
    }
}

2. 拦截文本变更事件

通过NSTextFieldDelegate协议监听文本变化，在关键节点注册撤销操作：

extension TextFieldController: NSTextFieldDelegate {
    func controlTextDidChange(_ obj: Notification) {
        guard let textField = obj.object as? NSTextField else { return }
        // 获取变更前后的文本状态
        let oldValue = undoManager.prepareWithInvocationTarget(self).currentTextFieldValue()
        let newValue = textField.stringValue
        // 注册撤销操作（当用户执行撤销时，将文本恢复为旧值）
        undoManager.setActionName("Edit Text")
        undoManager.registerUndo(withTarget: self, 
                               selector: #selector(restoreTextFieldValue(_:)),
                               object: oldValue)
    }
    @objc private func currentTextFieldValue() -> String {
        return textField?.stringValue ?? ""
    }
    @objc private func restoreTextFieldValue(_ oldValue: String) {
        textField?.stringValue = oldValue
        // 反向注册：当用户再次撤销（即重做）时恢复新值
        let newValue = currentTextFieldValue()
        undoManager.registerUndo(withTarget: self, 
                               selector: #selector(restoreTextFieldValue(_:)),
                               object: newValue)
    }
}

3. 绑定快捷键

在菜单项或响应链中关联系统标准快捷键：

// 在AppDelegate或WindowController中
func applicationDidFinishLaunching(_ notification: Notification) {
    let mainMenu = NSApp.mainMenu
    if let editMenu = mainMenu?.item(withTitle: "Edit")?.submenu {
        // 撤销菜单项
        let undoItem = NSMenuItem(title: "Undo", 
                                action: #selector(undoAction), 
                                keyEquivalent: "z")
        undoItem.keyEquivalentModifierMask = [.command]
        // 重做菜单项
        let redoItem = NSMenuItem(title: "Redo", 
                                action: #selector(redoAction), 
                                keyEquivalent: "Z")
        redoItem.keyEquivalentModifierMask = [.command, .shift]
        editMenu.addItem(undoItem)
        editMenu.addItem(redoItem)
    }
}
@objc private func undoAction() {
    undoManager?.undo()
}
@objc private func redoAction() {
    undoManager?.redo()
}

4. 高级场景处理

批量操作优化

对于连续快速输入等场景，可通过手动分组控制撤销粒度：

func handleBatchUpdate() {
    undoManager?.beginUndoGrouping()
    defer { undoManager?.endUndoGrouping() }
    // 执行多个相关操作
    textField?.stringValue = "First update"
    textField?.stringValue = "Second update"
}

操作命名

为不同操作类型设置有意义的名称，提升用户体验：

undoManager?.setActionName("Change Font Size")
// 或通过枚举管理操作类型
enum TextOperation {
    case typing, formatting, deletion
}

完整实现示例

class AdvancedTextFieldController: NSObject, NSTextFieldDelegate {
    private let undoManager = NSUndoManager()
    private weak var textField: NSTextField?
    init(textField: NSTextField) {
        self.textField = textField
        super.init()
        configureTextField()
    }
    private func configureTextField() {
        textField?.delegate = self
        textField?.allowsEditingTextAttributes = true
        // 配置撤销管理器
        undoManager.levelsOfUndo = 50
        undoManager.groupingInterval = 0.5 // 半秒内的操作合并
    }
    // MARK: - NSTextFieldDelegate
    func controlTextDidChange(_ obj: Notification) {
        guard 
            let textField = obj.object as? NSTextField,
            let currentValue = textField.stringValue 
        else { return }
        // 注册撤销操作
        let target = self
        let selector = #selector(restoreText(_:))
        undoManager.registerUndo(withTarget: target, 
                               selector: selector, 
                               object: currentValue)
        undoManager.setActionName("Text Edit")
    }
    @objc private func restoreText(_ text: String) {
        guard let textField = textField else { return }
        // 保存当前状态用于重做
        let currentValue = textField.stringValue
        undoManager.registerUndo(withTarget: self, 
                               selector: #selector(restoreText(_:)), 
                               object: currentValue)
        // 执行实际恢复
        textField.stringValue = text
    }
    // MARK: - Public API
    func undo() {
        undoManager.undo()
    }
    func redo() {
        undoManager.redo()
    }
    func canUndo() -> Bool {
        return undoManager.canUndo
    }
    func canRedo() -> Bool {
        return undoManager.canRedo
    }
}

最佳实践建议

操作粒度控制：根据业务场景调整groupingInterval，文本编辑通常建议0.3-0.5秒
内存管理：对于大型文档，考虑限制levelsOfUndo避免内存过度消耗
状态验证：在执行撤销/重做前检查对象有效性，防止野指针错误
协同编辑：在多窗口/多视图场景中，确保使用同一个NSUndoManager实例
持久化支持：如需保存撤销历史，可通过NSUndoManager的编码协议实现

总结

通过合理使用NSUndoManager，开发者可以轻松为NSTextField构建符合macOS人机交互指南的撤销/重做功能。本文提供的实现方案不仅覆盖了基础场景，还包含了批量操作处理、操作命名等高级特性。在实际开发中，建议结合具体业务需求调整分组策略和历史记录深度，以在用户体验和系统资源消耗之间取得平衡。

macOS开发进阶：NSTextField文本编辑的撤销与重做实现

引言