SQL Best Practices - Πώς να πληκτρολογήσετε κώδικα καθαρά και τέλεια οργανωμένη

Καθαρίστε τον κώδικα

Σε αυτή τη θέση, θα δώσουμε προσοχή στο στυλ κωδικοποίησης. Υπάρχουν πολλοί τρόποι με τους οποίους μπορείτε να γράψετε τον κωδικό σας, αλλά υπάρχουν μόνο λίγοι επαγγελματίες.

Η συμμόρφωση με τους κανόνες στυλ κωδικοποίησης είναι ζωτικής σημασίας. Όταν προχωράτε στον προγραμματισμό, όχι μόνο σε SQL αλλά σε οποιαδήποτε γλώσσα, δεν θα δουλέψετε ποτέ μόνοι σας. Θα εργάζεστε πάντα σε μια ομάδα. Ακόμα κι αν είστε freelancer που εργάζεται online, θα υπάρχει πάντα κάποιος που θα διαβάσει τον κώδικα σας σε κάποιο σημείο. Στη συνέχεια, θα διαπιστώσετε ότι υπάρχει μια ιδέα που δεν θα σας δώσει ένα διάλειμμα - την έννοια του καθαρού κώδικα.

Ο καθαρός κώδικας είναι ένας κώδικας που είναι εστιασμένος και κατανοητός, πράγμα που σημαίνει ότι πρέπει να είναι ευανάγνωστο, λογικό και μεταβλητό. Θυμηθείτε - ο καλός κώδικας δεν είναι αυτός που καταλαβαίνουν οι υπολογιστές. είναι ο άνθρωπος που μπορεί να καταλάβει.

Συχνά, ένα πρόγραμμα μπορεί να δημιουργηθεί με πολλούς τρόπους, και ο κώδικας, γενικά, μπορεί να οργανωθεί με διάφορους τρόπους. Η ορθή πρακτική συνεπάγεται ότι θα επιλέξετε την έκδοση που θα είναι πιο εύκολη στην ανάγνωση και κατανόηση και θα είναι αυτή που δεν εμποδίζει τους συναδέλφους σας από την ενημέρωση όταν είναι απαραίτητο. Θα λειτουργούν πιθανότατα πάνω από τον κώδικα σας, οπότε είναι καλύτερο να μην χάσουν χρόνο να βρουν ιδέες κάτω από σύνθετες γραμμές κώδικα. Αυτός είναι ο λόγος για τον οποίο η υπόθεση είναι ότι στο χώρο εργασίας σας θα πληκτρολογείτε πάντα κώδικα καθαρά - όσο το δυνατόν πιο απλό, οργανωμένο, διατηρώντας σταθερή λογική ροή.

Καλό στιλ

Τώρα, ας επικεντρωθούμε σε μια άλλη πτυχή της κωδικοποίησης σε καλό ύφος. Κατά την αντιστοίχιση ονομάτων σε μεταβλητές ή αντικείμενα SQL, επιλέγετε πάντοτε βραχύτερα, σημαντικά ονόματα, μεταφέροντας συγκεκριμένες πληροφορίες. Με τον όρο «νόημα» εννοούμε ονόματα που είναι προφητικά, όπου έχει επιλεγεί μία λέξη ανά έννοια. Για παράδειγμα, αυτός είναι ο λόγος που επιλέξαμε τον "αριθμό αγοράς" και όχι τον "μοναδικό αριθμό αγοράς πελάτη" στον πίνακα "Πωλήσεις".

Σε αυτό το λογαριασμό, δεν χρειάζεται να είστε βιαστικά για να επιλέξετε ονόματα, αφού πρέπει να αντικατοπτρίζουν όσο το δυνατόν περισσότερη λειτουργικότητα του αντικειμένου. Τα ονόματα θα αποτελούν περισσότερο από το 80% του κωδικού σας, οπότε έχει σημασία ποια από αυτά συνεργάζεστε!

Συχνά συζητείται κατά πόσο πρέπει να χρησιμοποιούνται κεφαλαία ή μικρά γράμματα κατά την κωδικοποίηση. Η αλήθεια είναι - εξαρτάται από το στυλ σας ή από το στυλ της εταιρείας για την οποία εργάζεστε. Τις περισσότερες φορές, οι επαγγελματίες θα αξιοποιήσουν τις λέξεις-κλειδιά SQL και θα γράψουν τα ονόματα των αντικειμένων με διαφορετικό τρόπο.

