Praktik Terbaik SQL - Cara mengetik kode dengan rapi dan terorganisir dengan sempurna

Kode Bersih

Dalam posting ini, kita akan memperhatikan gaya pengkodean. Ada banyak cara Anda dapat menulis kode Anda, tetapi hanya ada beberapa yang dianggap profesional.

Mematuhi aturan gaya koding sangat penting. Ketika Anda maju dalam pemrograman, tidak hanya dalam SQL tetapi dalam bahasa apa pun, Anda tidak akan pernah bekerja sendiri. Anda akan selalu bekerja dalam tim. Bahkan jika Anda seorang freelancer yang bekerja online, akan selalu ada seseorang yang akan membaca kode Anda di beberapa titik. Kemudian, Anda akan menemukan ada satu gagasan yang tidak akan memberi Anda istirahat - gagasan kode bersih.

Kode bersih adalah kode yang fokus dan dapat dipahami, yang berarti harus mudah dibaca, logis, dan dapat diubah. Ingat - kode yang baik bukan yang dimengerti komputer; itu yang bisa dipahami manusia.

Seringkali sebuah program dapat dibuat dengan banyak cara, dan kode, secara umum, dapat diatur dalam beberapa cara. Praktik yang baik menyiratkan bahwa Anda akan memilih versi yang paling mudah dibaca dan dipahami serta akan menjadi versi yang tidak menghalangi kolega Anda untuk memperbaruinya saat diperlukan. Mereka mungkin akan bekerja di atas kode Anda, jadi yang terbaik adalah jika mereka tidak kehilangan waktu mencari tahu ide di bawah garis kode yang kompleks. Itu sebabnya asumsinya adalah bahwa, di tempat kerja Anda, Anda akan selalu mengetik kode dengan bersih - sesederhana mungkin, terorganisir dengan sempurna, mempertahankan aliran logis yang mantap.

Gaya yang bagus

Sekarang, mari kita fokus pada aspek pengkodean lain dengan gaya yang baik. Saat menetapkan nama ke variabel atau objek SQL, selalu pilih nama yang lebih pendek dan bermakna, menyampaikan informasi spesifik. Dengan ‘bermakna ', kami berarti nama yang dapat diucapkan, di mana satu kata per konsep telah dipilih. Misalnya, itulah alasan kami memilih "nomor pembelian", bukan "nomor unik pembelian pelanggan" di tabel "Penjualan".

Pada akun itu, Anda tidak perlu terburu-buru untuk memilih nama, karena mereka harus mencerminkan sebanyak mungkin fungsi objek. Nama akan membentuk lebih dari 80% kode Anda, jadi yang penting Anda bekerja dengan siapa!

Sering dibahas apakah huruf besar atau kecil harus digunakan saat pengkodean. Yang benar adalah - itu tergantung pada gaya Anda atau pada gaya perusahaan tempat Anda bekerja. Paling sering, profesional akan menggunakan huruf besar kata kunci SQL dan akan menulis nama objek dengan cara yang berbeda.

Ketika suatu nama terdiri lebih dari satu kata, seperti "nomor pembelian", kata-kata biasanya dipisahkan oleh garis bawah atau dilampirkan satu sama lain, dan setiap kata dimulai dengan huruf kapital. Kedua pendekatan tersebut ditemukan dalam pengkodean profesional. Namun satu hal yang pasti - Anda tidak dapat meninggalkan ruang kosong di antara kata-kata. MySQL akan menampilkan pesan kesalahan jika Anda mencoba melakukan itu.

Keterbacaan Kode

Sisi ketiga yang akan kita fokuskan dalam posting ini adalah keterbacaan kode Anda. Di satu sisi, ini berkaitan dengan pengorganisasian kode horizontal dan vertikal, di sisi lain, warna dengan kata-kata yang ditampilkan.

Secara teknis, setiap permintaan SQL dapat ditulis pada satu baris. Namun, banyak pertanyaan terlalu panjang dan akan menjadi sulit dibaca jika kita melakukannya. Apa yang perlu dilakukan dalam kasus seperti ini adalah mengatur kode, tidak hanya secara horizontal, tetapi juga secara vertikal.

Bergantung pada artinya dalam kueri dan cara kami ingin dibaca, kata-kata dapat ditulis dalam berbagai warna. Kata kunci SQL ditulis dengan warna biru, nama objek berwarna hitam, angka berwarna oranye, dan sebagainya.

Pertahankan Kode Anda

Saat kami melanjutkan dalam posting, Anda akan mengembangkan mata untuk organisasi sempurna dari kode yang Anda tulis. Untuk saat ini, ingat ada tiga cara utama untuk menjaga kode Anda dengan baik:

