ชื่ออินเตอร์เฟสควรเริ่มต้นด้วยคำนำหน้า“ I” หรือไม่

ฉันได้อ่าน " Clean Code " โดย Robert Martin หวังว่าจะเป็นโปรแกรมเมอร์ที่ดีขึ้น แม้ว่าจะไม่มีสิ่งใดที่ทำให้ฉันรู้สึกแตกต่างไปจากเดิมอย่างสิ้นเชิงเกี่ยวกับวิธีการออกแบบแอปพลิเคชันและเขียนโค้ด

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

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

อาจเป็นเพราะฉันเป็นแค่นักเรียนหรืออาจเป็นเพราะฉันไม่เคยทำโปรแกรมแบบมืออาชีพหรือเป็นทีม แต่ฉันต้องการให้ผู้ใช้รู้ว่ามันเป็นส่วนต่อประสาน มีความแตกต่างใหญ่ระหว่างการใช้อินเทอร์เฟซและการขยายชั้นเรียน

ดังนั้นคำถามของฉันจึงลดลงไปถึง"ทำไมเราควรซ่อนความจริงที่ว่าบางส่วนของรหัสกำลังคาดว่าจะมีส่วนต่อประสาน"

แก้ไข

ในการตอบกลับคำตอบ:

หากประเภทของคุณเป็นอินเทอร์เฟซหรือคลาสเป็นธุรกิจของคุณไม่ใช่ธุรกิจของใครบางคนที่ใช้รหัสของคุณ ดังนั้นคุณไม่ควรรั่วรายละเอียดรหัสของคุณในรหัสของบุคคลที่สามนี้

เหตุใดฉันจึงไม่ควร "รั่วไหล" รายละเอียดว่าประเภทที่กำหนดเป็นส่วนต่อประสานหรือคลาสของรหัสของบุคคลที่สามหรือไม่ สิ่งสำคัญสำหรับนักพัฒนาบุคคลที่สามที่ใช้รหัสของฉันเพื่อรู้ว่าพวกเขาจะใช้อินเทอร์เฟซหรือขยายชั้นเรียนหรือไม่? ความแตกต่างนั้นไม่สำคัญเท่ากับที่ฉันกำลังทำให้พวกเขาอยู่ในใจ

หากคุณหยุดคิดเกี่ยวกับสิ่งนี้คุณจะเห็นว่าอินเทอร์เฟซไม่แตกต่างจากคลาสนามธรรมจริง ๆ :

• ทั้งสองมีวิธีและ / หรือคุณสมบัติ (พฤติกรรม);
• ไม่ควรมีฟิลด์ที่ไม่ใช่ข้อมูลส่วนตัว
• ไม่สามารถสร้างอินสแตนซ์ได้โดยตรง
• ที่ได้มาจากวิธีการหนึ่งที่ใช้วิธีการที่เป็นนามธรรมใด ๆ เว้นแต่ว่าประเภทที่ได้รับยังเป็นนามธรรม

ในความเป็นจริงความแตกต่างที่สำคัญที่สุดระหว่างคลาสและส่วนต่อประสานคือ:

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

เนื่องจากความแตกต่างที่มีความหมายโดยเฉพาะอย่างยิ่งระหว่างคลาสและอินเทอร์เฟซหมุนรอบ (a) ข้อมูลส่วนตัวและ (b) ลำดับชั้นของแบบ - ซึ่งไม่ทำให้ความแตกต่างเพียงเล็กน้อยสำหรับผู้โทร - โดยทั่วไปแล้วไม่จำเป็นต้องทราบว่า ห้องเรียน. แน่นอนคุณไม่จำเป็นต้องมีตัวบ่งชี้ภาพ

อย่างไรก็ตามมีบางมุมที่ต้องระวัง โดยเฉพาะอย่างยิ่งหากคุณกำลังใช้การสะท้อนการสกัดกั้นพร็อกซี / มิกซ์อินแบบไดนามิกการทอโค้ดแบบไบต์การสร้างรหัสหรือสิ่งใดก็ตามที่เกี่ยวข้องกับการยุ่งกับระบบการพิมพ์หรือโค้ดของสภาพแวดล้อมโดยตรง - มันมีประโยชน์มากและบางครั้งจำเป็นต้องรู้ bat ไม่ว่าคุณจะจัดการกับอินเทอร์เฟซหรือคลาส คุณไม่ต้องการให้โค้ดของคุณล้มเหลวอย่างชัดเจนเพราะคุณพยายามเพิ่มคลาสแทนที่จะเป็นส่วนต่อประสาน

สำหรับรหัสทั่วไปของตรรกะทางธุรกิจวานิลลาที่มีการใช้งานจริงนั้นความแตกต่างระหว่างคลาสนามธรรมและอินเทอร์เฟซไม่จำเป็นต้องโฆษณาเพราะพวกเขาจะไม่เข้ามาเล่น

ทั้งหมดนี้ถูกกล่าวว่าฉันมักจะนำหน้าส่วนต่อประสาน C # ของฉันด้วยIเพราะนั่นคือ. NET แบบแผนที่ใช้และสนับสนุนโดย Microsoft และเมื่อฉันอธิบายข้อตกลงการเข้ารหัสให้กับนักพัฒนาใหม่มันไม่ยุ่งยากเพียงแค่ใช้กฎของ Microsoft มากกว่าที่จะอธิบายว่าทำไมเราจึงมีกฎ "พิเศษ" ของเราเอง

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

หนังสือเล่มนี้เต็มไปด้วยสิ่งที่ดี แต่ฉันจะยังคงเพิ่ม "ฉัน" ไว้ในชื่อส่วนต่อประสาน