Όταν ένα όνομα περιλαμβάνει περισσότερες από μία λέξεις, όπως "αριθμός αγοράς", οι λέξεις συνήθως είτε διαχωρίζονται με μια υπογράμμιση είτε συνδέονται μεταξύ τους και κάθε λέξη ξεκινά με ένα κεφαλαίο γράμμα. Και οι δύο προσεγγίσεις συναντώνται στην επαγγελματική κωδικοποίηση. Ένα πράγμα όμως είναι σίγουρο - δεν μπορείτε να αφήσετε ένα κενό διάστημα μεταξύ των λέξεων. Η MySQL θα εμφανίσει ένα μήνυμα σφάλματος αν προσπαθήσετε να το κάνετε αυτό.

Αναγνωσιμότητα κώδικα

Η τρίτη πλευρά στην οποία θα επικεντρωθούμε σε αυτή τη δημοσίευση είναι η αναγνωσιμότητα του κώδικα σας. Από τη μια πλευρά, αυτό αφορά την οριζόντια και κάθετη οργάνωση κώδικα, από την άλλη, το χρώμα με το οποίο εμφανίζονται οι λέξεις.

Από τεχνική άποψη, κάθε ερώτημα SQL μπορεί να γραφτεί σε μία γραμμή. Ωστόσο, πολλά ερωτήματα είναι πολύ μεγάλα και θα είναι δύσκολο να τα διαβάσετε αν το κάνουμε αυτό. Αυτό που πρέπει να γίνει σε τέτοιες περιπτώσεις είναι να οργανωθεί ο κώδικας, όχι μόνο οριζόντια αλλά και κάθετα.

Ανάλογα με τη σημασία τους σε ένα ερώτημα και με τον τρόπο που θέλουμε να διαβαστούν, οι λέξεις μπορούν να γραφτούν σε διαφορετικά χρώματα. Οι λέξεις-κλειδιά SQL γράφονται με μπλε χρώμα, ονόματα αντικειμένων σε μαύρο χρώμα, αριθμοί σε πορτοκαλί και ούτω καθεξής.

Διατηρήστε τον κωδικό σας

Καθώς προχωράμε στη θέση, θα αναπτύξετε ένα μάτι για την άψογη οργάνωση του κώδικα που γράφετε. Προς το παρόν, θυμηθείτε ότι υπάρχουν τρεις βασικοί τρόποι για να διατηρήσετε τον κώδικα σας καλά:

1. Οι επαγγελματίες χρησιμοποιούν λογισμικό ad-hoc που αναδιοργανώνει τον κώδικα και τα χρώματα διαφορετικών λέξεων με συνέπεια. Σε ένα πιο δυναμικό περιβάλλον κωδικοποίησης, ο χρόνος θα είναι ένας παράγοντας, και η ενοποίηση του στυλ κωδικοποίησης θα είναι κορυφαία προτεραιότητα. Είναι αδύνατο να έχετε 50 προγραμματιστές στην επιχείρησή σας, όλοι γράφοντας με το ίδιο στυλ. Είναι αντιεπαγγελματικό να συγχωνεύσετε κώδικα γραμμένο στην ίδια γλώσσα αλλά με διαφορετικό στυλ. Έτσι, όταν ολοκληρωθεί, κομμάτια του κώδικα εργασίας περνούν από τον έλεγχο ενός τέτοιου λογισμικού και ο προϊστάμενός σας θα έχει ένα σωρό κώδικα, όλα γραμμένα με το ίδιο στυλ.

2. Χρησιμοποιήστε το σχετικό αναλογικό εργαλείο που παρέχεται στο Workbench. Αυτό το μικρό πινέλο ομορφύνει τον κώδικα σας. Ο συνδυασμός πλήκτρων συντόμευσης για την εφαρμογή αυτής της λειτουργίας στο ερώτημα όπου βρίσκεται ο δρομέας σας είναι Ctrl και B. Βλέπετε; Φοβερός!

3. Εάν προτιμάτε να καθαρίσετε τον κώδικα διαφορετικά, θα πρέπει να παρέμβετε χειροκίνητα και να το προσαρμόσετε όπως θέλετε.

Ασκηση

Σε αυτή την απλή γραμμή, θα δημιουργήσουμε ένα πίνακα δοκιμών με δύο στήλες - "Αριθμοί" και "Λέξεις".

Έχουμε γράψει τον κώδικα σε μια γραμμή με μικρά γράμματα. Παρατηρήστε πώς η MySQL άλλαξε το χρώμα των λέξεων-κλειδιών, των τύπων δεδομένων και των αριθμών. Τώρα, δεν θα έχουμε να κάνουμε με ένα ad-hoc λογισμικό, καθώς εστιάζουμε στο Workbench. Αφού τοποθετήσετε τον κέρσορα κάπου σε αυτό το ερώτημα, μπορείτε να πατήσετε το εικονίδιο μικρής βούρτσας για να διαμορφώσετε ξανά τη δέσμη ενεργειών. Για να κάνετε την ίδια διαδικασία πιο γρήγορα, θυμηθείτε τη συντόμευση Ctrl και B.

