SQL Best Practices - Code sauber und perfekt organisiert eingeben

Code bereinigen

In diesem Beitrag werden wir auf den Codierungsstil achten. Es gibt viele Möglichkeiten, wie Sie Ihren Code schreiben können, aber nur wenige, die als professionell gelten.

Die Einhaltung der Regeln für Codierungsstile ist von entscheidender Bedeutung. Wenn Sie mit der Programmierung nicht nur in SQL, sondern in einer beliebigen Sprache fortfahren, werden Sie niemals alleine arbeiten. Sie werden immer in einem Team arbeiten. Selbst wenn Sie ein Freiberufler sind, der online arbeitet, wird es immer jemanden geben, der Ihren Code irgendwann liest. Dann werden Sie feststellen, dass es einen Begriff gibt, der Ihnen keine Pause verschafft - den des sauberen Codes.

Sauberer Code ist fokussierter und verständlicher Code, dh er muss lesbar, logisch und veränderbar sein. Denken Sie daran: Guter Code ist nicht derjenige, den Computer verstehen. es ist das, was Menschen verstehen können.

Oft kann ein Programm auf verschiedene Arten erstellt werden, und Code kann im Allgemeinen auf verschiedene Arten organisiert werden. Gute Praxis impliziert, dass Sie die Version auswählen, die am einfachsten zu lesen und zu verstehen ist und die Ihre Kollegen nicht daran hindert, sie bei Bedarf zu aktualisieren. Sie werden wahrscheinlich auf Ihrem Code aufbauen. Es ist also am besten, wenn Sie keine Zeit verlieren, Ideen unter komplexen Codezeilen zu finden. Aus diesem Grund wird davon ausgegangen, dass Sie an Ihrem Arbeitsplatz immer sauberen Code eingeben - so einfach wie möglich, perfekt organisiert und unter Beibehaltung eines stetigen logischen Flusses.

Guter Stil

Konzentrieren wir uns nun auf einen anderen Aspekt des Codierens. Wählen Sie beim Zuweisen von Namen zu Variablen oder SQL-Objekten immer kürzere, aussagekräftige Namen, die bestimmte Informationen enthalten. Mit "sinnvoll" meinen wir Namen, die aussprechbar sind und bei denen ein Wort pro Begriff ausgewählt wurde. Dies ist zum Beispiel der Grund, warum wir in der Tabelle "Verkäufe" die "Einkaufsnummer" und nicht die "eindeutige Kundeneinkaufsnummer" ausgewählt haben.

Aus diesem Grund müssen Sie sich nicht beeilen, Namen auszuwählen, da diese so viele Funktionen des Objekts wie möglich widerspiegeln müssen. Namen machen mehr als 80% Ihres Codes aus, es ist also wichtig, mit welchen Sie arbeiten!

Es wird oft diskutiert, ob bei der Codierung Groß- oder Kleinbuchstaben verwendet werden müssen. Die Wahrheit ist - es hängt von Ihrem Stil oder vom Stil des Unternehmens ab, für das Sie arbeiten. In den meisten Fällen schreiben Profis die SQL-Schlüsselwörter in Großbuchstaben und die Namen der Objekte auf andere Weise.

Wenn ein Name mehr als ein Wort enthält, wie z. B. "Kaufnummer", werden Wörter normalerweise entweder durch einen Unterstrich getrennt oder miteinander verbunden, und jedes Wort beginnt mit einem Großbuchstaben. Beide Ansätze sind im professionellen Coding anzutreffen. Eines ist jedoch sicher: Zwischen den Wörtern darf kein Leerzeichen stehen. MySQL zeigt eine Fehlermeldung an, wenn Sie dies versuchen.

Lesbarkeit des Codes

Die dritte Facette, auf die wir uns in diesem Beitrag konzentrieren werden, ist die Lesbarkeit Ihres Codes. Dies betrifft zum einen die horizontale und vertikale Organisation des Codes, zum anderen die Farbe, mit der Wörter angezeigt werden.

Technisch gesehen kann jede SQL-Abfrage in eine einzelne Zeile geschrieben werden. Viele Abfragen sind jedoch zu lang und werden schwer lesbar, wenn wir das tun. In solchen Fällen muss der Code nicht nur horizontal, sondern auch vertikal organisiert werden.

Abhängig von ihrer Bedeutung in einer Abfrage und der Art und Weise, wie sie gelesen werden sollen, können Wörter in verschiedenen Farben geschrieben werden. SQL-Schlüsselwörter sind in Blau, Objektnamen in Schwarz, Zahlen in Orange usw. geschrieben.

Pflegen Sie Ihren Code

Im weiteren Verlauf des Beitrags entwickeln Sie ein Auge für eine einwandfreie Organisation des Codes, den Sie schreiben. Denken Sie vorerst daran, dass es drei Möglichkeiten gibt, Ihren Code gut zu pflegen:

