Queryable.SingleOrDefault 方法

定义

命名空间:

System.Linq

程序集:

System.Linq.Queryable.dll

返回序列中单个特定元素，如果未找到这样的元素，则返回默认值。

重载

SingleOrDefault<TSource>(IQueryable<TSource>, TSource)	返回序列中的唯一元素；如果该序列为空，则返回默认值；如果该序列包含多个元素，此方法将引发异常。
SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)	返回序列中满足指定条件的唯一元素；如果这类元素不存在，则返回默认值；如果有多个元素满足该条件，此方法将引发异常。
SingleOrDefault<TSource>(IQueryable<TSource>)	返回序列中的唯一元素；如果该序列为空，则返回默认值；如果该序列包含多个元素，此方法将引发异常。
SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)	返回序列中满足指定条件的唯一元素；如果这类元素不存在，则返回默认值；如果有多个元素满足该条件，此方法将引发异常。

SingleOrDefault<TSource>(IQueryable<TSource>, TSource)

Source:

Queryable.cs

返回序列中的唯一元素；如果该序列为空，则返回默认值；如果该序列包含多个元素，此方法将引发异常。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Linq::IQueryable<TSource> ^ source, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, TSource defaultValue);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IQueryable(Of TSource), defaultValue As TSource) As TSource

类型参数

TSource

source 的元素类型。

参数

source

IQueryable<TSource>

要返回其单个元素的 IEnumerable<T>。

defaultValue

TSource

如果序列为空，则返回的默认值。

返回

TSource

输入序列的单个元素，如果 defaultValue 序列不包含任何元素，则为 。

例外

ArgumentNullException

source 为 null。

InvalidOperationException

输入序列包含多个元素。

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)

Source:

Queryable.cs

返回序列中满足指定条件的唯一元素；如果这类元素不存在，则返回默认值；如果有多个元素满足该条件，此方法将引发异常。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate, TSource defaultValue);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IQueryable(Of TSource), predicate As Expression(Of Func(Of TSource, Boolean)), defaultValue As TSource) As TSource

类型参数

TSource

source 的元素类型。

参数

source

IQueryable<TSource>

要从中返回单个元素的 IEnumerable<T>。

predicate

Expression<Func<TSource,Boolean>>

用于测试元素是否满足条件的函数。

defaultValue

TSource

如果序列为空，则返回的默认值。

返回

TSource

满足条件的输入序列的单个元素;如果未找到此类元素， defaultValue 则为 。

例外

ArgumentNullException

source 或 predicate 为 null。

InvalidOperationException

多个元素满足 predicate 中的条件。

SingleOrDefault<TSource>(IQueryable<TSource>)

Source:

Queryable.cs

返回序列中的唯一元素；如果该序列为空，则返回默认值；如果该序列包含多个元素，此方法将引发异常。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Linq::IQueryable<TSource> ^ source);

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source);

static member SingleOrDefault : System.Linq.IQueryable<'Source> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IQueryable(Of TSource)) As TSource

类型参数

TSource

source 的元素类型。

参数

source

IQueryable<TSource>

要返回其单个元素的 IQueryable<T>。

返回

TSource

输入序列中的单个元素；如果序列不包含任何元素，则为 default(TSource)。

例外

ArgumentNullException

source 为 null。

InvalidOperationException

source 具有多个元素。

示例

下面的代码示例演示如何使用 SingleOrDefault<TSource>(IQueryable<TSource>) 选择数组的唯一元素。 第二个查询演示当 SingleOrDefault<TSource>(IQueryable<TSource>) 序列不包含正好包含一个元素时返回默认值。

// Create two arrays. The second is empty.
string[] fruits1 = { "orange" };
string[] fruits2 = { };

// Get the only item in the first array, or else
// the default value for type string (null).
string fruit1 = fruits1.AsQueryable().SingleOrDefault();
Console.WriteLine("First Query: " + fruit1);

// Get the only item in the second array, or else
// the default value for type string (null).
string fruit2 = fruits2.AsQueryable().SingleOrDefault();
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: orange
    Second Query: No such string!
*/

' Create two arrays. The second is empty.
Dim fruits1() As String = {"orange"}
Dim fruits2() As String = {}

' Get the only item in the first array, or else
' the default value for type string (null).
Dim fruit1 As String = fruits1.AsQueryable().SingleOrDefault()
MsgBox("First Query: " + fruit1)

' Get the only item in the second array, or else
' the default value for type string (null). 
Dim fruit2 As String = fruits2.AsQueryable().SingleOrDefault()
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: orange
' Second Query: No such string!

有时， default(TSource) 如果集合不包含任何元素，则 的值不是要使用的默认值。 可以使用 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 方法指定要在集合为空时要使用的默认值，而不是检查结果中不需要的默认值，然后在必要时对其进行更改。 然后，调用 Single<TSource>(IQueryable<TSource>) 以获取 元素。 如果页码集合为空，下面的代码示例使用这两种方法获取默认值 1。 由于整数的默认值为 0，这通常不是有效的页码，因此必须将默认值指定为 1。 查询完成后，将检查第一个结果变量是否为不需要的默认值。 第二个结果变量是通过调用 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 将默认值指定为 1 来获取的。