1. Profesional menggunakan perangkat lunak ad-hoc yang mengatur ulang kode dan warna kata yang berbeda secara konsisten. Dalam lingkungan pengkodean yang lebih dinamis, waktu akan menjadi faktor, dan penyatuan gaya pengkodean akan menjadi prioritas utama. Tidak mungkin memiliki 50 programmer di perusahaan Anda, semuanya menulis dengan gaya yang sama. Tidak profesional untuk menggabungkan kode yang ditulis dalam bahasa yang sama tetapi dengan gaya yang berbeda. Jadi, ketika selesai, potongan kode kerja harus melalui pemeriksaan perangkat lunak seperti itu, dan bos Anda akan memiliki setumpuk kode yang semuanya ditulis dengan gaya yang sama.

2. Gunakan alat analogis relevan yang disediakan di Workbench. Kuas kecil ini mempercantik kode Anda. Kombinasi tombol pintas untuk menerapkan fungsi ini ke kueri tempat kursor Anda berada adalah Ctrl dan B. Anda lihat? Luar biasa!

3. Jika Anda lebih suka membersihkan kode Anda secara berbeda, Anda harus melakukan intervensi secara manual dan menyesuaikannya sesuka Anda.

Olahraga

Dalam baris sederhana ini, kita akan membuat tabel uji dengan dua kolom - "Angka" dan "Kata".

Kami telah menulis kode pada satu baris dengan huruf kecil. Perhatikan bagaimana MySQL mengubah warna kata kunci, tipe data, dan angka. Sekarang, kami tidak akan berurusan dengan perangkat lunak ad-hoc, karena kami berfokus pada Workbench. Setelah menempatkan kursor di suatu tempat di kueri ini, Anda bisa menekan ikon kuas kecil untuk memformat ulang skrip. Untuk melakukan operasi yang sama lebih cepat, ingat pintasan Ctrl dan B.

Wow! Itu berhasil.

Kata kunci dalam huruf kapital, dan data untuk setiap kolom tabel dimulai pada baris baru. Besar!

Gaya Lekukan

Bayangkan Anda memiliki preferensi lebih lanjut mengenai organisasi horizontal kode ini dan pelurusan semua tipe data. Dengan menggunakan tombol tab dari keyboard Anda, Anda dapat mengatur INT dan VARCHAR untuk memulai pada titik horizontal yang sama. Menurut beberapa pengguna, trik ini semakin meningkatkan keterbacaan kode.

Istilah teknisnya disebut indentasi. Kami mengatakan nama kolom dan tipe datanya diindentasi ke kanan.

Komentar

Aspek lain dari mempertahankan gaya pengkodean yang baik adalah menggunakan komentar. Ini adalah baris teks yang Workbench tidak akan jalankan sebagai kode; mereka menyampaikan pesan kepada seseorang yang membaca kode kita. Secara teknis, di MySQL, Anda dapat memulai komentar dengan mengetik garis miring dan bintang dan menutupnya secara timbal balik dengan tanda bintang dan garis miring. Pendekatan ini digunakan terutama untuk komentar besar.
Untuk komentar satu baris, Anda dapat menggunakan dua tanda hubung atau satu atau lebih tanda pagar. Selain itu, untuk membedakannya dari sekadar kode, MySQL Workbench menandai semua komentar berwarna abu-abu.

Fantastis!

Jalankan Kode

Akhirnya, saya ingin menguraikan simbol petir, yang membantu Anda mengeksekusi kode Anda.

Mari kita mulai dari fakta bahwa kode Anda dipisahkan menjadi blok, seperti yang ditandai oleh separator semi-titik dua. Baik.

Jadi, jika Anda meletakkan kursor di satu blok dan kemudian tekan ikon kilat atau Ctrl, Shift, Enter kombinasi, SQL akan menjalankan kueri yang dipilih dan semua yang tersisa.

Itu sebabnya, jika saya mengklik FROM dan mengeksekusi kode dengan cara ini, saya akan melihat output dari pernyataan SELECT dan akan menjatuhkan tabel tes.

Jika Anda ingin menjalankan hanya pernyataan di bawah kursor, Anda harus menekan ikon yang berdekatan, di mana petir dan kursor digambarkan. Kombinasi keyboard yang sesuai adalah Ctrl dan Enter.

Saya bisa berjanji Anda tidak akan berhenti menggunakan kombinasi keyboard ini, karena memungkinkan Anda untuk melihat output dari permintaan tertentu dengan cepat, tanpa harus menjalankan seluruh kode SQL.

Baiklah ... Saya harap Anda menyukai pos ini! Itu bertujuan untuk membuat Anda menyadari gagasan tentang pengkodean bersih dan pengkodean dalam gaya yang baik. Kami menganggap alat ini penting untuk pengkodean profesional yang baik, jadi kami akan senang jika Anda dapat merasakan bahwa Anda mulai membangun kebiasaan gaya pengkodean yang baik.