SQL Best Practices - Как правильно и качественно набирать код

Чистый код

В этом посте мы уделим внимание стилю кодирования. Есть много способов написать свой код, но есть только несколько, которые считаются профессиональными.

Соблюдение правил стиля кодирования имеет решающее значение. Когда вы продвигаетесь в программировании, не только в 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.

Ну ... надеюсь, вам понравился этот пост! Он был нацелен на то, чтобы вы знали о чистом кодировании и кодировании в хорошем стиле. Мы считаем эти инструменты необходимыми для хорошего профессионального кодирования, поэтому будем рады, если вы почувствуете, что начали вырабатывать хорошие привычки стиля кодирования.