# Java SonarQubeのインストールと基本設定

## 目次

1. はじめに

2. SonarQubeとは？

3. SonarQubeの必要要件

4. ダウンロードとインストール

   - 4-1. ソフトウェアのダウンロード

   - 4-2. インストール手順

5. SonarQubeの起動と初期設定

   - 5-1. サーバーの起動

   - 5-2. Webインターフェースへのアクセス

   - 5-3. 初期設定の完了

6. Javaプロジェクトのスキャン設定

   - 6-1. プロジェクトの作成

   - 6-2. sonar-project.propertiesの作成

   - 6-3. スキャナーの実行

7. CI/CDパイプラインへの統合

8. SonarQubeの基本設定

   - 8-1. プロファイルの設定

   - 8-2. アラート閾値の設定

9. まとめ

## 1. はじめに

ソフトウェア開発において、コード品質の保証は非常に重要です。それを実現するための有力なツールの一つがSonarQubeです。JavaプロジェクトにおけるSonarQubeのインストールから基本的な設定までの流れを解説します。

## 2. SonarQubeとは？

SonarQubeはオープンソースのプラットフォームであり、コード品質の管理を行うことができます。静的コード解析を通じてバグ、コードの臭い（コードスミール）、およびセキュリティ上の脆弱性を発見します。Javaをはじめとする様々なプログラミング言語をサポートしており、ソフトウェア品質の大幅な向上が見込まれます。

## 3. SonarQubeの必要要件

SonarQubeを動作させるには以下の環境が必要です：

- オペレーティングシステム：Linux、Windows、またはmacOS

- Java環境：Java（基本的にはJava 11）

- データベース：PostgreSQL、MySQL、Oracle、SQL Serverなど

- RAM：最小2GB以上を推奨

## 4. ダウンロードとインストール

### 4-1. ソフトウェアのダウンロード

SonarQubeは公式サイトからダウンロードできます。まず、[SonarQubeのダウンロードページ](https://www.sonarqube.org/downloads/)にアクセスし、最新のLTSバージョンを取得してください。

### 4-2. インストール手順

1. ダウンロードしたSonarQubeのアーカイブを解凍します。

2. 例: `unzip sonarqube-<version>.zip`

3. 解凍されたディレクトリを適切な場所に移動します。

## 5. SonarQubeの起動と初期設定

### 5-1. サーバーの起動

1. SonarQubeの`bin`ディレクトリに移動します。

2. OSに応じたディレクトリに入り、以下のコマンドでサーバーを起動します：

   ```bash

   ./sonar.sh start

   ```

### 5-2. Webインターフェースへのアクセス

Webブラウザーで `http://localhost:9000` にアクセスし、SonarQubeのWebインターフェースを開きます。初回アクセス時のログイン情報は、ユーザー名: `admin`、パスワード: `admin`です。

### 5-3. 初期設定の完了

初回ログイン後、データベース接続の設定を行います。設定が完了すると、SonarQubeのメインダッシュボードにアクセスできます。

## 6. Javaプロジェクトのスキャン設定

### 6-1. プロジェクトの作成

SonarQube上で新しいプロジェクトを作成します。「Projects」タブで「Create New Project」を選択します。

### 6-2. sonar-project.propertiesの作成

プロジェクトディレクトリに`sonar-project.properties`ファイルを作成します。このファイルに基本的な設定を記述します。

```properties

sonar.projectKey=my_project

sonar.projectName=My Project

sonar.projectVersion=1.0

sonar.sources=src

```

### 6-3. スキャナーの実行

SonarScannerをダウンロードし、プロジェクトのルートディレクトリで以下のコマンドを実行します。

```bash

sonar-scanner

```

## 7. CI/CDパイプラインへの統合

JenkinsやGitLab CI/CDなどのCI/CDパイプラインにSonarQubeを統合することで、コードのプッシュやPR時に自動的なコード解析を実行することができます。具体的な設定は、使用するCI/CDツールにより異なりますが、主にビルドジョブ内にSonarQubeステージを追加します。

## 8. SonarQubeの基本設定

### 8-1. プロファイルの設定

SonarQubeの品質プロファイルは、コード解析のルールセットを定義しています。デフォルトのプロファイルを使用するか、独自のニーズに合わせてカスタマイズが可能です。

### 8-2. アラート閾値の設定

プロジェクトに設定したアラート閾値は、品質ゲートの一部として機能します。例えば、テストカバレッジが80%以下の場合にアラートを発生させることができます。

## 9. まとめ

SonarQubeは、Javaプロジェクトのコード品質を保証するための強力なツールです。このガイドでは、インストールから基本設定までを具体的に解説しました。今後はCI/CD環境と連携させることで、よりスムーズな品質管理が可能となります。是非、プロジェクトに取り入れてみてください。

Java SonarQubeのインストールと基本設定

目次

続きを読むには単価診断を受けてください（30秒）