SQL Best Practices - Как да напишете код чисто и перфектно организиран

Чист код

В тази публикация ще обърнем внимание на стила на кодиране. Има много начини да напишете кода си, но има само няколко считани за професионални.

Спазването на правилата за стил на кодиране е от решаващо значение. Когато напреднете в програмирането, не само в SQL, но и на който и да е език, никога няма да работите сами. Винаги ще работите в екип. Дори и да сте фрийлансър, работещ онлайн, винаги ще има някой, който да прочете вашия код в даден момент. След това ще разберете, че има една идея, която няма да ви даде почивка - понятието чист код.

Чистият код е код, който е фокусиран и разбираем, което означава, че трябва да бъде четим, логичен и променлив. Запомнете - добрият код не е този, който компютрите разбират; това е човекът, който може да разбере.

Често дадена програма може да бъде създадена по много начини, а кодът, като цяло, може да бъде организиран по няколко начина. Добрата практика предполага, че ще изберете версията, която ще бъде най-лесна за четене и разбиране и ще бъде тази, която не пречи на вашите колеги да я актуализират, когато е необходимо. Вероятно ще работят над вашия код, така че е най-добре, ако не губят време да измислят идеи под сложни редове от код. Ето защо предположението е, че на работното си място винаги ще въвеждате код чисто - възможно най-прост, перфектно организиран, поддържайки постоянен логичен поток.

Добър стил

Сега, нека се съсредоточим върху друг аспект на кодирането в добър стил. Когато присвоявате имена на променливи или SQL обекти, винаги избирайте по-кратки, смислени имена, предаващи конкретна информация. Под „смислено“ имаме предвид имена, които могат да се произнасят, където е избрана една дума за понятие. Например, това е причината да изберете „номер на покупка“, а не „уникален номер за покупка на клиенти“ в таблицата „Продажби“.

В този акаунт не е необходимо да бързате да избирате имена, тъй като те трябва да отразяват възможно най-голяма част от функционалността на обекта. Имената ще представляват повече от 80% от кода ви, така че има значение с кои от тях работите!

Често се обсъжда дали при кодирането трябва да се използват главни или малки букви. Истината е - това зависи от вашия стил или от стила на компанията, в която работите. Най-често професионалистите ще използват главни букви на SQL и ще пишат имената на обекти по различен начин.

Когато дадено име съдържа повече от една дума, например „номер на покупка“, думите обикновено се разделят с подчертаване или се прикрепят една към друга и всяка дума започва с главна буква. И двата подхода се срещат при професионалното кодиране. Едно е сигурно обаче - не можете да оставяте празно място между думите. MySQL ще покаже съобщение за грешка, ако се опитате да го направите.

Четене на код

Третият аспект, на който ще се съсредоточим в тази публикация, е четимостта на вашия код. От една страна, това се отнася до хоризонталната и вертикалната организация на кода, от друга, цвета, с който се показват думите.

Технически всяка SQL заявка може да бъде написана на един ред. Въпреки това, много заявки са твърде дълги и ще ни стане трудно за четене, ако направим това. Това, което трябва да се направи в такива случаи, е да се организира кодът не само хоризонтално, но и вертикално.

В зависимост от значението им в заявка и от начина, по който искаме да бъдат прочетени, думите могат да бъдат написани в различни цветове. SQL ключовите думи са написани в синьо, имената на обекти в черно, числата в оранжево и т.н.

Поддържайте своя код

Докато продължаваме в публикацията, вие ще развиете око за безупречната организация на кода, който пишете. За сега не забравяйте, че има три основни начина да поддържате добре кода си:

1. Професионалистите използват ad-hoc софтуер, който преорганизира кода и оцветява различни думи последователно. В по-динамична среда за кодиране времето ще бъде фактор и обединяването на стила на кодиране ще бъде основен приоритет. Невъзможно е да имате 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 код.

Е ... Надявам се, че този пост ви е харесал! Тя имаше за цел да ви запознае с понятието чисто кодиране и кодиране в добър стил. Смятаме, че тези инструменти са от съществено значение за доброто професионално кодиране, така че ще се радваме, ако усетите, че сте започнали да изграждате добри навици в стила на кодиране.