LINQ: เมื่อใดที่จะใช้ SingleOrDefault vs. FirstOrDefault () กับเกณฑ์การกรอง

พิจารณาวิธีการขยาย IEnumerable 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 ทำบันทึก 1 อันดับแรกและ SingleOrDefault ทำอันดับ 2 เพราะต้องรู้ว่ามีมากกว่า 1 บันทึก

สำหรับ LINQ -> SQL:

SingleOrDefault

• จะสร้างข้อความค้นหาเช่น "select * จากผู้ใช้ที่ userid = 1"
• เลือกระเบียนที่ตรงกันโยนข้อยกเว้นหากพบมากกว่าหนึ่งระเบียน
• ใช้หากคุณกำลังดึงข้อมูลตามคอลัมน์คีย์หลัก / เฉพาะ

FirstOrDefault

• จะสร้างข้อความค้นหาเช่น "select top 1 * จากผู้ใช้ที่ userid = 1"
• เลือกแถวแรกที่ตรงกัน
• ใช้หากคุณกำลังดึงข้อมูลตามคอลัมน์คีย์หลัก / ไม่ซ้ำกัน

ฉันใช้SingleOrDefaultในสถานการณ์ที่ตรรกะของฉันบอกว่าผลลัพธ์จะเป็นศูนย์หรือผลลัพธ์เดียว หากมีมากกว่านั่นเป็นสถานการณ์ข้อผิดพลาดซึ่งเป็นประโยชน์

SingleOrDefault: คุณกำลังบอกว่า "มากที่สุด" มีหนึ่งรายการที่ตรงกับแบบสอบถามหรือค่าเริ่มต้น FirstOrDefault: คุณกำลังบอกว่ามีรายการ "อย่างน้อย" หนึ่งรายการที่ตรงกับแบบสอบถามหรือค่าเริ่มต้น

พูดออกมาดัง ๆ ในครั้งต่อไปที่คุณต้องเลือกและคุณน่าจะเลือกอย่างชาญฉลาด :)

ในกรณีของคุณฉันจะใช้สิ่งต่อไปนี้:

เลือกตาม ID == 5: คุณสามารถใช้ SingleOrDefault ได้ที่นี่เพราะคุณคาดว่าจะมีเอนทิตี้หนึ่ง [หรือไม่มีเลย] หากคุณมีเอนทิตีมากกว่าหนึ่งรายการที่มี ID 5 มีบางอย่างผิดปกติและสมควรยกเว้นอย่างแน่นอน

เมื่อค้นหาผู้ที่มีชื่อแรกว่า "Bobby" อาจมีมากกว่าหนึ่ง (อาจเป็นไปได้ที่ฉันจะคิด) ดังนั้นคุณไม่ควรใช้ Single หรือ First เพียงเลือกด้วย Where-operation (หาก "Bobby" ส่งคืนมากเกินไป เอนทิตีผู้ใช้ต้องปรับแต่งการค้นหาของเขาหรือเลือกหนึ่งในผลลัพธ์ที่ส่งคืน)

ควรเรียงลำดับตามวันที่สร้างด้วย Where-operation (ไม่น่าจะมีเพียงเอนทิตี้เดียวการเรียงลำดับจะไม่ใช้ประโยชน์มาก) อย่างไรก็ตามสิ่งนี้บอกเป็นนัยว่าคุณต้องการเรียงลำดับเอนทิตี้ทั้งหมด - ถ้าคุณต้องการเพียงหนึ่งใช้ 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จะดีถ้าคุณกำลังสอบถามข้อมูลที่รับประกันว่าจะไม่ซ้ำกันเช่นบังคับใช้โดยข้อ จำกัด ของ DB เช่นคีย์หลัก

หรือมีวิธีที่ดีกว่าในการค้นหาคีย์หลัก

สมมติว่า 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)

สิ่งนี้ไม่สมควรได้รับ downvote เนื่องจากหัวข้อของคำถามนั้นไม่ได้เจาะจงเฉพาะ linq บน DB หรือ Linq ไปยัง List / IEnumerable เป็นต้น