RealmSwift映射可选JSON报错：List无法作为可选@Persisted属性

核心限制说明 #

RealmSwift的List类型不能声明为可选（List<T>?），因为@Persisted不支持将容器类型放在可选包装中（即报错提示的List<CarouselMedia>不遵循_PersistableInsideOptional）。List本身设计为始终存在，空列表即可代表“无数据”的状态。

报错原因 #

你遇到的The data couldn’t be read because it is missing，是因为默认的Codable解析会将folderItems（对应JSON的items字段）视为必填项，当JSON中不存在该字段时解析失败。

解决方案 #

通过自定义Codable解码逻辑，处理items字段不存在的情况，将空数组或解析到的数组转换为Realm的List：

1. 正确声明Realm对象属性

import RealmSwift

class FolderObject: Object, Codable {
    @Persisted var id: String
    // 其他业务属性...
    @Persisted var folderItems: List<CarouselMedia>
    
    // 定义JSON字段映射
    enum CodingKeys: String, CodingKey {
        case id
        // 其他字段...
        case folderItems = "items"
    }
    
    // 自定义解码逻辑
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        
        // 解码必填属性
        id = try container.decode(String.self, forKey: .id)
        // 解码其他必填属性...
        
        // 处理可选的items字段：不存在则用空数组
        let mediaArray = try container.decodeIfPresent([CarouselMedia].self, forKey: .folderItems) ?? []
        // 将数组元素添加到Realm List中（List不能直接赋值）
        folderItems.append(objectsIn: mediaArray)
        
        // 必须调用Realm的初始化方法
        super.init()
    }
    
    // Realm要求的空初始化器
    override init() {
        super.init()
    }
    
    // 可选：自定义编码逻辑（如果需要将对象转JSON）
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(id, forKey: .id)
        // 将List转为数组后编码
        try container.encode(Array(folderItems), forKey: .folderItems)
    }
}

2. 确保子对象符合Realm+Codable要求

CarouselMedia需继承Object并实现Codable（如果需要JSON解析）：

class CarouselMedia: Object, Codable {
    @Persisted var mediaId: String
    @Persisted var url: String
    // 其他属性...
    
    enum CodingKeys: String, CodingKey {
        case mediaId = "id"
        case url
    }
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        mediaId = try container.decode(String.self, forKey: .mediaId)
        url = try container.decode(String.self, forKey: .url)
        super.init()
    }
    
    override init() {
        super.init()
    }
}

3. 解析JSON并写入Realm

使用标准JSONDecoder或Realm提供的RealmJSONDecoder解析后，即可正常写入数据库：

// 示例：解析JSON Data
let jsonData = """
{
    "id": "folder_1",
    "items": [{"id": "media_1", "url": "https://example.com/1.jpg"}]
}
""".data(using: .utf8)!

do {
    let folder = try JSONDecoder().decode(FolderObject.self, from: jsonData)
    let realm = try Realm()
    try realm.write {
        realm.add(folder)
    }
} catch {
    print("解析或写入错误：\(error)")
}

关键要点 #

• 永远不要将List声明为可选，用空List表示无数据。
• 用decodeIfPresent替代decode处理可选JSON字段，避免字段缺失导致的解析错误。
• Realm的List不能直接赋值，需通过append(objectsIn:)方法添加数组元素。

内容的提问来源于stack exchange，提问作者Shin0mar