Queryable.FirstOrDefault Método

Definição

Namespace:

System.Linq

Assembly:

System.Linq.Queryable.dll

Retorna o primeiro elemento de uma sequência ou um valor padrão caso não seja encontrado nenhum elemento.

Sobrecargas

FirstOrDefault<TSource>(IQueryable<TSource>)	Retorna o primeiro elemento de uma sequência ou um valor padrão se a sequência não contém elementos.
FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)	Retorna o primeiro elemento de uma sequência que atende a uma condição especificada ou um valor padrão se esse elemento não é encontrado.
FirstOrDefault<TSource>(IQueryable<TSource>, TSource)	Retorna o primeiro elemento de uma sequência ou um valor padrão se a sequência não contém elementos.
FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)	Retorna o primeiro elemento da sequência que satisfaz uma condição ou um valor padrão, caso esse elemento não seja encontrado.

FirstOrDefault<TSource>(IQueryable<TSource>)

Origem:

Queryable.cs

Retorna o primeiro elemento de uma sequência ou um valor padrão se a sequência não contém elementos.

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

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

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

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

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IQueryable<TSource>

O IQueryable<T> do qual o primeiro elemento será retornado.

Retornos

TSource

default(TSource) se source estiver vazio; caso contrário, o primeiro elemento em source.

Exceções

ArgumentNullException

source é null.

Exemplos

O exemplo de código a seguir demonstra como usar FirstOrDefault<TSource>(IQueryable<TSource>) em uma sequência vazia.

// Create an empty array.
int[] numbers = { };
// Get the first item in the array, or else the
// default value for type int (0).
int first = numbers.AsQueryable().FirstOrDefault();

Console.WriteLine(first);

/*
    This code produces the following output:

    0
*/

' Create an empty array.
Dim numbers() As Integer = {}
' Get the first item in the array, or else the 
' default value for type int, which is 0.
Dim first As Integer = numbers.AsQueryable().FirstOrDefault()

MsgBox(first)

' This code produces the following output:

' 0

Às vezes, o valor de default(TSource) não é o valor padrão que você deseja usar se a coleção não contiver elementos. Em vez de verificar o resultado do valor padrão indesejado e alterá-lo, se necessário, você pode usar o DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) método para especificar o valor padrão que deseja usar se a coleção estiver vazia. Em seguida, chame First<TSource>(IQueryable<TSource>) para obter o primeiro elemento. O exemplo de código a seguir usa ambas as técnicas para obter um valor padrão de 1 se uma coleção de meses numéricos estiver vazia. Como o valor padrão de um inteiro é 0, que não corresponde a nenhum mês, o valor padrão deve ser especificado como 1. A primeira variável de resultado é verificada quanto ao valor padrão indesejado após a conclusão da consulta. A segunda variável de resultado é obtida chamando DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) para especificar um valor padrão de 1.

List<int> months = new List<int> { };

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

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

/*
 This code produces the following output:

 The value of the firstMonth1 variable is 1
 The value of the firstMonth2 variable is 1
*/

Dim months As New List(Of Integer)(New Integer() {})

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

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

' This code produces the following output:
'
' The value of the firstMonth1 variable is 1
' The value of the firstMonth2 variable is 1

Comentários

O FirstOrDefault<TSource>(IQueryable<TSource>) método gera um MethodCallExpression que representa chamar FirstOrDefault<TSource>(IQueryable<TSource>) a si mesmo como um método genérico construído. Em seguida, ele passa o MethodCallExpression para o Execute<TResult>(Expression) método do IQueryProvider representado pela Provider propriedade do source parâmetro .

O comportamento da consulta que ocorre como resultado da execução de uma árvore de expressão que representa a chamada FirstOrDefault<TSource>(IQueryable<TSource>) depende da implementação do tipo do source parâmetro. O comportamento esperado é que ele retorna o primeiro elemento em sourceou um valor padrão se source estiver vazio.

O FirstOrDefault método não fornece uma maneira de especificar o valor padrão a ser retornado se source estiver vazio. Se você quiser especificar um valor padrão diferente de default(TSource), use o DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) método , conforme descrito na seção Exemplo.

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

Origem:

Queryable.cs

Retorna o primeiro elemento de uma sequência que atende a uma condição especificada ou um valor padrão se esse elemento não é encontrado.

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

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

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

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

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IQueryable<TSource>

Um IQueryable<T> do qual um elemento será retornado.

predicate

Expression<Func<TSource,Boolean>>

Uma função para testar cada elemento em relação a uma condição.

Retornos

TSource

