สไตล์โค้ดที่ดีในการแนะนำการตรวจสอบข้อมูลทุกที่?

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

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

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

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

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

(FYI: ฉันยังเป็นผู้เริ่มต้นดังนั้นโปรดแก้ตัวหากคำถามนี้ไร้เดียงสาโครงการของฉันอยู่ใน Python)

ทางออกที่ดีกว่าคือการใช้ประโยชน์จากคุณลักษณะและเครื่องมือของ Python

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

namedtupleปัญหานี้จะลดลงด้วย มันมีน้ำหนักเบาและให้ความหมายเชิงความหมายที่ง่ายต่อสมาชิกอาเรย์ของคุณ

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

คุณยังรู้สึกกังวลเกี่ยวกับฟังก์ชั่นที่ค้างเมื่อความต้องการเปลี่ยนแปลง นี้สามารถจับโดยการทดสอบแบบอัตโนมัติ

ในขณะที่ฉันไม่ได้บอกว่าการตรวจสอบด้วยตนเองนั้นไม่เหมาะสม แต่การใช้คุณสมบัติภาษาที่ใช้ได้ดีขึ้นสามารถช่วยคุณแก้ปัญหานี้ได้ในลักษณะที่สามารถดูแลรักษาได้มากขึ้น

ตกลงปัญหาจริงอธิบายไว้ในความคิดเห็นด้านล่างคำตอบนี้:

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

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

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

ก่อนอื่นสิ่งที่คุณกำลังประสบอยู่ในตอนนี้คือกลิ่นของรหัส - พยายามจำสิ่งที่ทำให้คุณรู้สึกถึงกลิ่นและพยายามที่จะฝึกฝนจมูก "จิต" ของคุณทันทีที่คุณสังเกตเห็นกลิ่นของรหัสเร็วขึ้น - และง่ายขึ้น - คุณสามารถแก้ไขปัญหาพื้นฐานได้

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

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

(หรือในบางกรณีให้ทำการบันทึกข้อมูลซ้ำหากข้อมูลมีรูปแบบที่ไม่ถูกต้อง)

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

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

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

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

ไม่เป็นไร. ฉันเคยใช้รหัสใน FoxPro ที่ฉันมี TRY..CATCH บล็อกเกือบทุกฟังก์ชั่นใหญ่ ตอนนี้ฉันโค้ดใน JavaScript / LiveScript และไม่ค่อยตรวจสอบพารามิเตอร์ในฟังก์ชั่น "ภายใน" หรือ "ส่วนตัว"

"วิธีการตรวจสอบ" ขึ้นอยู่กับโครงการ / ภาษาที่เลือกมากกว่านั้นขึ้นอยู่กับทักษะการใช้โค้ดของคุณ