Ουάου! Δούλεψε.

Οι λέξεις-κλειδιά είναι με κεφαλαία γράμματα και τα δεδομένα για κάθε στήλη του πίνακα αρχίζουν σε μια νέα γραμμή. Μεγάλος!

Στυλ εσοχής

Φανταστείτε ότι προτιμάτε περαιτέρω την οριζόντια οργάνωση αυτού του κώδικα και την ευθυγράμμιση όλων των τύπων δεδομένων. Χρησιμοποιώντας το κουμπί καρτέλας από το πληκτρολόγιό σας, μπορείτε να ρυθμίσετε το INT και το VARCHAR να αρχίσουν στο ίδιο οριζόντιο σημείο. Σύμφωνα με ορισμένους χρήστες, αυτό το τέχνασμα βελτιώνει περαιτέρω την αναγνωσιμότητα του κώδικα.

Ο τεχνικός όρος ονομάζεται εσοχή. Λέμε ότι τα ονόματα των στηλών και οι τύποι δεδομένων τους ήταν χαραγμένα στα δεξιά.

Σχόλια

Μια άλλη πτυχή της διατήρησης καλού στυλ κωδικοποίησης είναι η χρήση σχολίων. Αυτές είναι γραμμές κειμένου που το Workbench δεν θα εκτελείται ως κώδικας. στέλνουν ένα μήνυμα σε κάποιον που διαβάζει τον κωδικό μας. Τεχνικά, στη MySQL, μπορείτε να ξεκινήσετε ένα σχόλιο πληκτρολογώντας μια προς τα εμπρός κάθετο και ένα αστέρι και κλείστε την αμοιβαία με ένα αστέρι και μια προς τα εμπρός κάθετο. Αυτή η προσέγγιση χρησιμοποιείται κυρίως για μεγάλα σχόλια.
Για σχόλια μιας γραμμής, μπορείτε να χρησιμοποιήσετε είτε δύο παύλες είτε ένα ή περισσότερα σημάδια κατακερματισμού. Επιπλέον, για να τα διαφοροποιήσετε από τον απλό κώδικα, το MySQL Workbench σηματοδοτεί όλα τα σχόλια με γκρι χρώμα.

Φανταστικός!

Εκτελέστε τον κωδικό

Τέλος, θα ήθελα να επεξεργαστώ το σύμβολο αστραπής, το οποίο σας βοηθά να εκτελέσετε τον κωδικό σας.

Ας ξεκινήσουμε από το γεγονός ότι ο κωδικός σας χωρίζεται σε μπλοκ, όπως σημειώνεται με τον διαχωριστή του ημικυκλίου. Εντάξει.

Έτσι, εάν τοποθετήσετε τον κέρσορα σε ένα μπλοκ και στη συνέχεια πατήσετε το εικονίδιο αστραπής ή τα πλήκτρα Ctrl, Shift, Enter, η SQL θα εκτελέσει τα επιλεγμένα και όλα τα υπόλοιπα ερωτήματα.

Γι 'αυτό, αν κάνω κλικ στο FROM και εκτελέσω τον κώδικα αυτόν τον τρόπο, θα δω την έξοδο από την εντολή SELECT και θα ρίξω τον πίνακα δοκιμών.

Αν θέλετε να εκτελέσετε μόνο τη δήλωση κάτω από το δρομέα, πρέπει να πατήσετε το παρακείμενο εικονίδιο, όπου απεικονίζεται ένας αέρας και ένας δρομέας. Ο αντίστοιχος συνδυασμός πληκτρολογίων είναι Ctrl και Enter.

Μπορώ να σας υποσχεθώ ότι δεν θα σταματήσετε να χρησιμοποιείτε αυτόν τον συνδυασμό πληκτρολογίου, καθώς σας επιτρέπει να δείτε γρήγορα την έξοδο ενός συγκεκριμένου ερωτήματος χωρίς να χρειάζεται να εκτελέσετε ολόκληρο τον SQL κώδικα.

Λοιπόν ... Ελπίζω ότι σας άρεσε αυτό το post! Σκοπός ήταν να σας καταστήσει ενήμερους την έννοια της καθαρής κωδικοποίησης και κωδικοποίησης σε καλό ύφος. Θεωρούμε αυτά τα εργαλεία απαραίτητα για την καλή επαγγελματική κωδικοποίηση, οπότε θα είμαστε ευτυχείς αν μπορείτε να αισθανθείτε ότι ξεκινήσατε να δημιουργείτε καλές συνήθειες κωδικοποίησης.