ソフトウェア開発において、コードの品質を維持することは非常に重要です。
その中でも、静的解析ツールとして広く利用されているのが「SonarQube」です。
SonarQubeを導入することで、バグやセキュリティリスク、コードの問題点を自動的に検出できるようになり、開発の効率と品質を大きく向上させることができます。
しかし、いざ導入しようとすると「インストール手順が難しそう」「何を準備すればいいのかわからない」と感じる方も多いでしょう。
この記事では、SonarQubeのインストール方法を初心者でも理解できるように、環境準備から起動・初期設定まで丁寧に解説します。
SonarQubeとは何か
SonarQubeとは、ソースコードの品質を自動的にチェックする静的解析ツールです。
主な特徴は以下の通りです。
・バグの検出
・セキュリティ脆弱性の発見
・コードの重複チェック
・保守性の評価
・品質メトリクスの可視化
JavaやPython、JavaScriptなど多くの言語に対応しており、CI/CD環境と連携することで継続的な品質管理が可能になります。
SonarQubeインストール前の準備
SonarQubeをインストールする前に、いくつか準備しておくべきものがあります。
Javaのインストール
SonarQubeはJavaで動作するため、まずはJavaの実行環境が必要です。
推奨されるのは以下のような環境です。
・Java 17以上
・64bit環境
インストール後は、以下のコマンドで確認します。
java -version
正しくバージョンが表示されれば準備完了です。
データベースの準備
SonarQubeは内部にデータを保存するため、データベースが必要です。
主に利用されるのは以下です。
・PostgreSQL
・MySQL（非推奨になりつつある）
本格運用ではPostgreSQLの利用が推奨されています。
メモリ要件
SonarQubeは比較的メモリを使用します。
最低でも以下を確保してください。
・メモリ：2GB以上（推奨4GB以上）
・ディスク：1GB以上
SonarQubeのダウンロード方法
まずはSonarQube本体をダウンロードします。
公式サイトから最新版を取得するのが基本です。
ダウンロード手順は以下です。
- 公式サイトへアクセス
- Community Editionを選択
- ZIPファイルをダウンロード
ダウンロード後、任意のディレクトリに解凍します。
SonarQubeのインストール手順（Windows）
ここではWindows環境での手順を解説します。
フォルダの配置
解凍したフォルダを以下のような場所に配置します。
例：
C:\sonarqube
日本語やスペースを含まないパスにするのがポイントです。
設定ファイルの編集
以下のファイルを編集します。
conf\sonar.properties
データベース接続情報を設定します。
例：
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonarqube
必要に応じてポート番号なども変更可能です。
起動方法
以下のバッチファイルを実行します。
bin\windows-x86-64\StartSonar.bat
起動後、ブラウザで以下にアクセスします。
http://localhost:9000
ログイン画面が表示されれば成功です。
SonarQubeのインストール手順（Linux）
Linux環境でも基本的な流れは同じです。
ファイルの解凍
unzip sonarqube.zip
cd sonarqube
実行権限の付与
chmod +x bin/linux-x86-64/sonar.sh
起動
bin/linux-x86-64/sonar.sh start
ブラウザでアクセスして確認します。
初回ログインと初期設定
SonarQubeを起動するとログイン画面が表示されます。
初期アカウントは以下です。
・ユーザー名：admin
・パスワード：admin
ログイン後は必ずパスワードを変更してください。
プロジェクトの作成方法
SonarQubeで解析を行うには、プロジェクトを作成する必要があります。
手順は以下です。
- 「Create Project」をクリック
- プロジェクトキーを入力
- トークンを発行
このトークンは後ほど解析時に使用します。
SonarScannerの設定
コード解析には「SonarScanner」を使用します。
インストール
SonarScannerをダウンロードして解凍します。
設定ファイル
sonar-project.properties
例：
sonar.projectKey=my_project
sonar.sources=.
sonar.host.url=http://localhost:9000
sonar.login=トークン
実行
sonar-scanner
解析結果がSonarQubeに表示されます。
よくあるエラーと対処法
インストール時によくある問題も押さえておきましょう。
ポートが使用中
9000番ポートが使われている場合は変更します。
sonar.web.port=9001
Javaのバージョンエラー
Javaのバージョンが古いと起動できません。
Java 17以上を使用してください。
メモリ不足
起動時にエラーが出る場合はメモリ設定を見直します。
conf\sonar.properties
または
wrapper.conf
で調整可能です。
SonarQubeを導入するメリット
SonarQubeを導入することで得られるメリットは非常に大きいです。
・コード品質の可視化
・バグの早期発見
・セキュリティ向上
・チーム開発の効率化
・レビュー工数の削減
特に継続的インテグレーションと組み合わせることで、品質管理の自動化が実現できます。
SonarQube運用のポイント
運用する上でのポイントも押さえておきましょう。
・定期的に解析を実行する
・品質ゲートを設定する
・技術的負債を可視化する
・CI/CDと連携する
これにより、長期的な品質改善が可能になります。
まとめ
SonarQubeは、コード品質を向上させるための強力なツールです。
インストール自体は、Javaとデータベースを準備し、設定ファイルを編集することで比較的簡単に行えます。
最初は少し難しく感じるかもしれませんが、一度環境を構築してしまえば、その後の開発効率は大きく改善されます。
ぜひ本記事を参考に、SonarQubeの導入にチャレンジしてみてください。