int[] pageNumbers = { };

// Setting the default value to 1 after the query.
int pageNumber1 = pageNumbers.AsQueryable().SingleOrDefault();
if (pageNumber1 == 0)
{
    pageNumber1 = 1;
}
Console.WriteLine("The value of the pageNumber1 variable is {0}", pageNumber1);

// Setting the default value to 1 by using DefaultIfEmpty() in the query.
int pageNumber2 = pageNumbers.AsQueryable().DefaultIfEmpty(1).Single();
Console.WriteLine("The value of the pageNumber2 variable is {0}", pageNumber2);

/*
 This code produces the following output:

 The value of the pageNumber1 variable is 1
 The value of the pageNumber2 variable is 1
*/

Dim pageNumbers() As Integer = {}

' Setting the default value to 1 after the query.
Dim pageNumber1 As Integer = pageNumbers.AsQueryable().SingleOrDefault()
If pageNumber1 = 0 Then
    pageNumber1 = 1
End If
MsgBox(String.Format("The value of the pageNumber1 variable is {0}", pageNumber1))

' Setting the default value to 1 by using DefaultIfEmpty() in the query.
Dim pageNumber2 As Integer = pageNumbers.AsQueryable().DefaultIfEmpty(1).Single()
MsgBox(String.Format("The value of the pageNumber2 variable is {0}", pageNumber2))

' This code produces the following output:

' The value of the pageNumber1 variable is 1
' The value of the pageNumber2 variable is 1

注解

方法 SingleOrDefault<TSource>(IQueryable<TSource>) 生成一个 ， MethodCallExpression 表示将调用 SingleOrDefault<TSource>(IQueryable<TSource>) 自身作为构造的泛型方法。 然后，MethodCallExpressionExecute<TResult>(Expression)它将 传递给 由 Provider 参数的 属性表示的 的 source 方法IQueryProvider。

由于执行表示调用 SingleOrDefault<TSource>(IQueryable<TSource>) 的表达式树而发生的查询行为取决于参数类型的 source 实现。 预期的行为是，如果 为空，则返回 中 source的唯一元素或默认值 source 。

方法 SingleOrDefault 不提供指定默认值的方法。 如果要指定除 以外的 default(TSource)默认值，请使用 方法， DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 如示例部分所述。

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)

Source:

Queryable.cs

返回序列中满足指定条件的唯一元素；如果这类元素不存在，则返回默认值；如果有多个元素满足该条件，此方法将引发异常。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate);

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IQueryable(Of TSource), predicate As Expression(Of Func(Of TSource, Boolean))) As TSource

类型参数

TSource

source 的元素类型。

参数

source

IQueryable<TSource>

要从中返回单个元素的 IQueryable<T>。

predicate

Expression<Func<TSource,Boolean>>

用于测试元素是否满足条件的函数。

返回

TSource

满足 中 predicate条件的输入序列的单个元素，如果没有找到此类元素， default 则 (TSource) 。

例外

ArgumentNullException

source 或 predicate 为 null。

InvalidOperationException

多个元素满足 predicate 中的条件。

示例

下面的代码示例演示如何使用 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 选择满足条件的数组中唯一的元素。 第二个查询演示当 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 序列不包含满足条件的元素时返回默认值。

string[] fruits = { "apple", "banana", "mango",
                      "orange", "passionfruit", "grape" };

// Get the single string in the array whose length is greater
// than 10, or else the default value for type string (null).
string fruit1 =
    fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 10);
Console.WriteLine("First Query: " + fruit1);

// Get the single string in the array whose length is greater
// than 15, or else the default value for type string (null).
string fruit2 =
   fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 15);
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: passionfruit
    Second Query: No such string!
*/

Dim fruits() As String = _
    {"apple", "banana", "mango", "orange", "passionfruit", "grape"}

' Get the single string in the array whose length is greater
' than 10, or else the default value for type string (null).
Dim fruit1 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 10)
' Display the result.
MsgBox("First Query: " & fruit1)

' Get the single string in the array whose length is greater
' than 15, or else the default value for type string (null).
Dim fruit2 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 15)
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: passionfruit
' Second Query: No such string!

注解

此方法至少有一个类型的 Expression<TDelegate> 参数，其类型参数是其中一种 Func<T,TResult> 类型。 对于这些参数，可以传入 lambda 表达式，它将编译为 Expression<TDelegate>。

方法 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 生成一个 ， MethodCallExpression 表示将调用 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 自身作为构造的泛型方法。 然后，MethodCallExpressionExecute<TResult>(Expression)它将 传递给 由 Provider 参数的 属性表示的 的 source 方法IQueryProvider。

由于执行表示调用 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 的表达式树而发生的查询行为取决于参数类型的 source 实现。 预期的行为是，它返回 中 source 唯一满足 指定条件的 predicate元素，如果没有此类元素，则返回默认值。