コーディング標準と静的コード チェック プラグインの使用方法

この記事では、コーディング標準と静的コード チェック プラグインの使用方法を紹介します。一定の参考値があるので、困っている友達が参考になれば幸いです。

Alibaba Java コーディング ガイドライン

最初の紹介は、Alibaba のコーディング規約です。これは誰もがよく知っていると思います。インストール方法は

settings->plugins里面搜索
Alibaba Java Coding Guidelines-
>install->重启Idea

このプラグインはコードの不具合に焦点を当てており、詳細なコーディング仕様は「Alibaba 開発マニュアル」に定められていますので、興味のある方はご覧ください。

プロジェクト全体のすべてのファイルを確認したい場合は、ウィンドウ内のクラスを閉じてから、Ctrl Alt Shift J ショートカット キーを押すか、次の操作を実行できます。以下に示すように。

チェックの結果は次の図に示すようになります。

単一のファイルをチェックしたい場合は、次のようにすることができます。クラスを右クリックし、「Alibabacoding guideline Analyze」を選択します。

CheckStyle

導入する 2 番目のプラグインは、CheckStyle プラグインです。このプラグインはコード形式のチェックに重点を置いています。使用方法は次のとおりです。 checkstyle パネルでチェックボタンをクリックしてチェックするか、単一のファイルをチェックすることができます。

#上の図のように、インデントなどについてはコーディング規約がいくつかあるので、あまり気にする必要はありません。彼ら。

Findbugs

findBugs-idea の機能は、コード内に存在する可能性のあるバグを見つけることに重点を置いています。クラスまたは JAR ファイルを検査し、バイトコードを一連の欠陥パターン (組み込み検出器を使用) と比較して、考えられる問題を見つけます。 Findbugs コーディング規約スキャンを実行する PMD

(Programming Mistake Detector) は、オープンソースの静的コード検査ツールです。 PMD は、プロジェクト自体の Java、Salesforce に関連する Apex や VisualForce、さらに JavaScript、XML などの複数の言語をサポートします。 PMD には、さまざまな言語のコーディング ルールのプリセット セットがあり、Java クラスまたは XPath を使用したカスタム ルールの開発もサポートしています。

コードの一部を選択し、Run PMD->Pre Defined を右クリックします。コード スタイル、デザインなど、選択できる検査タイプは多数あります。

SonarLint

最後に紹介するのは、SonarLint プラグイン、このプラグイン、および ## です。 #Alibaba Java コーディング ガイドライン プラグイン これらは、実際のプロジェクトでより頻繁に使用される 2 つのプラグインです。ここではプラグインのインストールと使い方を詳しく紹介します。

インストール

settings->plugins里面搜索
SonarLint
>install->重启Idea

SonnarLintチェックアドレスを設定します:

settings->Tools->SonarLint->Settings 
中增加sonarqube的地址

以下に示すようにsonarqubeのアドレスを設定します

SonarListを使用します

SonarList を設定した後、それを使用できます。SonarLint はすべてのファイルをチェックできます。すべてのファイルをチェックする方法は次のとおりです:

Analyze->Analyze All Files with SonarLint をクリックします。

単一のファイルを確認することもできます。単一のファイルは、ファイル編集領域で右クリックして選択されます:

生成されたレポートは次のとおりです。 ここには両方の違反問題 (つまり、潜在的なバグと脆弱性) があります。例: NullPointerException。これにも悪いコード臭 (コード臭) があります。一般的に、バグレベルの問題に対処する必要があり、悪臭は無視できます。もう 1 つの指標は、コードの重複率、つまりコード内で繰り返されるコードです。

さまざまなプラグインの比較

検査の焦点の違い

#ツール分析オブジェクト重点を置くアプリケーション テクノロジー##Alibaba Java コーディング ガイドライン# #CheckStyleソース ファイルフォーマットの欠陥欠陥パターンの一致FindBugsバイトコードコードの欠陥欠陥パターン マッチング、データ フロー分析PMDソース コードコードの欠陥欠陥パターンマッチングSonarListソースコードコード欠陥欠陥パターンマッチング、多次元処理各種チェック項目

ソース コード	コードの欠陥	検査メカニズムによりリアルタイム検出機能が提供されます

ツール目的チェック項目Alibaba Java コーディング ガイドライン潜在的なコード ハザードをすべてスキャンするメソッド名パラメータ名メンバー変数ローカル変数列挙クラス try -catch CheckStyleJava ソース ファイルがコード仕様と一致しているかどうかを確認します。Javadoc コメント命名仕様タイトルインポート文のボリューム サイズ空白FindBugsバグ パターンの概念に基づいて、javabytecode (.class ファイル) の潜在的なバグを検出します。NullPoint の null ポインタ チェック、不当なリソースのクローズなしPMDJava ソース ファイルに潜在的な問題がないか確認してください未使用のローカル変数、空の catch ブロック、未使用のパラメーター、空の if ステートメント、繰り返される import ステートメント、未使用のプライベート メソッドは、Singleton クラスの short/long 変数とメソッド名である可能性がありますSonarListすべての潜在的なコード ハザードをスキャンしますMethods Name パラメーター名メンバー変数 ローカル変数列挙クラス try-catch関連する無料学習の推奨事項:

Java 基本チュートリアル

以上がコーディング標準と静的コード チェック プラグインの使用方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。