Enumerable.DefaultIfEmpty 方法

定义

返回 IEnumerable<T>的元素;如果序列为空,则返回默认值单一实例集合。

重载

DefaultIfEmpty<TSource>(IEnumerable<TSource>)

如果序列为空,则返回指定序列的元素或类型参数在单一实例集合中的默认值。

DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource)

如果序列为空,则返回指定序列的元素或单个实例集合中的指定值。

DefaultIfEmpty<TSource>(IEnumerable<TSource>)

Source:
DefaultIfEmpty.cs
Source:
DefaultIfEmpty.cs
Source:
DefaultIfEmpty.cs

如果序列为空,则返回指定序列的元素或类型参数在单一实例集合中的默认值。

public static System.Collections.Generic.IEnumerable<TSource> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);
public static System.Collections.Generic.IEnumerable<TSource?> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);

类型参数

TSource

source的元素的类型。

参数

source
IEnumerable<TSource>

返回默认值的序列(如果为空)。

返回

IEnumerable<TSource>

一个 IEnumerable<T> 对象,该对象包含 TSource 类型的默认值(如果 source 为空);否则,source

例外

source null

示例

下面的代码示例演示如何使用 DefaultIfEmpty<TSource>(IEnumerable<TSource>) 提供默认值,以防源序列为空。

此示例使用非空序列。

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void DefaultIfEmptyEx1()
{
    List<Pet> pets =
        new List<Pet>{ new Pet { Name="Barley", Age=8 },
                       new Pet { Name="Boots", Age=4 },
                       new Pet { Name="Whiskers", Age=1 } };

    foreach (Pet pet in pets.DefaultIfEmpty())
    {
        Console.WriteLine(pet.Name);
    }
}

/*
 This code produces the following output:

 Barley
 Boots
 Whiskers
*/

此示例使用空序列。

List<int> numbers = new List<int>();

foreach (int number in numbers.DefaultIfEmpty())
{
    Console.WriteLine(number);
}

/*
 This code produces the following output:

 0
*/

注解

此方法是使用延迟执行实现的。 即时返回值是一个对象,用于存储执行操作所需的所有信息。 只有在直接调用对象 GetEnumerator 方法或在 C# 中使用 foreach 或在 Visual Basic 中使用 For Each 来枚举对象,否则不会执行此方法表示的查询。

引用和可为 null 类型的默认值 null

当此方法与 GroupJoin 方法结合使用时,该方法可用于生成左外部联接。

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource)

Source:
DefaultIfEmpty.cs
Source:
DefaultIfEmpty.cs
Source:
DefaultIfEmpty.cs

如果序列为空,则返回指定序列的元素或单个实例集合中的指定值。

public static System.Collections.Generic.IEnumerable<TSource> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource defaultValue);

类型参数

TSource

source的元素的类型。

参数

source
IEnumerable<TSource>

返回指定值(如果为空)的序列。

defaultValue
TSource

如果序列为空,则返回的值。

返回

IEnumerable<TSource>

如果 source 为空,则包含 defaultValueIEnumerable<T>;否则,source

示例

下面的代码示例演示如何使用 DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) 方法并指定默认值。 第一个序列不为空,第二个序列为空。

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void DefaultIfEmptyEx2()
{
    Pet defaultPet = new Pet { Name = "Default Pet", Age = 0 };

    List<Pet> pets1 =
        new List<Pet>{ new Pet { Name="Barley", Age=8 },
                       new Pet { Name="Boots", Age=4 },
                       new Pet { Name="Whiskers", Age=1 } };

    foreach (Pet pet in pets1.DefaultIfEmpty(defaultPet))
    {
        Console.WriteLine("Name: {0}", pet.Name);
    }

    List<Pet> pets2 = new List<Pet>();

    foreach (Pet pet in pets2.DefaultIfEmpty(defaultPet))
    {
        Console.WriteLine("\nName: {0}", pet.Name);
    }
}

/*
 This code produces the following output:

 Name: Barley
 Name: Boots
 Name: Whiskers

 Name: Default Pet
*/

注解

此方法是使用延迟执行实现的。 即时返回值是一个对象,用于存储执行操作所需的所有信息。 只有在直接调用对象 GetEnumerator 方法或在 C# 中使用 foreach 或在 Visual Basic 中使用 For Each 来枚举对象,否则不会执行此方法表示的查询。

当此方法与 GroupJoin 方法结合使用时,该方法可用于生成左外部联接。

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0