问题的发现

在使用Xcode开发SwiftUI项目时，经常会遇到Xcode持续高CPU占用的问题。以往我没有重视这个问题，经常是很久之后才发现。此时，原本冰冷的Mac mini摸起来已经温热了。为此，我特意开发了一个小工具，提醒我关于这个问题。

App Helper

问题的解决

最初，我发现这个问题出现的几率，和我打开的SwiftUI的文件的数量相关。打开的SwiftUI的文件越多，越有可能遇到这个问题。

就在我以为这就是真正的原因，并发文之后，我在仅打开2-3个SwiftUI文件的时候又遇到了这个问题。这次，我终于找到了是哪个文件导致的这个问题了。是MainView。应该是文件功能太多导致的。我的MainView，是一个接近2000行的文件。它包含多项功能：

1. 主视图布局，侧栏视图实现
2. 工具栏实现
3. 各种错误弹窗处理
4. 文件处理（打开、解析、保存）
5. 用户订阅状态管理等。

我尝试将代码分离按照功能为多个小文件。但是问题仍旧存在。最后发现，解决的办法就是注释掉预览的代码。

关于这个问题的一些补充

1. CPU占用过高是因为MainView的功能太多导致的。
2. 将MainView的代码拆分到多个文件不能解决这个问题。
3. 即便MainView没有在预览，即预览视图显示为刷新按钮的状态。也还是会有这个问题。也就是说，只要预览视图开着，不管有没有要求运行预览，都会导致Xcode的CPU高占用。
4. 此时，就算关闭了预览也没有用。所以，后台应该是某种卡死的状态。
5. 解决办法只有
   1. 直接关闭预览。
   2. 一开始就不开预览。

长久以来，SwiftUI下的其中的一个坑就是NavigationView，它在使用@ObservedObject时，会出现界面回退的问题。

SwiftUI NavigationView pops back when updating observableObject

我原本以为随着NavigationView被反对，替代为NavigationSplitView和NavigationStack之后，这个问题也就消失了。但是没相当，这个问题在NavigationSplitView中仍旧存在。

实在没办法，我想到是否可以使用@Observable来替代ObservableObject。采用这个办法的主要缺点是前者只有最新一代的系统iOS 17、macOS 14才支持。但是好在我这个涉及到的应用是伴随Xcode发布的。因此，使用我的应用的用户应该主要是使用最新的系统。

从ObservableObject迁移到@Observable还是比较简单的。只需要跟随官方的文档一步一步操作即可。

Migrating from the Observable Object protocol to the Observable macro

不过，这里我还要额外再说两点：

1. 苹果说@ObservedObject可以直接拿掉。因为Swift会自动管理。但是实际使用中，必须得加上@State，状态才能正常改变。
   1. 也就是说，你可以先拿掉看看，如果不正常，就在前面加个@State。这个是我自己发现的。
2. 苹果说@Observable的class可以使用@StateObject，这是为了逐步迁移，但是实际上@StateObject并不支持@Observable的class，提示必须得是ObservableObject才行。

我们已经很习惯使用第三方的库来调用UserDefaults了。但是有时我们也需要只使用苹果官方的框架来实现相同的功能。

1. 创建Key
2. 注册iCloud的变化
3. 更新userdefaults
4. 注册Key的变化
5. 更新iCloud

创建Key

extension UserDefaults {
  static let text = "text"
}

注册iCloud的变化

class AppDelegate: NSObject, NSApplicationDelegate {
  @AppStorage(UserDefaults.text) private var text: String = "Hello, Zhao!"

  func applicationDidFinishLaunching(_ notification: Notification) {
    registerKeyValueSyncing()
  }
}

extension AppDelegate {
  private func registerKeyValueSyncing() {
    NotificationCenter.default.addObserver(forName: NSUbiquitousKeyValueStore.didChangeExternallyNotification, object: NSUbiquitousKeyValueStore.default, queue: nil) { [self] notification in
      guard let userInfo = notification.userInfo else { return }
      guard let reasonForChange = userInfo[NSUbiquitousKeyValueStoreChangeReasonKey] as? Int else { return }
      guard let keys = userInfo[NSUbiquitousKeyValueStoreChangedKeysKey] as? [String] else { return }
      guard keys.contains(UserDefaults.text) else { return }

      if reasonForChange == NSUbiquitousKeyValueStoreAccountChange {
        text = "Hello, Zhao!"
        return
      }

      if let newText = NSUbiquitousKeyValueStore.default.string(forKey: UserDefaults.text),
         newText != text {
        text = newText
        print("update text to \(text)")
      }
    }

    UserDefaults.standard.addObserver(self, forKeyPath: UserDefaults.text, options: [.new, .initial], context: nil)
  }

  override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
    guard let keyPath, keyPath == UserDefaults.text else { return }

    if let change {
      print("[debug] change is \(change)")

      if let newText = change[.newKey] as? String {
        NSUbiquitousKeyValueStore.default.set(newText, forKey: keyPath)
      }
    }
  }
}

主程序

@main
struct KeyValueSyncingApp: App {
  #if os(macOS)
  @NSApplicationDelegateAdaptor private var appDelegate: AppDelegate
  #else
  @UIApplicationDelegateAdaptor private var appDelegate: AppDelegate
  #endif

  var body: some Scene {
    WindowGroup {
      ContentView()
    }
  }
}