1. Profis verwenden eine Ad-hoc-Software, die Code neu organisiert und verschiedene Wörter einheitlich einfärbt. In einer dynamischeren Codierungsumgebung ist die Zeit ein Faktor, und die Vereinheitlichung des Codierungsstils hat höchste Priorität. Es ist unmöglich, 50 Programmierer in Ihrem Unternehmen zu haben, die alle im selben Stil schreiben. Es ist unprofessionell, in derselben Sprache, aber in einem anderen Stil geschriebenen Code zusammenzuführen. Wenn Sie fertig sind, durchlaufen Teile des Arbeitscodes die Prüfung einer solchen Software, und Ihr Chef hat einen Stapel Code, der alle im gleichen Stil geschrieben ist.

2. Verwenden Sie das entsprechende in Workbench bereitgestellte analoge Tool. Dieser kleine Pinsel verschönert Ihren Code. Die Tastenkombination zum Anwenden dieser Funktion auf die Abfrage, in der sich Ihr Cursor befindet, lautet Strg und B. Sie sehen? Genial!

3. Wenn Sie Ihren Code lieber anders bereinigen möchten, sollten Sie manuell eingreifen und ihn nach Ihren Wünschen anpassen.

Übung

In dieser einfachen Zeile erstellen wir eine Testtabelle mit zwei Spalten - "Numbers" und "Words".

Wir haben den Code in einer Zeile mit kleinen Buchstaben geschrieben. Beachten Sie, wie MySQL die Farbe von Schlüsselwörtern, Datentypen und Zahlen geändert hat. Wir werden uns jetzt nicht mit einer Ad-hoc-Software befassen, da wir uns auf Workbench konzentrieren. Nachdem Sie den Cursor in diese Abfrage gesetzt haben, können Sie auf das kleine Pinselsymbol klicken, um das Skript neu zu formatieren. Denken Sie an die Tastenkombinationen Strg und B, um denselben Vorgang zu beschleunigen.

Beeindruckend! Es funktionierte.

Schlüsselwörter werden in Großbuchstaben geschrieben, und die Daten für jede Tabellenspalte beginnen in einer neuen Zeile. Toll!

Einrückungsstil

Stellen Sie sich vor, Sie haben eine weitere Präferenz hinsichtlich der horizontalen Organisation dieses Codes und der Ausrichtung aller Datentypen. Mit der Tabulatortaste auf Ihrer Tastatur können Sie INT und VARCHAR so einstellen, dass sie am selben horizontalen Punkt beginnen. Nach Ansicht einiger Benutzer verbessert dieser Trick die Lesbarkeit des Codes weiter.

Der Fachbegriff heißt Einrückung. Wir sagen, die Spaltennamen und ihre Datentypen wurden rechts eingerückt.

Bemerkungen

Ein weiterer Aspekt bei der Beibehaltung eines guten Codierungsstils ist die Verwendung von Kommentaren. Dies sind Textzeilen, die von Workbench nicht als Code ausgeführt werden. Sie übermitteln jemandem, der unseren Code liest, eine Nachricht. Technisch gesehen können Sie in MySQL einen Kommentar beginnen, indem Sie einen Schrägstrich und einen Stern eingeben und ihn mit einem Stern und einem Schrägstrich abschließen. Dieser Ansatz wird hauptsächlich für große Kommentare verwendet.
Für einzeilige Kommentare können Sie entweder zwei Bindestriche oder ein oder mehrere Hash-Zeichen verwenden. Um sie von einfachem Code zu unterscheiden, markiert MySQL Workbench außerdem alle Kommentare grau.

Fantastisch!

Code ausführen

Abschließend möchte ich noch auf das Blitzsymbol eingehen, mit dessen Hilfe Sie Ihren Code ausführen können.

Beginnen wir mit der Tatsache, dass Ihr Code in Blöcke unterteilt ist, die durch das Semikolon-Trennzeichen gekennzeichnet sind. OK.

Wenn Sie also den Cursor auf einen Block setzen und dann das Blitzsymbol oder die Tastenkombination Strg, Umschalt, Eingabe drücken, führt SQL die ausgewählten und alle verbleibenden Abfragen aus.

Wenn ich auf FROM klicke und den Code auf diese Weise ausführe, sehe ich daher die Ausgabe der SELECT-Anweisung und lösche die Testtabelle.

Wenn Sie nur die Anweisung unter dem Cursor ausführen möchten, müssen Sie das nebenstehende Symbol drücken, auf dem ein Blitz und ein Cursor dargestellt sind. Die entsprechende Tastenkombination ist Strg und Eingabetaste.

Ich kann versprechen, dass Sie nicht aufhören werden, diese Tastenkombination zu verwenden, da Sie die Ausgabe einer bestimmten Abfrage schnell sehen können, ohne den gesamten SQL-Code ausführen zu müssen.

Naja… ich hoffe dir hat dieser Beitrag gefallen! Es sollte Sie auf den Gedanken der sauberen Codierung und der Codierung in gutem Stil aufmerksam machen. Wir sind der Meinung, dass diese Tools für eine gute professionelle Codierung unerlässlich sind. Wir würden uns freuen, wenn Sie spüren, dass Sie damit begonnen haben, gute Gewohnheiten für den Codierungsstil zu entwickeln.