SQL Best Practices - Jak pisać kod w sposób przejrzysty i doskonale zorganizowany

Wyczyść kod

W tym poście zwrócimy uwagę na styl kodowania. Istnieje wiele sposobów pisania kodu, ale jest tylko kilka uznanych za profesjonalne.

Niezbędne jest przestrzeganie reguł stylu kodowania. Gdy przejdziesz do programowania, nie tylko w języku SQL, ale w dowolnym języku, nigdy nie będziesz pracować samodzielnie. Zawsze będziesz pracować w zespole. Nawet jeśli jesteś freelancerem pracującym online, zawsze znajdzie się ktoś, kto w pewnym momencie przeczyta Twój kod. Następnie dowiesz się, że istnieje jedno pojęcie, które nie zapewni ci przerwy - pojęcie czystego kodu.

Czysty kod to kod skoncentrowany i zrozumiały, co oznacza, że ​​musi być czytelny, logiczny i zmienny. Pamiętaj - dobry kod nie jest tym, który rozumieją komputery; tylko ludzie mogą to zrozumieć.

Często program można utworzyć na wiele sposobów, a kod można ogólnie zorganizować na kilka sposobów. Dobra praktyka oznacza, że ​​wybierzesz wersję, która będzie najłatwiejsza do odczytania i zrozumienia i będzie tą, która nie będzie utrudniać współpracownikom jej aktualizacji w razie potrzeby. Prawdopodobnie będą działały na twoim kodzie, więc najlepiej nie tracić czasu na wymyślanie pomysłów pod złożonymi liniami kodu. Dlatego zakładamy, że w miejscu pracy zawsze będziesz pisać kod w sposób czysty - tak prosty, jak to możliwe, doskonale zorganizowany, utrzymując stały logiczny przepływ.

Dobry styl

Teraz skupmy się na innym aspekcie kodowania w dobrym stylu. Przypisując nazwy do zmiennych lub obiektów SQL, zawsze wybieraj krótsze, znaczące nazwy, przekazujące określone informacje. Przez „znaczący” rozumiemy nazwy, które można wymawiać, w których wybrano jedno słowo na pojęcie. Na przykład dlatego w tabeli „Sprzedaż” wybraliśmy „numer zakupu”, a nie „unikalny numer zakupu klienta”.

Z tego powodu nie musisz śpieszyć się z wybieraniem nazw, ponieważ muszą one odzwierciedlać jak najwięcej funkcjonalności obiektu. Nazwy będą stanowiły ponad 80% twojego kodu, więc ma to znaczenie, z którymi pracujesz!

Często dyskutuje się, czy podczas kodowania należy używać wielkich lub małych liter. Prawda jest taka - zależy to od Twojego stylu lub stylu firmy, w której pracujesz. Najczęściej profesjonaliści będą używać wielkich liter słów kluczowych SQL i będą pisać nazwy obiektów w inny sposób.

Gdy nazwa zawiera więcej niż jedno słowo, takie jak „numer zakupu”, słowa są zwykle albo oddzielane znakiem podkreślenia, albo łączone ze sobą, a każde słowo zaczyna się od dużej litery. Oba podejścia występują w profesjonalnym kodowaniu. Jedno jest pewne - między słowami nie można pozostawić spacji. MySQL wyświetli komunikat o błędzie, jeśli spróbujesz to zrobić.

Czytelność kodu

Trzecim aspektem, na którym skupimy się w tym poście, jest czytelność twojego kodu. Z jednej strony dotyczy to poziomej i pionowej organizacji kodu, z drugiej - koloru, w jakim wyświetlane są słowa.

Technicznie każde zapytanie SQL można zapisać w jednym wierszu. Jednak wiele zapytań jest zbyt długich i stanie się trudnych do odczytania, jeśli to zrobimy. W takich przypadkach należy uporządkować kod, nie tylko w poziomie, ale także w pionie.

W zależności od ich znaczenia w zapytaniu i sposobu, w jaki chcemy, aby były czytane, słowa mogą być pisane w różnych kolorach. Słowa kluczowe SQL są napisane na niebiesko, nazwy obiektów na czarno, liczby na pomarańczowo i tak dalej.

Utrzymaj swój kod

Idąc dalej postem, będziesz zwracać uwagę na nienaganną organizację pisanego kodu. Na razie pamiętaj, że istnieją trzy główne sposoby dobrego utrzymania kodu:

