类型注册
本页介绍用户定义类型的注册 API。
为什么必须注册
用户类型,例如 struct、class、enum/union 和 ext 类型,在序列化和反序列化前必须先注册。
如果缺少注册,反序列化会失败,并抛出:
Type not registered: ...
按数值 ID 注册
请为序列化端和反序列化端使用同一个稳定 ID。
@ForyObject
struct User {
var name: String = ""
var age: Int32 = 0
}
let fory = Fory()
fory.register(User.self, id: 1)
按名称注册
使用全限定名
try fory.register(User.self, name: "com.example.User")
name 会按 . 拆分:
- namespace:
com.example - type name:
User
显式指定命名空间和类型名
try fory.register(User.self, namespace: "com.example", name: "User")
一致性规则
在不同对端之间保持注册映射一致:
- ID 模式:同一个逻辑类型在所有对端都使用相同数值 ID
- 名称模式:同一个逻辑类型在所有对端都使用相同 namespace 和 type name
- 不要对同一逻辑类型在不同服务里混用 ID 映射和名称映射
动态类型与注册
当你序列化 Any、AnyObject、any Serializer 这类动态值,且其中包含用户定义类型时,具体运行时类型仍然需要提前注册。