default(TSource) se source estiver vazio ou se nenhum elemento for aprovado no teste especificado por predicate; caso contrário, o primeiro elemento em source que for aprovado no teste especificado por predicate.

Exceções

ArgumentNullException

source ou predicate é null.

Exemplos

O exemplo de código a seguir demonstra como usar FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) passando um predicado. Na segunda consulta, não há nenhum elemento na sequência que satisfaça a condição.

string[] names = { "Hartono, Tommy", "Adams, Terry",
                     "Andersen, Henriette Thaulow",
                     "Hedlund, Magnus", "Ito, Shu" };

// Get the first string in the array that is longer
// than 20 characters, or the default value for type
// string (null) if none exists.
string firstLongName =
    names.AsQueryable().FirstOrDefault(name => name.Length > 20);

Console.WriteLine("The first long name is '{0}'.", firstLongName);

// Get the first string in the array that is longer
// than 30 characters, or the default value for type
// string (null) if none exists.
string firstVeryLongName =
    names.AsQueryable().FirstOrDefault(name => name.Length > 30);

Console.WriteLine(
    "There is {0} name that is longer than 30 characters.",
    string.IsNullOrEmpty(firstVeryLongName) ? "NOT a" : "a");

/*
    This code produces the following output:

    The first long name is 'Andersen, Henriette Thaulow'.
    There is NOT a name that is longer than 30 characters.
*/

Dim names() As String = {"Hartono, Tommy", "Adams, Terry", _
                     "Andersen, Henriette Thaulow", _
                     "Hedlund, Magnus", "Ito, Shu"}

' Get the first string in the array that is longer
' than 20 characters, or the default value for type
' string (null) if none exists.
Dim firstLongName As String = _
            names.AsQueryable().FirstOrDefault(Function(name) name.Length > 20)

MsgBox(String.Format("The first long name is '{0}'.", firstLongName))

' Get the first string in the array that is longer
' than 30 characters, or the default value for type
' string (null) if none exists.
Dim firstVeryLongName As String = _
    names.AsQueryable().FirstOrDefault(Function(name) name.Length > 30)

MsgBox(String.Format( _
    "There is {0} name that is longer than 30 characters.", _
    IIf(String.IsNullOrEmpty(firstVeryLongName), "NOT a", "a")))

' This code produces the following output:
'
' The first long name is 'Andersen, Henriette Thaulow'.
' There is NOT a name that is longer than 30 characters.

Comentários

Esse método tem pelo menos um parâmetro do tipo Expression<TDelegate> cujo argumento de tipo é um dos Func<T,TResult> tipos. Para esses parâmetros, você pode passar uma expressão lambda e ela será compilada para um Expression<TDelegate>.

O FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) método gera um MethodCallExpression que representa chamar FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) a si mesmo como um método genérico construído. Em seguida, ele passa o MethodCallExpression para o Execute<TResult>(Expression) método do IQueryProvider representado pela Provider propriedade do source parâmetro .

O comportamento da consulta que ocorre como resultado da execução de uma árvore de expressão que representa a chamada FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) depende da implementação do tipo do source parâmetro. O comportamento esperado é que ele retorna o primeiro elemento no source que satisfaz a condição em predicateou um valor padrão se nenhum elemento atender à condição.

FirstOrDefault<TSource>(IQueryable<TSource>, TSource)

Origem:

Queryable.cs

Retorna o primeiro elemento de uma sequência ou um valor padrão se a sequência não contém elementos.

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

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

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

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

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IQueryable<TSource>

O IEnumerable<T> do qual o primeiro elemento será retornado.

defaultValue

TSource

O valor padrão a ser retornado se a sequência estiver vazia.

Retornos

TSource

defaultValue se source estiver vazio; caso contrário, o primeiro elemento em source.

Exceções

ArgumentNullException

source é null.

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

Origem:

Queryable.cs

Retorna o primeiro elemento da sequência que satisfaz uma condição ou um valor padrão, caso esse elemento não seja encontrado.

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

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

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

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

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IQueryable<TSource>

Um IEnumerable<T> do qual um elemento será retornado.

predicate

Expression<Func<TSource,Boolean>>

Uma função para testar cada elemento em relação a uma condição.

defaultValue

TSource

O valor padrão a ser retornado se a sequência estiver vazia.

Retornos

TSource

defaultValue se source estiver vazio ou se nenhum elemento passar no teste especificado por predicate; caso contrário, o primeiro elemento em source que passa no teste especificado por predicate.

Exceções

ArgumentNullException

source ou predicate é null.