ลองนึกภาพคุณต้องมีการดำเนินการเริ่มต้นpublic interface ILogpublic class Log

ทีนี้ถ้าคุณตัดสินใจที่จะมีpublic interface Logทันใดนั้นคุณต้องเปลี่ยนชั้นเรียนเป็นpublic class LogDefaultหรืออะไรบางอย่างในบรรทัดเหล่านั้น คุณย้ายจากการมีตัวละครพิเศษหนึ่งตัวถึงเจ็ดตัว - แน่นอนว่ามันสิ้นเปลือง

มักจะมีเส้นแบ่งระหว่างทฤษฎีและการปฏิบัติ ในทางทฤษฎีนี่เป็นความคิดที่ดีจริงๆ แต่ในทางปฏิบัติมันไม่ดีนัก

อย่างนี้ไม่เกี่ยวกับการใช้อินเทอร์เฟซหรือขยายคลาส ในกรณีที่คุณรู้ว่าสิ่งที่คุณกำลังทำ

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

นี่คือจุดรวมของนามธรรม คุณกำลังนำเสนอโค้ดของบุคคลที่สามให้กับวัตถุประเภทที่กำหนด ประเภทที่กำหนดนี้มีฟังก์ชั่นสมาชิกบางอย่างที่คุณสามารถโทรได้ เพียงพอ.

หากประเภทของคุณเป็นอินเทอร์เฟซหรือคลาสเป็นธุรกิจของคุณไม่ใช่ธุรกิจของใครบางคนที่ใช้รหัสของคุณ ดังนั้นคุณไม่ควรรั่วรายละเอียดรหัสของคุณไปยังรหัสบุคคลที่สามนี้

โดยวิธีการอินเตอร์เฟซและชั้นเรียนเป็นประเภทการอ้างอิงในตอนท้าย และนี่คือสิ่งที่สำคัญ ดังนั้นนี่คือสิ่งที่แผนการตั้งชื่อของคุณต้องเน้น

คำตอบส่วนใหญ่ดูเหมือนจะสมมติว่าภาษาการเขียนโปรแกรมเป็นทั้ง Java หรือ C # ที่มีแนวคิด (หรือคำหลัก) สำหรับ interfaces / นามธรรมชั้นเรียน ในกรณีเหล่านี้ใน IDE ที่เหมาะสมจะสามารถมองเห็นได้ทันทีด้วยประเภทของข้อตกลงและการเขียนชั้นหนึ่งที่public interface IMyClassซ้ำกันโดยไม่จำเป็น มันเหมือนกับว่าคุณจะไม่เขียนpublic final FinalMyClass- ลองนึกถึงการใส่คำหลักทุกคำลงในชื่อคลาส

อย่างไรก็ตามในความคิดเห็นของฉันใน C ++ สถานการณ์แตกต่างกันเล็กน้อยเนื่องจากต้องดำดิ่งลงในไฟล์ส่วนหัวและดูว่าคลาสมีวิธีเสมือนใด ๆ เพื่อดูว่าเป็นคลาสนามธรรมหรือไม่ class AbstractMyClassในกรณีที่ว่าผมสามารถเห็นได้ชัดเจนโต้แย้งสำหรับการเขียน

ดังนั้นคำตอบของฉันคือ: ขึ้นอยู่กับภาษาการเขียนโปรแกรม

อัปเดตในปี 2559:ประสบการณ์ C ++ 2 ปีต่อมาตอนนี้ฉันอาจจะคิดว่ามันเป็นการฝึกหัดที่ไม่ดีกับชื่อชั้นนำหน้าด้วยAbstractแม้ว่าฉันจะบอกว่าอาจมีรหัสฐานที่ซับซ้อนมากจนอาจสมเหตุสมผล

ทำตามสำนวนภาษาที่คุณใช้

แต่ละภาษามีสำนวนและแนวทางการเข้ารหัสของตัวเอง ตัวอย่างเช่นใน C # มันเป็นสำนวนต่ออินเทอร์เฟซคำนำหน้าด้วย I. In Go ไม่ใช่

ในรหัส (Java) ของฉันฉันมักจะมีการประชุมนี้ใน APIs ที่ฉันเปิดเผยให้ผู้โทร:

• ฟังก์ชั่นมีให้ผ่านอินเตอร์เฟสและไม่เคยเรียน
• ส่วนที่ไม่ใช้งานได้เป็นคลาส

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

ในแง่ของการตั้งชื่อการประชุมอินเตอร์เฟซที่มีแนวโน้มที่จะ map ทั้งคำนามนักแสดง (เช่นFooBarWatcher) หรือคำคุณศัพท์ (เช่นFooBarWatchable) และทั้งสองเรียนข้อมูลบริสุทธิ์และ enumerations map คำนามไม่ได้ใช้งาน (เช่นFooBarStatus); IDE สามารถแนะนำผู้ใช้ API ได้โดยไม่ต้องมีการตั้งชื่อแบบพิเศษ ข้อยกเว้นตามแบบแผน Java ปกติ ( FooBarException, FooBarError, FooBarFault) ของหลักสูตร

ฉันมักจะใส่อินเทอร์เฟซไว้ในแพ็คเกจของตัวเองหรือแม้กระทั่งในห้องสมุดของตัวเองเพื่อให้แน่ใจว่าฉันจะไม่ทำผิดกฎของตัวเอง (สิ่งนี้ยังช่วยฉันจัดการการสร้างเมื่อฉันรับรหัสจากแหล่งภายนอกเช่นเอกสาร WSDL)