LINQ: When to use SingleOrDefault vs. FirstOrDefault() with filtering criteria
Consider the IEnumerable extension methods SingleOrDefault() and FirstOrDefault()
MSDN documents that SingleOrDefault :
Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.
whereas FirstOrDefault from MSDN (presumably when using an OrderBy() or OrderByDescending() or none at all),
Returns the first element of a sequence
Consider a handful of example queries, it's not always clear when to use these two methods:
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?
Question
What conventions do you follow or suggest when deciding to use SingleOrDefault() and FirstOrDefault() in your LINQ queries?
Whenever you use SingleOrDefault , you clearly state that the query should result in at most a single result. On the other hand, when FirstOrDefault is used, the query can return any amount of results but you state that you only want the first one.
I personally find the semantics very different and using the appropriate one, depending on the expected results, improves readability.
If your result set returns 0 records:
SingleOrDefault returns the default value for the type (eg default for int is 0) FirstOrDefault returns the default value for the type If you result set returns 1 record:
SingleOrDefault returns that record FirstOrDefault returns that record If your result set returns many records:
SingleOrDefault throws an exception FirstOrDefault returns the first record Conclusion:
If you want an exception to be thrown if the result set contains many records, use SingleOrDefault .
If you always want 1 record no matter what the result set contains, use FirstOrDefault
There is
between the two.
Semantical Difference:
FirstOrDefault returns a first item of potentially multiple (or default if none exists). SingleOrDefault assumes that there is a single item and returns it (or default if none exists). Multiple items are a violation of contract, an exception is thrown. Performance Difference
FirstOrDefault is usually faster, it iterates until it finds the element and only has to iterate the whole enumerable when it doesn't find it. In many cases, there is a high probability to find an item.
SingleOrDefault needs to check if there is only one element and therefore always iterates the whole enumerable. To be precise, it iterates until it finds a second element and throws an exception. But in most cases, there is no second element.
Conclusion
Use FirstOrDefault if you don't care how many items there are or when you can't afford checking uniqueness (eg in a very large collection). When you check uniqueness on adding the items to the collection, it might be too expensive to check it again when searching for those items.
Use SingleOrDefault if you don't have to care about performance too much and want to make sure that the assumption of a single item is clear to the reader and checked at runtime.
In practice, you use First / FirstOrDefault often even in cases when you assume a single item, to improve performance. You should still remember that Single / SingleOrDefault can improve readability (because it states the assumption of a single item) and stability (because it checks it) and use it appropriately.
上一篇: 是否有与LINQ相当的Java？