# Java Bitbucket PipelinesとSonarQubeを連携する方法

## 目次

1. はじめに

   1-1. 背景と目的

   1-2. 本記事の概要

2. 必要なツールと設定

   2-1. Bitbucket Pipelinesとは

   2-2. SonarQubeとは

   2-3. 必要なソフトウェアのインストール

3. Bitbucket Pipelinesの設定

   3-1. Bitbucketリポジトリの作成

   3-2. `bitbucket-pipelines.yml`ファイルの作成

4. SonarQubeの設定

   4-1. SonarQubeサーバーのセットアップ

   4-2. プロジェクトトークンの生成

   4-3. SonarQubeのプロパティファイルの作成

5. Bitbucket PipelinesとSonarQubeの連携

   5-1. `sonar-project.properties` ファイルの作成

   5-2. パイプラインの実行と確認

6. 最適化とベストプラクティス

   6-1. パフォーマンス最適化

   6-2. よくある問題とその解決策

7. まとめ

## 1. はじめに

### 1-1. 背景と目的

モダンなソフトウェア開発では、コード品質の向上と継続的インテグレーション/デリバリー（CI/CD）が重要視されています。その中で、Bitbucket PipelinesとSonarQubeは、それぞれCI/CDの自動化とコード品質管理における有力なツールです。この二つを連携することで、より効率的な開発プロセスを構築できます。

### 1-2. 本記事の概要

本記事では、Javaプロジェクトを対象に、Bitbucket PipelinesとSonarQubeを連携させる具体的な手順を解説します。必要なツールの設定から実際のCI/CDパイプラインの構築まで、詳細に説明します。[cv:issue_marketplace_engineer]

## 2. 必要なツールと設定

### 2-1. Bitbucket Pipelinesとは

Bitbucket Pipelinesは、Bitbucketが提供するクラウドベースのCI/CDサービスです。リポジトリ内に設定ファイル（`bitbucket-pipelines.yml`）を置くことで、自動的にビルド、テスト、デプロイなどのプロセスを管理できます。

### 2-2. SonarQubeとは

SonarQubeは、コードの品質を継続的に検査し、バグやセキュリティ脆弱性を検出するためのオープンソースプラットフォームです。SonarQubeは多くのプログラミング言語をサポートし、詳細なレポートを提供します。

### 2-3. 必要なソフトウェアのインストール

- Docker: Bitbucket PipelinesとSonarQubeの両方で必須

- Java: プロジェクトで使用するJavaランタイム（例: JDK 11）

- MavenまたはGradle: Javaプロジェクトのビルドツール

## 3. Bitbucket Pipelinesの設定

### 3-1. Bitbucketリポジトリの作成

Bitbucketアカウントを作成し、新しいリポジトリを設定します。このリポジトリがパイプラインの基盤となります。

### 3-2. `bitbucket-pipelines.yml`ファイルの作成

以下にJavaプロジェクトのための基本的な`bitbucket-pipelines.yml`の例を示します。

```yaml

image: maven:3.8.4-openjdk-11

pipelines:

  default:

    - step:

        caches:

          - maven

        script:

          - mvn clean install

          - mvn sonar:sonar

        services:

          - docker

```

このファイルでは、Mavenを使ってプロジェクトをビルドし、SonarQube用の解析を実施しています。

## 4. SonarQubeの設定

### 4-1. SonarQubeサーバーのセットアップ

SonarQubeをローカルマシンまたはクラウドサーバーにインストールします。Dockerを用いて簡単にデプロイすることができます。

```bash

docker run -d --name sonarqube -p 9000:9000 sonarqube

```

このコマンドを使うと、ローカルのポート9000でSonarQubeが利用可能になります。

### 4-2. プロジェクトトークンの生成

SonarQubeにアクセスし、新しいプロジェクトを作成してプロジェクトトークンを取得します。このトークンは、パイプラインでSonarQubeサーバーと通信するために使用します。

### 4-3. SonarQubeのプロパティファイルの作成

プロジェクトのルートディレクトリに`sonar-project.properties`ファイルを作成します。このファイルには以下の設定を含めます。

```properties

sonar.projectKey=my-java-project

sonar.host.url=http://localhost:9000

sonar.login=YOUR_PROJECT_TOKEN

sonar.sources=src/main/java

```

`YOUR_PROJECT_TOKEN`の部分は生成したプロジェクトトークンに置き換えます。

## 5. Bitbucket PipelinesとSonarQubeの連携

### 5-1. `sonar-project.properties` ファイルの作成

先ほど説明したように、このファイルはSonarQubeによるコード解析を担う中心的な設定ファイルです。

### 5-2. パイプラインの実行と確認

リポジトリに対してコミットを行うと、パイプラインが自動的に実行されます。Bitbucketのパイプラインタブで実行状況を確認できます。ビルドが成功すると、SonarQubeサーバーのダッシュボードで詳細な解析結果を見ることができます。

## 6. 最適化とベストプラクティス

### 6-1. パフォーマンス最適化

- **キャッシュの有効利用**: Mavenの依存関係をキャッシュすることで、ビルド時間を短縮できます。

- **パイプラインの分割**: テストとデプロイのステージを分けることで、より効率的な実行が可能です。

### 6-2. よくある問題とその解決策

- **ネットワーク設定の確認**: SonarQubeサーバーのURL設定が誤っている場合、アクセスエラーが発生します。正しいURLを設定していることを確認してください。

- **アクセストークンの管理**: SonarQubeのプロジェクトトークンは失効しないよう、JenkinsなどのCIツールで定期的に確認が必要です。

## 7. まとめ

Bitbucket PipelinesとSonarQubeを連携することにより、効率的なコード品質管理とビルドの自動化が実現されます。この連携により、プロジェクトのデリバリーサイクルの短縮と開発効率の向上を図ることができます。この記事で紹介した手順を基に、あなたのプロジェクトでも是非試してみてください。

Java Bitbucket PipelinesとSonarQubeを連携する方法

目次

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