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)

Исходный код:

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)

Исходный код:

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>)

Исходный код:

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) метод объекта , IQueryProvider представленный свойством Providersource параметра .

Поведение запроса, возникающее в результате выполнения дерева выражений, представляющего вызов SingleOrDefault<TSource>(IQueryable<TSource>) , зависит от реализации типа source параметра. Ожидаемое поведение заключается в том, что он возвращает единственный элемент в sourceили значение по умолчанию, если source является пустым.

Метод SingleOrDefault не позволяет указать значение по умолчанию. Если вы хотите указать значение по умолчанию, отличное от default(TSource), используйте DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) метод , как описано в разделе Пример.

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

Исходный код:

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> типов. Для этих параметров можно передать лямбда-выражение, и оно будет скомпилировано Expression<TDelegate>в .

Метод SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) создает объект , MethodCallExpression представляющий вызов SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) как сконструированный универсальный метод. Затем он передает в MethodCallExpressionExecute<TResult>(Expression) метод объекта , IQueryProvider представленный свойством Providersource параметра .

Поведение запроса, возникающее в результате выполнения дерева выражений, представляющего вызов SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) , зависит от реализации типа source параметра. Ожидаемое поведение заключается в том, что он возвращает единственный элемент в source , который удовлетворяет условию, заданному параметром predicate, или значение по умолчанию, если такой элемент не существует.