LINQ: Cuándo usar SingleOrDefault vs. FirstOrDefault () con criterios de filtrado

Considere los métodos de extensión IEnumerable SingleOrDefault()yFirstOrDefault()

MSDN documenta queSingleOrDefault :

Devuelve el único elemento de una secuencia, o un valor predeterminado si la secuencia está vacía; Este método genera una excepción si hay más de un elemento en la secuencia.

mientras que FirstOrDefaulta partir de MSDN (presumiblemente cuando se utiliza un OrderBy()o OrderByDescending()o ninguno en absoluto),

Devuelve el primer elemento de una secuencia.

Considere un puñado de consultas de ejemplo, no siempre está claro cuándo usar estos dos métodos:

var someCust = db.Customers
.SingleOrDefault(c=>c.ID == 5); //unlikely(?) to be more than one, but technically COULD BE

var bobbyCust = db.Customers
.FirstOrDefault(c=>c.FirstName == "Bobby"); //clearly could be one or many, so use First?

var latestCust = db.Customers
.OrderByDescending(x=> x.CreatedOn)
.FirstOrDefault();//Single or First, or does it matter?

Pregunta

¿Qué convenciones sigue o sugiere cuando decide usar SingleOrDefault()y FirstOrDefault()en sus consultas LINQ?

Cada vez que usa SingleOrDefault, declara claramente que la consulta debe dar como resultado un único resultado. Por otro lado, cuando FirstOrDefaultse usa, la consulta puede devolver cualquier cantidad de resultados, pero usted declara que solo desea el primero.

Personalmente, considero que la semántica es muy diferente y usar la apropiada, dependiendo de los resultados esperados, mejora la legibilidad.

Si su conjunto de resultados devuelve 0 registros:

• SingleOrDefault devuelve el valor predeterminado para el tipo (por ejemplo, el valor predeterminado para int es 0)
• FirstOrDefault devuelve el valor predeterminado para el tipo

Si el conjunto de resultados devuelve 1 registro:

• SingleOrDefault devuelve ese registro
• FirstOrDefault devuelve ese registro

Si su conjunto de resultados devuelve muchos registros:

• SingleOrDefault lanza una excepción
• FirstOrDefault devuelve el primer registro

Conclusión:

Si desea que se produzca una excepción si el conjunto de resultados contiene muchos registros, use SingleOrDefault.

Si siempre desea 1 registro sin importar el contenido del conjunto de resultados, use FirstOrDefault

Ahi esta

• una diferencia semántica
• una diferencia de rendimiento

entre los dos.

Diferencia Semántica:

• FirstOrDefault devuelve un primer elemento potencialmente múltiple (o predeterminado si no existe ninguno).
• SingleOrDefaultasume que hay un solo elemento y lo devuelve (o predeterminado si no existe ninguno). Múltiples artículos son una violación del contrato, se lanza una excepción.

Diferencia de rendimiento

• FirstOrDefaultgeneralmente es más rápido, itera hasta que encuentra el elemento y solo tiene que iterar todo el enumerable cuando no lo encuentra. En muchos casos, hay una alta probabilidad de encontrar un artículo.

• SingleOrDefaultnecesita verificar si solo hay un elemento y, por lo tanto, siempre itera todo el enumerable. Para ser precisos, itera hasta que encuentra un segundo elemento y arroja una excepción. Pero en la mayoría de los casos, no hay un segundo elemento.

Conclusión

• Úselo FirstOrDefaultsi no le importa cuántos elementos hay o cuándo no puede permitirse el lujo de comprobar la unicidad (por ejemplo, en una colección muy grande). Cuando verifica la unicidad al agregar los elementos a la colección, puede ser demasiado costoso volver a verificarlo al buscar esos elementos.

• Úselo SingleOrDefaultsi no tiene que preocuparse demasiado por el rendimiento y desea asegurarse de que la suposición de un solo elemento sea clara para el lector y se verifique en tiempo de ejecución.

En la práctica, usas First/ a FirstOrDefaultmenudo, incluso en los casos en que asumes un solo elemento, para mejorar el rendimiento. Aún debe recordar que Single/ SingleOrDefaultpuede mejorar la legibilidad (porque establece la suposición de un solo elemento) y la estabilidad (porque lo comprueba) y usarlo adecuadamente.

Nadie ha mencionado que FirstOrDefault traducido en SQL registra TOP 1, y SingleOrDefault registra TOP 2, porque necesita saber si hay más de 1 registro.

Para LINQ -> SQL:

SingleOrDefault

• generará una consulta como "select * from users where userid = 1"
• Seleccione un registro coincidente, genera una excepción si se encuentran más de un registro
• Úselo si está obteniendo datos basados ​​en la columna de clave principal / única

FirstOrDefault

• generará una consulta como "seleccionar top 1 * de los usuarios donde userid = 1"
• Seleccione las primeras filas coincidentes
• Úselo si está buscando datos basados ​​en una columna de clave única / no primaria

Lo uso SingleOrDefaulten situaciones donde mi lógica dicta que el resultado será cero o uno. Si hay más, es una situación de error, lo cual es útil.

