วิธีและเหตุผลในการตัดสินใจระหว่างวิธีการตั้งชื่อด้วยคำนำหน้า "รับ" และ "ค้นหา"

ฉันมักจะมีปัญหาในการหาว่าผมควรจะตั้งชื่อวิธีการบางอย่างที่เริ่มต้นด้วยเมื่อเทียบกับgetSomethingfindSomething

ปัญหาอยู่ในการสร้างผู้ช่วยเหลือสำหรับ API ที่ออกแบบมาไม่ดี สิ่งนี้มักจะเกิดขึ้นเมื่อรับข้อมูลจากวัตถุซึ่งต้องการวัตถุเป็นพารามิเตอร์ นี่คือตัวอย่างง่ายๆ:

public String getRevision(Item item) {
    service.load(item, "revision");
    // there is usually more work to do before getting the data..
    try {
        return item.get_revision();
    }
    catch(NotLoadedException exception) {
        log.error("Property named 'property_name' was not loaded", exception);
    }
    return null;
}

วิธีการและเหตุผลในการตัดสินใจระหว่างการตั้งชื่อวิธีการนี้เป็นgetRevision()หรือfindRevision()?

ฉันใช้Getเมื่อฉันรู้ว่าเวลาการดึงข้อมูลจะสั้นมาก (เช่นในการค้นหาจากตารางแฮชหรือ btree)

Findแสดงถึงกระบวนการค้นหาหรืออัลกอริธึมการคำนวณที่ต้องใช้ระยะเวลา "นาน" ในการดำเนินการ (สำหรับค่าที่กำหนดเองนานกว่านั้น)

ฉันจะบอกว่าfindอาจล้มเหลว แต่getไม่ควร

หากต้องการพูดบทสนทนาที่ฉันมักมีกับลูก ๆ ของฉัน:

ฉัน: เฮ้เด็ก! ไปหาฉันแบตเตอรี่บางส่วน

เด็ก:แต่พวกเขาอยู่ที่ไหน

ฉัน:นั่นคือเหตุผลที่ฉันบอกให้คุณไปหาพวกเขา ถ้าฉันรู้ว่าพวกเขาอยู่ที่ไหนฉันจะบอกให้คุณไปหาพวกเขา หรือคุณสามารถถามแม่ของคุณ

ความคิดเดียวกันถือ:

• ใช้ "รับ" สำหรับวิธีการที่ส่งคืนชิ้นส่วนของข้อมูลที่มีราคาถูก (และอาจเป็นแบบอินไลน์หรือปรับให้เหมาะสมเป็นอย่างอื่น) หรือสำหรับชิ้นส่วนของข้อมูลที่เป็นเจ้าของวัตถุนี้โดยเฉพาะ

• ใช้ "ค้นหา" สำหรับวิธีการที่ทำงานเพื่อรับข้อมูลหรือใช้วัตถุอื่นเพื่อค้นหา

ค้นหาบอกเป็นนัยถึงการไม่มีผลลัพธ์เช่นเมื่อดำเนินการแบบสอบถามฐานข้อมูลด้วยพารามิเตอร์บางอย่างที่อาจเปลี่ยนแปลงระหว่างการโทร รับในทางกลับกันแสดงถึงผลลัพธ์เป็นวิธีการที่รู้จักกันก่อนหรือจะไม่เปลี่ยนครั้งเดียวที่รู้จักกันว่าไม่มีพารามิเตอร์ในการโทร
ดังนั้นฉันจะใช้ตัวอย่างเช่นลูกค้า findCustomerById (ยาว customerId) และลูกค้า getCustomer ()

ฉันใช้รูปแบบต่อไปนี้:

• Foo GetFoo() ไม่สามารถคืนค่าว่างได้และความซับซ้อนของมันคือ O (log (n)) หรือน้อยกว่า
• bool TryGetFoo(out Foo) สามารถคืนค่า null และความซับซ้อนของมันคือ O (log (n)) หรือน้อยกว่า
• Foo FindFoo() ไม่สามารถคืนค่าว่างเปล่าและความซับซ้อนมากกว่า O (บันทึก (n))
• bool TryFindFoo(out Foo) สามารถคืนค่า null และความซับซ้อนของมันเป็นมากกว่า O (log (n))

วิธีนี้ทำให้โค้ดนั้นชัดเจนในจุดประสงค์และความซับซ้อนที่คุณคาดหวัง

โดยทั่วไปแล้ว Getters ใช้สำหรับรายการโดยตรงหรือการเข้าถึงพจนานุกรม / ชุด
Finders คือการค้นหาที่ลึกการสแกนแบบเต็มรายการ ฯลฯ

ในกรณีของคุณ:

public bool TryGetRevision( Item item, out String revision ) 
{
    service.load( item, "revision" );
    // there is usually more work to do before getting the data..
    try 
    {
        revision = item.get_revision();
        return true;
    }
    catch( NotLoadedException exception )
    {
        log.error( "Property named 'property_name' was not loaded", exception );
        revision = "";
        return false;
    }
}

getมีความเหมาะสมในทุกกรณี _ ในความเป็นจริงมันมักจะสันนิษฐานว่าเพื่อให้ได้สิ่งที่คุณต้องค้นหาก่อน getดังนั้นหากคุณไม่แน่ใจว่าการใช้งาน

ฉันจะใช้findสำหรับวิธีการเช่นfindMinimum()หรือfindOptimal()ที่มีอัลกอริทึมพิเศษบางอย่างที่คำนวณค่าส่งคืนและไม่เพียงแค่ขอให้ DB, ระบบไฟล์เซิร์ฟเวอร์ระยะไกล ฯลฯ เพื่อรับข้อมูลบางอย่าง

ห้ามใช้ find หรือรับส่วนนำหน้า นี่เป็นการละเมิดUniformAccessPrincipleประกาศเกียรติคุณจาก bertrand meyer ทำไมไม่สร้างวิธีการดังต่อไปนี้:

public String revision(Item item)

โดยทั่วไปฉันจะใช้Getเพื่อดึงข้อมูลวัตถุ / ค่าและFindเพื่อเรียกคืนตำแหน่ง (ตัวอย่างเช่นในอาร์เรย์)

สำหรับอดีต:

object o = obj.GetItem( 'name');

integer i = somearray.Find( 'name');

สำหรับฉันfindหมายความว่าอาจมีผลลัพธ์มากกว่าหนึ่งรายการ getบอกเป็นนัยเดียว