肇鑫的技术博客

没想到我还是入了SwiftData的坑。没想到坑还挺深。没想到苹果连最基本的Xcode的模版应用都没有做好。没想到连苹果的文档说明都不全。

最近我开了一个新坑，是一个背单词的小应用。因为是新应用，而且需要转换词库文件从json到数据库，于是选择了SwiftData作为中介。问题由此而来。

按照惯例，我本以为新应用使用SwiftData会很简单。只需要在应用创建时，选择SwiftData，然后选中使用iCloud同步，最后选择创建应用就可以了。

结果是不行。

这么创建的其实只包括本地的部分以及使用iCloud的部分配置。效果是并没能真正开启iCloud同步。

苹果做了什么

苹果创建了模型，但是模型不符合CloudKit的规范

众所周知，苹果程序模版创建的模型是一个叫Item的类。在Core Data时，它创建的与iCloud同步的模版应用是可用的。但是在SwiftData时，模版创建的应用实际上iCloud的同步不可用。

https://developer.apple.com/documentation/swiftdata/syncing-model-data-across-a-persons-devices

如同上面的链接所说，iCloud因为不定期同步的关系。它必须要求所有属性要么有默认值，要么是Optional。（这一点与Core Data一致）

但是苹果模版程序创建的模版Item的属性却是Date，而非Date？

修改了这个问题之后，我们再根据Xcode的提示修改相关的几处代码，直到Xcode可以编译通过。

苹果创建了部分CloudKit同步的设置，但是设置不全

这里的问题就更大了。因为文档说得也不够全面。根据上面链接的文档，SwiftData同步需要3步：

获取iCloud权限，激活CloudKit，创建一个或选择一个已有的Container。
设置后台运行模式，激活远程通知选项。
修改ModelConfiguration()设置。

下面我来依次说说这三点里哪些苹果没做到，哪些苹果太啰嗦，哪些又是苹果所遗漏的。

苹果没做到

第一条：获取iCloud权限，激活CloudKit，创建一个或选择一个已有的Container。
苹果做了前两项，然后没做第三项。我们需要自己创建或者选择一个已有的容器。

苹果太啰嗦

第三条：修改ModelConfiguration()设置。
苹果针对这条的讲解没有错。但是太过啰嗦。苹果的示例是手工添加一个私有的数据库用于同步。但是其实如果你只使用一个数据库，那么就没必要这么做。因为SwiftData默认就是使用你选择的那个唯一的数据库。

苹果所遗漏的

做完了以上的那些。你会发先你的数据库内容仍旧没有同步。这是为什么呢？这就是苹果所遗漏的。同步数据库我们需要什么？需要上网啊。因此，你必须还要打开网络功能的Client权限。所谓Client权限就是你的应用访问外部的权限。如果你的应用还提供服务供其他设备访问，你还需要打开Server权限。

好了。经过以上的补救措施。苹果的模版程序算是完整了。可以正常的运行并同步了。

使用CloudKit时，SwiftData会有哪些改变？

还是上面的那个链接。那个链接的内容非常重要，一定要看。

当开启了iCloud同步之后，SwiftData会失去以下功能。

@Attribute，失去unique的属性。苹果说这是因为CloudKit的同步原理本身造成了它没法保证属性unique不重复。
- 因此，我们在开发时，需要保证数据的unique性。即不能依赖unique性来添加数据，而应该先查询，没有再添加。
@Relationship，这里有3点
- Optional。上面提到了
- SwiftData automatically sets the inverse of a relationship if it can reliably infer that inverse from your schema.这里之所以把苹果的原文放上来，是因为这句话具有迷惑性。初看这句话的时候，我认为苹果说的意思是，只要两个属性彼此拥有对方，SwiftData就会自动隐藏添加inverse的关系。比如像这样

@Model
final class Owner {
  var name: String?
  var pets: [Pet]? = []

  init(name: String) {
    self.name = name
  }
}

@Model
final class Pet {
  var name: String?
  var species: String?
  var owner: Owner?

  init(name: String, species: String) {
    self.name = name
    self.species = species
  }
}

但是在之前的使用中，我发现这样的代码，pet添加了owner属性之后，owner里仍然是看不到pet的。

我让AI根据出错信息，修改代码，AI给出的如下：

@Model
final class Owner {
  var name: String?
  @Relationship(deleteRule: .cascade, inverse:\Pet.owner) var pets: [Pet]? = []

  init(name: String) {
    self.name = name
  }
}

@Model
final class Pet {
  var name: String?
  var species: String?
  @Relationship(deleteRule: .cascade, inverse: \Owner.pets) var owner: Owner?

  init(name: String, species: String) {
    self.name = name
    self.species = species
  }
}

然后Xcode提示，这么写也是错的。因为双方都使用inverse，会导致循环引用。

那么怎么做才是对的呢？经过摸索，我发现是这样。

@Model
final class Owner {
  var name: String?
  @Relationship(deleteRule: .cascade) var pets: [Pet]? = []

  init(name: String) {
    self.name = name
  }
}

@Model
final class Pet {
  var name: String?
  var species: String?
  @Relationship(deleteRule: .cascade, inverse: \Owner.pets) var owner: Owner?

  init(name: String, species: String) {
    self.name = name
    self.species = species
  }
}

为什么呢？因为“SwiftData automatically sets the inverse of a relationship if it can reliably infer that inverse from your schema.” 这句话，直译就是“SwiftData会自动设置关系的逆数，如果它可以从您的模式中可靠地推断出该逆数。”看明白了吗？“SwiftData会自动设置”的前提是“它可以从你的模式中可靠地推断出来该逆数”。因此，一个inverse不写，SwiftData就不会尝试推断。两个都写，就会导致循环引用。所以，唯一正确的方式就是只写一边。这对于从Core Data过来的我十分不适应。因为Core Data是自动两边的。如果你没做到，它虽然允许，但是会用黄色的感叹号提示你。

这里充分证明了，学不好英语，理解不了字里行间的意思，那么写代码就会遇到瓶颈。

差点忘记了。还有第三条呢。Relationship的第三条是说，同样是因为受到同步的限制，CloudKit不支持Schema.Relationship.DeleteRule.deny的关系。
- 这一条也就是说，我们在删除之前，需要自己检测，而不能依赖这一条轻易删除。

当JSON文件存在字典时，需要为字典的value创建单独的容器。比如：

{
  "pets": {
    "dog": {
      "name": "Bark",
      "color": "Black"
    },
    "cat": {
      "name": "Miao",
      "color": "White",
      "habit": "play papers"
    }
  }
}

对应的Model应该是

struct Model: Codable {
  var pets: [String: PetContainer]
}

struct PetContainer: Codable {
  var name: String
  var color: String
  var habit: String?
}

增加一层

{
  "animals": {
    "pets": {
      "dog": {
        "name": "Bark",
        "color": "Black"
      },
      "cat": {
        "name": "Miao",
        "color": "White",
        "habit": "play papers"
      }
    }
  }
}

对应model：

struct Animal: Codable {
  var animals: [String: [String: PetContainer]]
}

再增加一层

{
  "object": {
    "animals": {
      "pets": {
        "dog": {
          "name": "Bark",
          "color": "Black"
        },
        "cat": {
          "name": "Miao",
          "color": "White",
          "habit": "play papers"
        }
      }
    }
  }
}