SQLベストプラクティス—コードをきれいに完全に整理する方法

きれいなコード

この投稿では、コーディングスタイルに注意を払います。コードを書く方法はたくさんありますが、専門家と見なされるものはわずかです。

コーディングスタイルの規則に従うことが重要です。 SQLだけでなく任意の言語でプログラミングを進める場合、自分で作業することはありません。あなたは常にチームで働きます。あなたがオンラインで仕事をしているフリーランサーであっても、いつかあなたのコードを読む人が必ずいるでしょう。次に、ブレークを与えない概念が1つあります。それは、クリーンなコードの概念です。

クリーンコードとは、焦点を絞って理解できるコードのことです。つまり、読みやすく、論理的で、変更可能でなければなりません。覚えておいてください。良いコードはコンピューターが理解するものではありません。それは人間が理解できるものです。

多くの場合、プログラムはさまざまな方法で作成でき、コードは一般にいくつかの方法で編成できます。良い習慣は、読みやすく理解しやすいバージョンを選択し、同僚が必要に応じて更新するのを妨げないバージョンを選択することを意味します。彼らはあなたのコードの上で動作する可能性が高いので、複雑なコード行の下でアイデアを見つけるのに時間を費やさないことが最善です。そのため、職場では常にコードをきれいに入力するという前提があります。可能な限りシンプルで、完璧に整理され、安定した論理フローを維持します。

よいスタイル

それでは、良いスタイルのコーディングの別の側面に注目しましょう。変数またはSQLオブジェクトに名前を割り当てるときは、特定の情報を伝える、より短く意味のある名前を常に選択してください。 「意味のある」とは、概念ごとに1つの単語が選ばれた発音可能な名前を意味します。たとえば、「販売」テーブルで「顧客購入固有番号」ではなく「購入番号」を選択した理由です。

そのアカウントでは、オブジェクトの機能を可能な限り反映する必要があるため、急いで名前を選択する必要はありません。名前はコードの80%以上を構成するため、どの名前を使用するかが重要です。

コーディング時に大文字または小文字を使用する必要があるかどうかについてよく議論されます。真実は-それはあなたのスタイルまたはあなたが働いている会社のスタイルに依存します。ほとんどの場合、専門家はSQLキーワードを大文字にし、オブジェクトの名前を別の方法で記述します。

「購入番号」など、名前に複数の単語が含まれる場合、単語は通常、アンダースコアで区切られるか、互いに結合され、各単語は大文字で始まります。プロのコーディングでは、両方のアプローチに遭遇します。ただし、確かなことは1つです。単語の間に空白を入れることはできません。 MySQLを実行しようとすると、エラーメッセージが表示されます。

コードの読みやすさ

この投稿で焦点を当てる3番目の側面は、コードの可読性です。一方では、これはコードの水平および垂直編成、他方では、単語が表示される色に関連しています。

技術的には、SQLクエリは1行で記述できます。ただし、多くのクエリは長すぎるため、そうすると読みにくくなります。このような場合に行う必要があるのは、コードを水平方向だけでなく垂直方向にも整理することです。

クエリでの意味と、読み方に応じて、単語を異なる色で書くことができます。 SQLキーワードは青、オブジェクト名は黒、数字はオレンジなどで書かれています。

コードを維持する

投稿を進めていく中で、あなたはあなたが書くコードの完璧な組織化の目を養います。とりあえず、コードを適切に保守するには、主に3つの方法があることに注意してください。

1.専門家は、コードを再編成し、さまざまな単語を一貫して色付けするアドホックソフトウェアを使用します。より動的なコーディング環境では、時間が要因となり、コーディングスタイルの統一が最優先事項になります。社内に50人のプログラマーを配置し、全員が同じスタイルで書くことは不可能です。同じ言語で書かれたが異なるスタイルのコードをマージすることは専門的ではありません。そのため、作業コードが完成すると、そのようなソフトウェアのチェックが行われ、上司はすべて同じスタイルで書かれたコードの山を手にします。

2. Workbenchで提供される関連する類推ツールを使用します。この小さなブラシはコードを美しくします。この機能をカーソルのあるクエリに適用するショートカットキーの組み合わせは、CtrlとBです。驚くばかり!

3.コードを別の方法でクリーニングする場合は、手動で介入し、必要に応じて調整する必要があります。

運動

この簡単な行では、「Numbers」と「Words」の2つの列を持つテストテーブルを作成します。

コードを小さな文字で1行に記述しました。 MySQLがキーワード、データ型、および数値の色をどのように変更したかに注目してください。これで、Workbenchに焦点を合わせているため、アドホックソフトウェアを扱うことはなくなります。このクエリのどこかにカーソルを置いた後、小さなブラシアイコンを押してスクリプトを再フォーマットできます。同じ操作をより速く行うには、CtrlとBのショートカットを覚えておいてください。

うわー!出来た。

キーワードは大文字で、テーブルの各列のデータは新しい行から始まります。すばらしいです!

インデントスタイル

このコードの水平編成とすべてのデータ型の配置に関して、さらに好みがあると想像してください。キーボードのタブボタンを使用して、INTとVARCHARを同じ水平ポイントから開始するように設定できます。一部のユーザーによると、このトリックはコードの可読性をさらに向上させます。

専門用語はインデントと呼ばれます。列名とそのデータ型は右側にインデントされていると言います。

コメント

優れたコーディングスタイルを維持するもう1つの側面は、コメントの使用です。これらは、Workbenchがコードとして実行しないテキスト行です。彼らは私たちのコードを読む人にメッセージを伝えます。技術的には、MySQLでは、スラッシュとスターを入力してコメントを開始し、スターとスラッシュで相互に閉じることができます。このアプローチは、主に大きなコメントに使用されます。
1行のコメントの場合、2つのダッシュまたは1つ以上のハッシュ記号を使用できます。さらに、それらを単なるコードと区別するために、MySQL Workbenchはすべてのコメントを灰色でマークします。

素晴らしい!

コードを実行する

最後に、コードの実行に役立つ稲妻のシンボルについて詳しく説明します。

セミコロン区切りでマークされているように、コードがブロックに分割されているという事実から始めましょう。 OK。

したがって、1つのブロックにカーソルを置き、稲妻アイコンまたはCtrl、Shift、Enterの組み合わせを押すと、SQLは選択されたクエリと残りのすべてのクエリを実行します。

そのため、FROMをクリックしてこの方法でコードを実行すると、SELECTステートメントからの出力が表示され、テストテーブルが削除されます。

カーソルの下のステートメントのみを実行する場合は、稲妻とカーソルが描かれている隣のアイコンを押す必要があります。対応するキーボードの組み合わせは、CtrlとEnterです。

このキーボードの組み合わせの使用を停止しないことをお約束します。これにより、SQLコード全体を実行しなくても、特定のクエリの出力をすばやく確認できます。

ええと…この投稿が気に入ってくれたことを願っています!これは、クリーンなコーディングと良いスタイルのコーディングの概念をユーザーに認識させることを目的としています。これらのツールは、優れたプロフェッショナルコーディングに不可欠であると考えているため、優れたコーディングスタイルの習慣を構築し始めたことを感じていただければ幸いです。