1. Specjaliści używają oprogramowania ad-hoc, które konsekwentnie reorganizuje kod i koloruje różne słowa. W bardziej dynamicznym środowisku kodowania czas będzie czynnikiem, a ujednolicenie stylu kodowania będzie najwyższym priorytetem. W Twojej firmie nie można mieć 50 programistów, którzy piszą w tym samym stylu. Scalanie kodu napisanego w tym samym języku, ale w innym stylu, jest nieprofesjonalne. Tak więc, po zakończeniu, fragmenty działającego kodu przechodzą kontrolę takiego oprogramowania, a twój szef będzie miał stos kodów napisanych w tym samym stylu.

2. Użyj odpowiedniego analogicznego narzędzia dostarczonego w Workbench. Ten mały pędzel upiększa Twój kod. Kombinacja klawiszy skrótu do zastosowania tej funkcji do zapytania, w którym znajduje się kursor, to Ctrl i B. Widzisz? Niesamowite!

3. Jeśli wolisz czyścić kod inaczej, powinieneś interweniować ręcznie i dostosowywać go tak, jak chcesz.

Ćwiczenie

W tym prostym wierszu utworzymy tabelę testową z dwiema kolumnami - „Liczby” i „Słowa”.

Kod napisaliśmy w jednej linii małymi literami. Zauważ, jak MySQL zmienił kolor słów kluczowych, typów danych i liczb. Teraz nie będziemy zajmować się oprogramowaniem ad hoc, ponieważ skupiamy się na Workbench. Po umieszczeniu kursora gdzieś w tym zapytaniu, możesz nacisnąć małą ikonę pędzla, aby ponownie sformatować skrypt. Aby szybciej wykonać tę samą operację, pamiętaj skrót Ctrl i B.

Łał! Zadziałało.

Słowa kluczowe są pisane dużymi literami, a dane dla każdej kolumny tabeli rozpoczynają się od nowej linii. Świetny!

Styl wcięcia

Wyobraź sobie, że masz dalsze preferencje dotyczące poziomej organizacji tego kodu i wyrównania wszystkich typów danych. Za pomocą przycisku tabulatora na klawiaturze możesz ustawić INT i VARCHAR, aby rozpoczynały się w tym samym punkcie poziomym. Według niektórych użytkowników ta sztuczka dodatkowo poprawia czytelność kodu.

Termin techniczny nazywa się wcięciem. Mówimy, że nazwy kolumn i ich typy danych zostały wcięte z prawej strony.

Komentarze

Innym aspektem utrzymania dobrego stylu kodowania jest stosowanie komentarzy. Są to wiersze tekstu, których Workbench nie będzie działał jako kod; przekazują wiadomość komuś, kto czyta nasz kod. Technicznie rzecz biorąc, w MySQL możesz rozpocząć komentarz, wpisując ukośnik i gwiazdkę, i zamykasz go wzajemnie gwiazdką i ukośnikiem. To podejście jest stosowane głównie w przypadku dużych komentarzy.
W przypadku komentarzy jednowierszowych możesz użyć dwóch myślników lub jednego lub więcej znaków skrótu. Ponadto, aby odróżnić je od zwykłego kodu, MySQL Workbench zaznacza wszystkie komentarze na szaro.

Fantastyczny!

Wykonaj kod

Na koniec chciałbym rozwinąć symbol błyskawicy, który pomaga wykonać kod.

Zacznijmy od tego, że twój kod jest podzielony na bloki, oznaczone znakiem separatora średnika. Dobrze.

Tak więc, jeśli umieścisz kursor na jednym bloku, a następnie naciśniesz ikonę błyskawicy lub kombinację klawiszy Ctrl, Shift, Enter, SQL uruchomi wybrane i wszystkie pozostałe zapytania.

Dlatego, jeśli kliknę FROM i wykonam kod w ten sposób, zobaczę wynik instrukcji SELECT i upuszczę tabelę testową.

Jeśli chcesz uruchomić tylko instrukcję pod kursorem, musisz nacisnąć sąsiednią ikonę, na której pokazano błyskawicę i kursor. Odpowiednia kombinacja klawiszy to Ctrl i Enter.

Obiecuję, że nie przestaniesz używać tej kombinacji klawiatury, ponieważ pozwala ona szybko zobaczyć wynik określonego zapytania, bez konieczności uruchamiania całego kodu SQL.

Cóż… Mam nadzieję, że podoba Ci się ten post! Jego celem było uświadomienie Ci pojęcia czystego kodowania i kodowania w dobrym stylu. Uważamy te narzędzia za niezbędne dla dobrego profesjonalnego kodowania, więc bylibyśmy szczęśliwi, gdybyś poczuł, że zacząłeś budować dobre nawyki stylu kodowania.