LINQ: Коли використовувати SingleOrDefault проти FirstOrDefault () з критеріями фільтрації

Розглянемо IE численні методи розширення SingleOrDefault()таFirstOrDefault()

MSDN документи, якіSingleOrDefault :

Повертає єдиний елемент послідовності або значення за замовчуванням, якщо послідовність порожня; цей метод кидає виняток, якщо в послідовності є більше одного елемента.

в той час як FirstOrDefaultз MSDN (імовірно при використанні OrderBy()або OrderByDescending()або взагалі нічого),

Повертає перший елемент послідовності

Розглянемо кілька прикладів запитів, не завжди зрозуміло, коли використовувати ці два методи:

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?

Питання

Яких умов ви дотримуєтесь чи пропонуєте, вирішуючи використовувати SingleOrDefault()та FirstOrDefault()у своїх LINQ-запитах?

Щоразу, коли ви користуєтесь SingleOrDefault, ви чітко заявляєте, що запит повинен мати максимум один результат. З іншого боку, коли FirstOrDefaultвикористовується, запит може повернути будь-яку кількість результатів, але ви заявляєте, що хочете лише перший.

Я особисто вважаю семантику дуже різною і використання відповідного, залежно від очікуваних результатів, покращує читабельність.

Якщо ваш набір результатів повертає 0 записів:

• SingleOrDefault повертає значення за замовчуванням для типу (наприклад, за замовчуванням для int дорівнює 0)
• FirstOrDefault повертає значення за замовчуванням для типу

Якщо результат набору повертає 1 запис:

• SingleOrDefault повертає цей запис
• FirstOrDefault повертає цей запис

Якщо ваш набір результатів повертає багато записів:

• SingleOrDefault кидає виняток
• FirstOrDefault повертає перший запис

Висновок:

Якщо ви хочете викинути виняток, якщо набір результатів містить багато записів, використовуйте SingleOrDefault.

Якщо ви завжди хочете 1 запис незалежно від того, що містить набір результатів, використовуйте FirstOrDefault

існує

• семантична різниця
• різниця в продуктивності

між двома.

Семантична різниця:

• FirstOrDefault повертає перший елемент потенційно кратного (або за замовчуванням, якщо такого немає).
• SingleOrDefaultприпускає, що є один елемент, і повертає його (або за замовчуванням, якщо такого немає). Кілька предметів є порушенням договору, викидається виняток.

Різниця у виконанні

• FirstOrDefaultЗазвичай швидше, воно повторюється до тих пір, поки не знайде елемент і має лише повторити цілий ряд, коли він не знайде його. У багатьох випадках велика ймовірність знайти предмет.

• SingleOrDefaultПотрібно перевірити, чи є лише один елемент, і тому завжди повторює всю кількість. Якщо бути точним, він повторюється, поки не знайде другий елемент і не викине виняток. Але в більшості випадків другого елемента немає.

Висновок

• Використовуйте, FirstOrDefaultякщо вам все одно, скільки предметів є або коли ви не можете дозволити собі перевірити унікальність (наприклад, у дуже великій колекції). Коли ви перевіряєте унікальність додавання елементів до колекції, це може бути занадто дорого, щоб перевірити її ще раз під час пошуку цих предметів.

• Використовуйте, SingleOrDefaultякщо вам не надто турбується про ефективність, і ви хочете переконатися, що припущення про один предмет читачеві зрозуміле та перевірене під час виконання.

На практиці ви використовуєте First/ FirstOrDefaultчасто навіть у випадках, коли ви припускаєте один предмет, для підвищення продуктивності. Ви все ще повинні пам’ятати, що Single/ SingleOrDefaultможе покращити читабельність (тому що вона заявляє про припущення про один предмет) та стабільність (тому що вона перевіряє) та використовувати її належним чином.

Ніхто не згадував, що FirstOrDefault, перекладений на SQL, записує TOP 1, а SingleOrDefault робить TOP 2, тому що йому потрібно знати, чи існує більше 1 запису.

Для LINQ -> SQL:

SingleOrDefault

• створить запит на зразок "select * у користувачів, де userid = 1"
• Виберіть відповідний запис, Викидає виняток, якщо знайдено більше одного запису
• Використовуйте, якщо ви отримуєте дані на основі стовпця основного / унікального ключа

FirstOrDefault

• створить запит на зразок "вибрати топ 1 * від користувачів, де userid = 1"
• Виберіть перші відповідні рядки
• Використовуйте, якщо ви отримуєте дані на основі стовпця не первинного / унікального ключа

Я використовую SingleOrDefaultв ситуаціях, коли моя логіка диктує, що результат буде або нульовим, або одним результатом. Якщо їх більше, це корисна ситуація.

