Кращі практики SQL - Як ввести код чисто і ідеально організовано

Чистий код

У цій публікації ми звернемо увагу на стиль кодування. Існує багато способів написання коду, але існує лише декілька, які вважаються професійними.

Дотримання правил стилю кодування має вирішальне значення. Коли ви просунетесь у програмуванні не тільки в SQL, але будь-якою мовою, ви ніколи не будете працювати самостійно. Ви завжди будете працювати в команді. Навіть якщо ви є фрілансером, який працює в Інтернеті, завжди знайдеться хтось, хто прочитає ваш код у якийсь момент. Потім ви дізнаєтесь, що існує одне поняття, яке не дасть вам перерви - поняття чистого коду.

Чистий код - це сфокусований і зрозумілий код, який означає, що він повинен бути читабельним, логічним та змінним. Пам'ятайте - хороший код - це не те, що комп'ютери розуміють; це той, кого люди можуть зрозуміти.

Часто програма може бути створена багатьма способами, а код, загалом, може бути організований декількома способами. Належна практика передбачає, що ви виберете версію, яка буде найпростішою для читання та розуміння, і буде такою, яка не заважає вашим колегам оновлювати її при необхідності. Вони, ймовірно, працюватимуть над вашим кодом, тому найкраще, якщо вони не втратять часу на з'ясування ідей під складними рядками коду. Ось чому припущення полягає в тому, що на робочому місці ви завжди будете вводити код чисто - максимально простий, ідеально організований, підтримуючи стабільний логічний потік.

Хороший стиль

Тепер зупинимось на іншому аспекті кодування в хорошому стилі. Призначаючи імена змінним або SQL-об'єктам, завжди вибирайте короткі, значущі імена, передаючи конкретну інформацію. Під «значущим» ми маємо на увазі імена, які вимовлятимуться, де було вибрано одне слово за поняттям. Наприклад, саме тому ми вибрали «номер покупки», а не «унікальний номер покупки» у таблиці «Продажі».

У цьому обліковому записі ви не повинні поспішати вибирати імена, оскільки вони повинні відображати якомога більше функціональних можливостей об'єкта. Імена становлять понад 80% вашого коду, тому важливо, з якими ви працюєте!

Часто обговорюється, чи потрібно при кодуванні використовувати великі або малі літери. Правда така - це залежить від вашого стилю або від стилю компанії, в якій ви працюєте. Найчастіше професіонали використовують великі літери SQL і пишуть імена об’єктів по-іншому.

Коли назва містить більше одного слова, наприклад "номер покупки", слова зазвичай або розділені підкресленням, або прикріплені один до одного, і кожне слово починається з великої літери. Обидва підходи зустрічаються у професійному кодуванні. Однак одне впевнене - ви не можете залишати порожній пробіл між словами. Якщо ви спробуєте це зробити, MySQL покаже повідомлення про помилку.

Читання коду

Третя грань, на яку ми зупинимося в цій публікації, - це читабельність вашого коду. З одного боку, це стосується горизонтальної та вертикальної організації коду, з іншого - кольору, з яким відображаються слова.

Технічно будь-який запит SQL можна записати в одному рядку. Однак багато запитів занадто довгі і їх важко буде прочитати, якщо ми це зробимо. Що потрібно зробити в таких випадках - це організувати код не тільки по горизонталі, а й по вертикалі.

Залежно від їх значення в запиті та від того, як ми хочемо, щоб вони були прочитані, слова можна писати різними кольорами. Ключові слова SQL записуються синім кольором, назви об’єктів чорним кольором, цифрами помаранчевим тощо.

Підтримуйте свій код

У міру того, як ми продовжуватимемо публікацію, ви розвинете прихильність до бездоганної організації написаного вами коду. Поки що пам’ятайте, є три основні способи добре підтримувати свій код:

1. Професіонали використовують спеціальне програмне забезпечення, яке послідовно організовує код і кольори різних слів. У більш динамічному середовищі кодування час буде фактором, а уніфікація стилю кодування буде головним пріоритетом. У вашій компанії неможливо мати 50 програмістів, які пишуть в одному стилі. Злиття коду, написаного однією мовою, але іншим стилем, непрофесійно. Отже, після завершення роботи робочий код пройде перевірку такого програмного забезпечення, і ваш начальник матиме купу коду, всі написані в одному стилі.

2. Використовуйте відповідний аналогічний інструмент, наданий у Workbench. Ця маленька пензлик прикрашає ваш код. Комбінація клавіш швидкого доступу, щоб застосувати цю функцію до запиту, де знаходиться ваш курсор, є Ctrl та B. Ви бачите? Дивовижно!

3. Якщо ви вважаєте за краще чистити свій код по-різному, вам слід втрутитися вручну і відрегулювати його як завгодно.

Вправа

У цьому простому рядку ми створимо тестову таблицю з двома стовпцями - «Числа» та «Слова».

Ми написали код на одному рядку малими літерами. Зверніть увагу, як MySQL змінив колір ключових слів, типів даних та чисел. Тепер ми не будемо мати справу з тимчасовим програмним забезпеченням, оскільки ми зосереджуємось на Workbench. Помістивши курсор десь у цьому запиті, ви можете натиснути маленьку піктограму пензля, щоб переформатувати сценарій. Щоб виконати ту саму операцію швидше, запам'ятайте ярлики Ctrl і B.

Оце Так! Це спрацювало.

Ключові слова є великими літерами, а дані для кожного стовпця таблиці починаються з нового рядка. Чудово!

Стиль відступу

Уявіть, що у вас є додаткові переваги щодо горизонтальної організації цього коду та вирівнювання всіх типів даних. За допомогою кнопки вкладки з клавіатури ви можете встановити INT і VARCHAR для початку в одній горизонтальній точці. На думку деяких користувачів, цей трюк ще більше покращує читабельність коду.

Технічний термін називається відступом. Ми кажемо, що назви стовпців та їхні дані були відступними праворуч.

Коментарі

Ще одним аспектом підтримання хорошого стилю кодування є використання коментарів. Це рядки тексту, які Workbench не працюватиме як код; вони передають повідомлення тому, хто читає наш код. Технічно в MySQL ви можете почати коментар, набравши пряму косу рису та зірку та закривши її взаємно зіркою та прямою косою рисою. Цей підхід використовується в основному для великих коментарів.
Для однорядних коментарів ви можете використовувати або два тире або один або більше хеш-знаків. Крім того, щоб відрізняти їх від простого коду, MySQL Workbench позначає всі коментарі сірим кольором.

Фантастичний!

Виконати код

Нарешті, я хотів би детальніше розібратися з символом блискавки, який допоможе вам виконати свій код.

Почнемо з того, що ваш код розділений на блоки, позначені роздільником двокрапки. В порядку.

Отже, якщо розмістити курсор на одному блоці, а потім натиснути піктограму блискавки або комбінацію Ctrl, Shift, Enter, SQL запустить вибрані та всі інші запити.

Ось чому, якщо натиснути FROM і виконати код таким чином, я побачу вихід із оператора SELECT і скину тестову таблицю.

Якщо ви хочете запустити просто курсор під курсором, потрібно натиснути сусідню піктограму, де зображені блискавка та курсор. Відповідна комбінація клавіатур - Ctrl та Enter.

Можу пообіцяти, що ви не перестанете використовувати цю комбінацію клавіатури, оскільки вона дозволяє швидко бачити вихід певного запиту, не запускаючи весь код SQL.

Ну… Я сподіваюся, що вам сподобався цей пост! Вона була спрямована на те, щоб ви зрозуміли поняття чистого кодування та кодування у хорошому стилі. Ми вважаємо ці інструменти важливими для хорошого професійного кодування, тому ми будемо раді, якщо ви зрозумієте, що ви почали формувати звичні стилі кодування.