SQL Best Practices - วิธีพิมพ์รหัสอย่างเรียบร้อยและจัดระเบียบอย่างสมบูรณ์แบบ

ทำความสะอาดรหัส

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

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

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

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

สไตล์ที่ดี

ทีนี้มาเน้นการเขียนโค้ดอีกด้านในสไตล์ที่ดี เมื่อกำหนดชื่อให้กับตัวแปรหรือวัตถุ SQL ให้เลือกชื่อที่สั้นกว่ามีความหมายถ่ายทอดข้อมูลเฉพาะเสมอ โดย 'ความหมาย' เราหมายถึงชื่อที่ออกเสียงได้ซึ่งมีการเลือกหนึ่งคำต่อแนวคิด ตัวอย่างเช่นนั่นคือเหตุผลที่เราเลือก“ หมายเลขซื้อ” ไม่ใช่“ หมายเลขซื้อเฉพาะของลูกค้า” ในตาราง“ ขาย”

ในบัญชีนั้นคุณไม่จำเป็นต้องรีบเลือกชื่อเนื่องจากจะต้องสะท้อนการทำงานของวัตถุให้มากที่สุด ชื่อจะประกอบด้วยรหัสของคุณมากกว่า 80% ดังนั้นจึงสำคัญสำหรับชื่อที่คุณใช้ด้วย!

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

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

การอ่านรหัส

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

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

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

รักษารหัสของคุณ

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

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

2. ใช้เครื่องมืออะนาล็อกที่เกี่ยวข้องที่มีให้ใน Workbench แปรงขนาดเล็กอันนี้ทำให้รหัสของคุณสวยงาม คีย์ผสมทางลัดเพื่อใช้ฟังก์ชั่นนี้กับเคียวรีที่เคอร์เซอร์ตั้งอยู่คือ Ctrl และ B คุณเห็นหรือไม่? น่ากลัว!

3. หากคุณต้องการทำความสะอาดรหัสของคุณแตกต่างกันคุณควรแทรกแซงด้วยตนเองและปรับตามที่คุณต้องการ

การออกกำลังกาย

ในบรรทัดง่าย ๆ นี้เราจะสร้างตารางทดสอบที่มีสองคอลัมน์ -“ ตัวเลข” และ“ คำ”

เราเขียนโค้ดในหนึ่งบรรทัดด้วยตัวอักษรขนาดเล็ก สังเกตว่า MySQL เปลี่ยนสีของคำหลักประเภทข้อมูลและตัวเลขอย่างไร ตอนนี้เราจะไม่เกี่ยวข้องกับซอฟต์แวร์ ad-hoc เนื่องจากเรามุ่งเน้นไปที่ Workbench หลังจากวางเคอร์เซอร์ไว้ที่ใดที่หนึ่งในแบบสอบถามนี้คุณสามารถกดไอคอนแปรงเล็ก ๆ เพื่อจัดรูปแบบสคริปต์ใหม่ หากต้องการดำเนินการเดียวกันเร็วขึ้นให้จดจำปุ่มลัด Ctrl และ B

ว้าว! มันได้ผล

คำหลักเป็นตัวพิมพ์ใหญ่และข้อมูลสำหรับแต่ละคอลัมน์ของตารางเริ่มต้นในบรรทัดใหม่ ที่ดี!

สไตล์การเยื้อง

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

ศัพท์เทคนิคเรียกว่าการเยื้อง เราบอกว่าชื่อคอลัมน์และประเภทข้อมูลถูกเยื้องไปทางขวา

ความคิดเห็น

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

Fantastic!

ดำเนินการรหัส

ในที่สุดฉันต้องการอธิบายอย่างละเอียดเกี่ยวกับสัญลักษณ์สายฟ้าซึ่งช่วยให้คุณรันโค้ดของคุณ

เริ่มจากความจริงที่ว่าโค้ดของคุณถูกแยกออกเป็นบล็อกตามที่ระบุไว้โดยตัวคั่นเซมิโคลอน ตกลง.

ดังนั้นหากคุณวางเคอร์เซอร์ไว้ที่หนึ่งบล็อกจากนั้นกดไอคอนฟ้าผ่าหรือ Ctrl, Shift, Enter ชุดค่าผสม SQL จะเรียกใช้แบบสอบถามที่เลือกและที่เหลือทั้งหมด

นั่นเป็นเหตุผลที่ถ้าฉันคลิกที่ FROM และรันโค้ดด้วยวิธีนี้ฉันจะเห็นผลลัพธ์จากคำสั่ง SELECT และจะวางตารางทดสอบ

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

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

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