停止在你的代码中返回 null 集合(C#)_编码文章

在 C# 开发中，正确处理空集合是构建健壮应用程序的关键环节。.NET 框架提供了多种标准机制来实现空集合的安全返回，相比返回 null 值的做法，这些机制能显著降低空引用异常（NullReferenceException）的发生概率。

考虑一个典型的数据访问场景：当数据库查询没有返回结果时，开发者可能倾向于返回 null。以下代码演示了这种存在风险的实现方式：

public List GetInactiveUsers()
{
    var users = _dbContext.Users.Where(u => u.LastLogin < datetime.now.addyears-1.tolist return users.count> 0 ? users : null; // 危险的 null 返回
}

这种实现强制调用方必须进行防御性检查，导致客户端代码变得冗余且脆弱：

var inactiveUsers = userService.GetInactiveUsers();
if (inactiveUsers != null) // 必须的 null 检查
{
    foreach (var user in inactiveUsers)
    {
        ProcessUser(user);
    }
}

更优雅的解决方案是使用 .NET 框架提供的空集合模式。通过 Enumerable.Empty() 方法可以获取类型安全的不可变空集合：

public IEnumerable GetInactiveUsers()
{
    var users = _dbContext.Users.Where(u => u.LastLogin < datetime.now.addyears-1.tolist return users.count> 0 ? users : Enumerable.Empty();
}

调用方现在可以安全地进行迭代操作，无需任何前置条件检查：

foreach (var user in userService.GetInactiveUsers())
{
    ProcessUser(user); // 自动跳过空集合
}

对于需要返回具体集合类型的场景，C# 6.0 引入的 Array.Empty() 方法提供了高性能的空数组实现：

public User[] GetInactiveUsersArray()
{
    var users = _dbContext.Users.Where(u => u.LastLogin < datetime.now.addyears-1.toarray return users.length> 0 ? users : Array.Empty();
}

这种实现具有以下优势：

内存效率：空数组实例在应用程序域内唯一，避免重复分配
类型安全：保持数组类型的签名一致性
迭代安全：foreach 循环对空数组执行零次迭代

在需要返回可变集合的场景中，可以实例化新的空集合：

public List GetInactiveUsersList()
{
    var users = _dbContext.Users.Where(u => u.LastLogin < datetime.now.addyears-1.tolist return users.count> 0 ? users : new List();
}

对于高级应用场景，.NET 的空对象模式可以通过扩展方法实现。例如创建具有特定行为的空集合：

public class EmptyUserCollection : List
{
    public override bool IsReadOnly => true;
    
    public new IEnumerator GetEnumerator()
    {
        yield break; // 显式声明无元素可迭代
    }
}

public IEnumerable GetInactiveUsersAdvanced()
{
    var users = _dbContext.Users.Where(u => u.LastLogin < datetime.now.addyears-1.tolist return users.count> 0 ? users : new EmptyUserCollection();
}

在性能敏感的场景中，建议优先使用 Enumerable.Empty() 或 Array.Empty()，因为它们在内存中只有单个实例。测试表明，重复调用 Array.Empty() 比每次实例化新列表节省约 97% 的内存分配。

通过遵循这些实践，开发者可以：

消除客户端代码中的 null 检查
减少条件分支导致的代码复杂度
防止因遗漏 null 检查导致的运行时异常
保持 API 接口的简洁性和一致性

现代 C# 代码库中，空集合返回已成为标准实践。结合 Roslyn 分析器的配置（如设置 CS8603 警告），可以在编译期检测潜在的 null 集合返回问题，进一步强化代码质量。对于使用 Entity Framework Core 等 ORM 的场景，建议在仓储层统一实现空集合处理逻辑，确保整个应用程序遵循一致的集合返回策略。

停止在你的代码中返回 null 集合(C#)

相关文章