SingleOrDefault: Ви говорите, що "Максимум" є один елемент, що відповідає запиту або за замовчуванням FirstOrDefault: Ви говорите, що є "Принаймні" один елемент, що відповідає запиту або за замовчуванням

Скажіть це вголос наступного разу, коли вам потрібно вибрати, і ви, швидше за все, виберете розумно. :)

У ваших випадках я б використовував наступне:

select by ID == 5: тут нормально використовувати SingleOrDefault, тому що ви очікуєте, що один [або жоден] об'єкт, якщо у вас є більше одного об’єкта з ідентифікатором 5, є щось не так, і, безумовно, варто виняток.

під час пошуку людей, прізвище яких дорівнює «Боббі», може бути більше одного (цілком можливо, я б міг подумати), тому вам не слід ні використовувати Одиночне, ні Перше, просто вибирайте за допомогою «Де-операція» (якщо «Бобі» повертається занадто багато суб'єкти, користувач повинен уточнити свій пошук або вибрати один із повернених результатів)

замовлення за датою створення також слід виконувати з операцією Where (навряд чи буде мати лише одне ціле, сортування не принесе великої користі;), однак, це означає, що ви хочете відсортувати ВСІ об'єкти - якщо ви хочете лише ONE, використовуйте FirstOrDefault, Сингл кидає кожного разу, якщо у вас є більше однієї сутності.

Обидва є операторами елементів, і вони використовуються для вибору одного елемента з послідовності. Але між ними є незначна різниця. Оператор SingleOrDefault () видасть виняток, якщо більше ніж один елемент задовольняє умові, коли як FirstOrDefault () не буде викинуто жодного винятку для одного і того ж. Ось приклад.

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

У вашому останньому прикладі:

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

Так. Якщо ви спробуєте використати SingleOrDefault()і результат запиту в більшій кількості записів, ви отримаєте і виняток. Єдиний час, коли ви можете сміливо користуватися SingleOrDefault()- це коли ви очікуєте лише 1 і лише 1 результат ...

Тож, як я зараз розумію, SingleOrDefaultбуде добре, якщо ви будете запитувати дані, які гарантовано є унікальними, тобто виконуються обмеженнями БД, як первинний ключ.

Або є кращий спосіб запиту первинного ключа.

Якщо припустити, що мій TableAcc є

AccountNumber - Primary Key, integer
AccountName
AccountOpenedDate
AccountIsActive
etc.

і я хочу запитувати AccountNumber 987654, я використовую

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

На мою думку FirstOrDefault, надто багато зловживають. У більшості випадків, коли ви фільтруєте дані, ви можете розраховувати отримати колекцію елементів, що відповідають логічній умові, або один унікальний елемент за його унікальним ідентифікатором - наприклад, користувачем, книгою, публікацією тощо ... Це чому ми можемо навіть сказати, що FirstOrDefault()це кодовий запах не тому, що в цьому щось не так, а тому, що він використовується занадто часто. Ця публікація в блозі детально досліджує цю тему. IMO в більшості випадків SingleOrDefault()є набагато кращою альтернативою, тому слідкуйте за цією помилкою і переконайтеся, що ви використовуєте найбільш підходящий метод, який чітко відображає ваш контракт та очікування.

Одне, що пропускається у відповідях….

Якщо є декілька результатів, FirstOrDefault без замовлення може повернути різні результати, на основі яких коли-небудь стратегія індексів повинна використовуватися сервером.

Особисто я не можу витримати FirstOrDefault в коді, оскільки мені це каже, що розробник не піклувався про результати. З наказом, хоча це може бути корисним як спосіб примусового виконання останнього / раннього. Мені довелося виправити багато проблем, викликаних недбалими розробниками, які використовують FirstOrDefault.

Я запитав Google про використання різних методів на GitHub. Це робиться шляхом запуску пошукового запиту Google для кожного методу та обмеження запиту до домену github.com та розширення файлу .cs за допомогою запиту "site: github.com file: cs ..."

Схоже, методи First * частіше використовуються, ніж методи Single *.

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

Я не розумію, чому ви використовуєте, FirstOrDefault(x=> x.ID == key)коли це може отримати результати набагато швидше, якщо ви користуєтесь Find(key). Якщо ви запитуєте за допомогою Первинного ключа таблиці, завжди слід використовувати правило Find(key). FirstOrDefaultслід використовувати для таких предикатних речей(x=> x.Username == username) тощо.

це не заслуговувало зворотного голосу, оскільки заголовок питання не був специфічним для linq у БД або Linq до списку / IEnumerable тощо.