Maven クイックスタート

日付:


🚀 はじめに：Mavenクイック・スタート・プロジェクトへようこそ！

Mavenプロジェクトの基本的なセットアップ方法を、GitHubとの連携を含めてステップごとに解説します。初めてMavenを使う方でも、これを見ればすぐにプロジェクトを始められます！

📝 第1章：GitHubリポジトリの準備

まずは、プロジェクトの土台となるGitHubリポジトリを作成しましょう。

1. GitHubにアクセスしてサインイン

  • URL: github.com

  • アカウントにサインインします。

2. 新しいリポジトリの作成

  • サインイン後、画面右上の 「New」 ボタン（または左上のOctocatアイコンからダッシュボードへ）をクリックします。

  • Repository name（リポジトリ名）: maven-quick-start と入力しましょう。

  • Description（説明）: プロジェクトの内容を簡単に書きます。例：「Maven Quick Start Projectで使用するサンプルプロジェクト」

  • 公開/非公開: Publicのままにします。

  • 初期化設定:

    • 「Add a README file」: チェックを入れます。

    • 「Add .gitignore」: Maven を選択します。これにより、プロジェクトで不要なファイルがGitに追跡されないようになります。

    • 「Add a license」: 任意で追加します。

  • 最後に 「Create repository」 をクリックして完了です。

💻 第2章：ローカル環境のセットアップ

次に、作成したGitHubリポジトリを、自分のPCに複製（クローン）します。

1. リポジトリのURLをコピー

  • 作成したリポジトリのページを開きます。

  • Code ボタンをクリックし、HTTPS タブであることを確認して、表示されるURLの横にある**「コピー」**ボタンをクリックします。

2. ターミナルで作業ディレクトリを作成

  • ターミナル（MacならTerminal、WindowsならコマンドプロンプトやGit Bashなど）を開きます。

  • プロジェクトを管理するディレクトリを作成し、移動します。

mkdir projects
cd projects

3. リポジトリをクローン

  • git clone コマンドを使って、先ほどコピーしたURLを貼り付け、実行します。

git clone https://github.com/ユーザー名/maven-quick-start.git

  • ls -al コマンドで、maven-quick-start というフォルダーが作成されていることを確認します。

📂 第3章：Mavenの標準ディレクトリ構造

Mavenプロジェクトには、ソースコードやリソースを配置する場所のルールがあります。これを「標準ディレクトリ・テンプレート」と呼びます。

1. 主なディレクトリ

  • src/main/java: アプリケーションのメインのJavaソースコードを配置します。

  • src/main/resources: 設定ファイルやプロパティファイルなど、メインのソースコードで利用するリソースを配置します。

  • src/test/java: ユニットテスト用のJavaソースコードを配置します。

  • src/test/resources: ユニットテストで利用するリソースを配置します。

2. ディレクトリの作成

  • maven-quick-start ディレクトリに移動し、上記のフォルダ構造をまとめて作成します。

cd maven-quick-start
mkdir -p src/main/java src/main/resources src/test/java src/test/resources

3. 空のディレクトリをGitに保持する

Gitは空のディレクトリを追跡しません。将来的にこの構造を保つために、各ディレクトリにダミーファイルを置きます。慣習として .gitkeep というファイル名が使われます。

touch src/main/java/.gitkeep
touch src/main/resources/.gitkeep
touch src/test/java/.gitkeep
touch src/test/resources/.gitkeep

📝 第4章：pom.xml ファイルの作成と設定

pom.xmlは、Mavenプロジェクトの中心となる設定ファイルです。

1. サンプルpom.xmlの取得

  • GitHubの「programming-clinic/maven-quick-start-course」リポジトリにアクセスします。

  • minimal フォルダ内の pom.xml の内容をコピーします。

2. pom.xmlをプロジェクトに作成

  • プロジェクトのルートディレクトリに、テキストエディタで pom.xml を作成します。

# Macの場合
mate pom.xml
# Windowsの場合
notepad pom.xml

3. pom.xmlの内容を編集

  • コピーした内容を貼り付け、以下の項目を編集します。

    • <groupId>: Javaのパッケージ名のようなもの。通常はドメイン名を逆にしたものを設定します。（例: com.example）

    • <artifactId>: 作成するjarファイルの名前。プロジェクト名と同じにすることが多いです。（例: maven-quick-start）

    • <version>: プロジェクトのバージョン番号。（例: 1.0）

🔨 第5章：ビルドと実行

pom.xmlとディレクトリ構造ができたので、実際にMavenコマンドを実行してみましょう。

1. Javaソースファイルの追加

  • src/main/java の下に、パッケージ名に合わせたディレクトリ構造を作成します。例えば、clinic.programming.training というパッケージなら、clinic/programming/training というフォルダを作成します。

mkdir -p src/main/java/clinic/programming/training

  • programming-clinic/maven-quick-start-course リポジトリにある Application.java の内容をコピーし、先ほど作成したディレクトリ内に Application.java として保存します。

2. ビルドコマンドの実行

  • プロジェクトのルートディレクトリで、mvn package コマンドを実行します。

    • mvn: Mavenコマンドの起動

    • package: pom.xmlに基づいて、プロジェクトをビルドし、jarファイルを作成するフェーズ

mvn package

  • ビルドが成功すると、target ディレクトリが作成され、その中に maven-quick-start-1.0.jar が生成されます。

3. アプリケーションの実行

  • 生成されたjarファイルを、java コマンドで実行します。

java -cp target/maven-quick-start-1.0.jar clinic.programming.training.Application

  • 実行結果として、System.out.println で定義したメッセージが表示されるはずです。

🧹 第6章：プロジェクトのクリーンアップ

ビルド後に生成されたファイルを削除して、プロジェクトをクリーンな状態に戻すことができます。

  • mvn clean コマンドを実行すると、target ディレクトリが削除されます。

mvn clean

  • package と clean を同時に実行することもできます。この場合、clean が先に実行されます。

mvn clean package

📤 第7章：変更をGitHubにプッシュ

ローカルでの作業内容をGitHubにアップロードして、変更を保存しましょう。

1. 変更をGitにステージング

  • git status コマンドで、新しく追加されたファイルを確認します。

  • git add . または git add -A で、変更内容をステージングします。

git add .

2. 変更をコミット

  • -m オプションを使ってコミットメッセージをつけ、コミットします。

git commit -m "Adding Application Java source and project structure"

3. GitHubにプッシュ

  • git push コマンドで、変更をGitHubに送信します。

git push origin master

  • これで、GitHubリポジトリにローカルでの変更が反映されていることを確認できます。



前の記事：Maven 環境準備

次の記事：Maven プラグイン