SingleOrDefault: Estás diciendo que "Como máximo" hay un elemento que coincide con la consulta o predeterminado FirstOrDefault: Estás diciendo que hay "Al menos" un elemento que coincide con la consulta o predeterminado

Dígalo en voz alta la próxima vez que necesite elegir y probablemente elija sabiamente. :)

En sus casos, usaría lo siguiente:

seleccione por ID == 5: está bien usar SingleOrDefault aquí, porque espera una entidad [o ninguna], si tiene más de una entidad con ID 5, hay algo mal y definitivamente una excepción digna.

al buscar personas cuyo nombre sea igual a "Bobby", puede haber más de uno (posiblemente creo), por lo que no debe usar Single ni First, solo seleccione con la operación Where (si "Bobby" devuelve demasiados entidades, el usuario tiene que refinar su búsqueda o elegir uno de los resultados devueltos)

el orden por fecha de creación también debe realizarse con una operación Where (es poco probable que solo tenga una entidad, la clasificación no sería de mucha utilidad); sin embargo, esto implica que desea ordenar TODAS las entidades; si solo desea UNA, use FirstOrDefault, Solo tiraría cada vez si tienes más de una entidad.

Ambos son operadores de elementos y se utilizan para seleccionar un solo elemento de una secuencia. Pero hay una pequeña diferencia entre ellos. El operador SingleOrDefault () lanzaría una excepción si se satisface más de un elemento, la condición donde FirstOrDefault () no arrojará ninguna excepción para el mismo. Aquí está el ejemplo.

List<int> items = new List<int>() {9,10,9};
//Returns the first element of a sequence after satisfied the condition more than one elements
int result1 = items.Where(item => item == 9).FirstOrDefault();
//Throw the exception after satisfied the condition more than one elements
int result3 = items.Where(item => item == 9).SingleOrDefault();

En tu último ejemplo:

var latestCust = db.Customers
.OrderByDescending(x=> x.CreatedOn)
.FirstOrDefault();//Single or First, or doesn't matter?

Si lo hace Si intenta usar SingleOrDefault()y la consulta da como resultado más que un registro, obtendrá una excepción. El único momento que puede usar de forma segura SingleOrDefault()es cuando espera solo 1 y solo 1 resultado ...

Entonces, según tengo entendido ahora, SingleOrDefaultserá bueno si está buscando datos que garanticen que sean únicos, es decir, forzados por restricciones de DB como la clave primaria.

¿O hay una mejor manera de consultar la clave primaria?

Suponiendo que mi TableAcc tiene

AccountNumber - Primary Key, integer
AccountName
AccountOpenedDate
AccountIsActive
etc.

y quiero consultar un AccountNumber 987654, yo uso

var data = datacontext.TableAcc.FirstOrDefault(obj => obj.AccountNumber == 987654);

En mi opinión FirstOrDefaultse está usando demasiado. En la mayoría de los casos, cuando está filtrando datos, esperaría recuperar una colección de elementos que coinciden con la condición lógica o un único elemento único por su identificador único, como un usuario, libro, publicación, etc. por qué incluso podemos llegar a decir que FirstOrDefault()es un olor a código no porque haya algo mal con él sino porque se está usando con demasiada frecuencia. Esta publicación de blog explora el tema en detalle. La OMI la mayoría de las veces SingleOrDefault()es una alternativa mucho mejor, así que tenga cuidado con este error y asegúrese de utilizar el método más apropiado que represente claramente su contrato y sus expectativas.

Una cosa que se pierde en las respuestas ...

Si hay varios resultados, FirstOrDefault sin un pedido puede devolver resultados diferentes en función de la estrategia de índice utilizada por el servidor.

Personalmente, no puedo soportar ver FirstOrDefault en el código porque para mí dice que al desarrollador no le importaron los resultados. Con un pedido por, puede ser útil como una forma de hacer cumplir lo último / más temprano. He tenido que corregir muchos problemas causados ​​por desarrolladores descuidados que usan FirstOrDefault.

Le pregunté a Google por el uso de los diferentes métodos en GitHub. Esto se realiza ejecutando una consulta de búsqueda de Google para cada método y limitando la consulta al dominio github.com y la extensión de archivo .cs mediante la consulta "sitio: archivo github.com: cs ..."

Parece que los métodos First * se usan más comúnmente que los métodos Single *.

| Method               | Results |
|----------------------|---------|
| FirstAsync           |     315 |
| SingleAsync          |     166 |
| FirstOrDefaultAsync  |     357 |
| SingleOrDefaultAsync |     237 |
| FirstOrDefault       |   17400 |
| SingleOrDefault      |    2950 |

No entiendo por qué estás usando FirstOrDefault(x=> x.ID == key)cuando esto podría recuperar resultados mucho más rápido si lo usas Find(key). Si está consultando con la clave principal de la tabla, la regla general es usar siempre Find(key). FirstOrDefaultdebe usarse para cosas predicadas como (x=> x.Username == username)etc.

esto no merecía un voto negativo ya que el encabezado de la pregunta no era específico de linq en DB o Linq to List / IEnumerable, etc.