UITableViewDiffableDataSource是否不支持nil？运行报错求助

问题描述 #

代码示例 #

import UIKit

struct Language: Hashable {
    let name: String
}

enum Section {
    case main
}

class ViewController: UIViewController, UITableViewDelegate {
    var tableView: UITableView!
    private typealias DataSource = UITableViewDiffableDataSource<Section, Language?>

    private var dataSource: DataSource!

    override func viewDidLoad() {
        super.viewDidLoad()
        
        // Set up the table view
        tableView = UITableView(frame: view.bounds)
        view.addSubview(tableView)
        
        // Register a simple cell
        tableView.register(UITableViewCell.self, forCellReuseIdentifier: "cell")
        
        // Set up the data source
        dataSource = DataSource(tableView: tableView) { tableView, indexPath, language in
            let cell = tableView.dequeueReusableCell(withIdentifier: "cell", for: indexPath)
            
            // Check if the language is nil and configure the cell accordingly
            if let language = language {
                cell.textLabel?.text = language.name
            } else {
                cell.textLabel?.text = "No Language"
            }
            return cell
        }
        
        // Set up the snapshot with some sample data including nil
        var snapshot = NSDiffableDataSourceSnapshot<Section, Language?>()
        snapshot.appendSections([.main])
        snapshot.appendItems([Language(name: "English"), nil, Language(name: "Spanish"), Language(name: "French")])
        
        // Apply the snapshot to the data source
        dataSource.apply(snapshot, animatingDifferences: true)
        
        tableView.delegate = self
    }
}

运行错误 #

Could not cast value of type 'NSNull' (0x1ec78e900) to 'xxx.Language' (0x1008e0468).

用户疑问 #

UITableViewDiffableDataSource 是否不支持 nil？在官方文档中未找到相关限制说明，盼解答。

原因分析 #

UITableViewDiffableDataSource 底层依赖 Foundation 框架的类型桥接机制，当使用可空的 Language? 作为 Item 类型时，nil 会被自动桥接为 NSNull。但在系统内部处理数据时，会尝试将 NSNull 强制转换回 Language 类型，这就触发了类型转换失败的崩溃。

虽然官方文档未明确标注这一限制，但 Diffable Data Source 的设计逻辑要求 Item 类型必须是非空的、可哈希的对象类型，nil 并不符合这个隐含要求。

解决方案 #

避免直接用 nil 作为数据源 Item，通过包装类型或特殊实例表达“空”状态：

方案1：枚举包装空状态 #

定义包含“有值”和“无值”的枚举，替代可空类型：

enum LanguageItem: Hashable {
    case language(Language)
    case noLanguage
}

修改数据源和快照的类型适配：

private typealias DataSource = UITableViewDiffableDataSource<Section, LanguageItem>

// 数据源配置
dataSource = DataSource(tableView: tableView) { tableView, indexPath, item in
    let cell = tableView.dequeueReusableCell(withIdentifier: "cell", for: indexPath)
    switch item {
    case .language(let lang):
        cell.textLabel?.text = lang.name
    case .noLanguage:
        cell.textLabel?.text = "No Language"
    }
    return cell
}

// 构建快照
var snapshot = NSDiffableDataSourceSnapshot<Section, LanguageItem>()
snapshot.appendSections([.main])
snapshot.appendItems([.language(Language(name: "English")), .noLanguage, .language(Language(name: "Spanish")), .language(Language(name: "French"))])

方案2：特殊实例表示空状态 #

给 Language 添加静态的“空”实例，替代 nil：

struct Language: Hashable {
    let name: String
    
    static let empty = Language(name: "No Language")
}

在数据源中直接使用该实例：

// 构建快照时用 empty 替代 nil
snapshot.appendItems([Language(name: "English"), .empty, Language(name: "Spanish"), Language(name: "French")])

// Cell 配置无需判断 nil
cell.textLabel?.text = language.name

内容的提问来源于stack exchange，提问作者Cheok Yan Cheng