このガイドでは、Maven を使用して単純な Java プロジェクトを構築する手順を説明します。
時刻を提供するアプリケーションを作成し、Maven で構築します。
https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/prereq_editor_jdk_maven_buildtools.adoc
https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/how_to_complete_this_guide.adoc
まず、Maven がビルドできるように Java プロジェクトをセットアップする必要があります。 Maven に重点を置き続けるために、現時点ではプロジェクトをできるだけシンプルにしてください。選択したプロジェクト フォルダーにこの構造を作成します。
https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/create_directory_ Structure_hello.adoc
src/main/java/helloディレクトリ内に、必要な Java クラスを作成できます。このガイドの残りの部分との一貫性を維持するには、 HelloWorld.javaとGreeter.java 2 つのクラスを作成します。
src/main/java/hello/HelloWorld.java
link : initial / src / main / java / hello / HelloWorld . java [ role = include ] src/main/java/hello/Greeter.java
link : initial / src / main / java / hello / Greeter . java [ role = include ]Maven を使用してプロジェクトを構築する準備ができたので、次のステップは Maven をインストールすることです。
Maven は、https://maven.apache.org/download.cgi から zip ファイルとしてダウンロードできます。必要なのはバイナリのみなので、apache-maven- {version} -bin.zip または apache-maven- {version} -bin.tar.gz へのリンクを探してください。
zip ファイルをダウンロードしたら、コンピュータに解凍します。次に、 binフォルダーをパスに追加します。
Maven のインストールをテストするには、コマンドラインからmvn実行します。
mvn -v
すべてがうまくいけば、Maven のインストールに関する情報が表示されるはずです。これは次のようになります (ただし、多少異なる場合があります)。
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00) Maven ホーム: /home/dsyer/Programs/apache-maven Java バージョン: 1.8.0_152、ベンダー: Azul Systems, Inc. Java ホーム: /home/dsyer/.sdkman/candidates/java/8u152-zulu/jre デフォルトのロケール: en_GB、プラットフォームのエンコーディング: UTF-8 OS名：「linux」、バージョン：「4.15.0-36-generic」、アーチ：「amd64」、ファミリー：「unix」
おめでとう！これで Maven がインストールされました。
情報: Maven ラッパーを使用して、開発者が正しいバージョンの Maven を使用すること、または Maven をインストールする必要がないようにすることを検討するとよいでしょう。 Spring Initializr からダウンロードしたプロジェクトにはラッパーが含まれています。これは、プロジェクトの最上位にスクリプトmvnwとして表示され、 mvnの代わりに実行します。
Maven がインストールされたので、Maven プロジェクト定義を作成する必要があります。 Maven プロジェクトは、 pom.xmlという名前の XML ファイルで定義されます。このファイルには、特に、プロジェクトの名前、バージョン、および外部ライブラリに対する依存関係が含まれています。
プロジェクトのルートにpom.xmlという名前のファイルを作成し (つまり、 srcフォルダーの隣に置きます)、次の内容を追加します。
pom.xml
link:initial/pom.xml[role=include]オプションの
注記 | バージョン管理スキームの選択に関しては、Spring ではセマンティック バージョニング アプローチを推奨しています。 |
この時点で、最小限でありながら有能な Maven プロジェクトが定義されました。
これで Maven はプロジェクトをビルドする準備ができました。 Maven を使用して、プロジェクトのコードをコンパイルし、ライブラリ パッケージ (JAR ファイルなど) を作成し、ローカルの Maven 依存関係リポジトリにライブラリをインストールするという目標を含む、いくつかのビルド ライフサイクル目標を実行できるようになりました。
ビルドを試すには、コマンド ラインで次のコマンドを実行します。
mvn コンパイル
これにより Maven が実行され、コンパイル目標を実行するように指示されます。完了すると、コンパイルされた.classファイルがtarget/classesディレクトリにあるはずです。
.classファイルを直接配布したり操作したりする可能性は低いため、代わりにパッケージゴールを実行することになるでしょう。
mvn パッケージ
パッケージの目標は、Java コードをコンパイルし、テストを実行し、ターゲットディレクトリ内の JAR ファイルにコードをパッケージ化して終了します。 JAR ファイルの名前は、プロジェクトの
JAR ファイルを実行するには、次のコマンドを実行します。
java -jarターゲット/gs-maven-0.1.0.jar
注記 | |
また、Maven は、プロジェクトの依存関係にすばやくアクセスできるように、ローカル マシン (通常はホーム ディレクトリの.m2/repositoryディレクトリ) に依存関係のリポジトリを維持します。プロジェクトの JAR ファイルをローカル リポジトリにインストールする場合は、 installゴールを呼び出す必要があります。
mvn インストール
インストールの目標では、プロジェクトのコードをコンパイル、テスト、パッケージ化してローカルの依存関係リポジトリにコピーし、別のプロジェクトが依存関係として参照できるようにします。
依存関係と言えば、今度は Maven ビルドで依存関係を宣言します。
シンプルな Hello World サンプルは完全に自己完結型であり、追加のライブラリには依存しません。ただし、ほとんどのアプリケーションは、一般的で複雑な機能を処理するために外部ライブラリに依存しています。
たとえば、「Hello World!」と言うことに加えて、アプリケーションに現在の日付と時刻を出力させたいとします。ネイティブ Java ライブラリの日付と時刻機能を使用することもできますが、Joda Time ライブラリを使用すると、物事をさらに面白くすることができます。
まず、HelloWorld.java を次のように変更します。
src/main/java/hello/HelloWorld.java
link : complete / src / main / java / hello / HelloWorld . java [ role = include ]ここで、 HelloWorld Joda Time のLocalTimeクラスを使用して、現在時刻を取得して出力します。
ここでmvn compile実行してプロジェクトをビルドすると、ビルドで Joda Time をコンパイル依存関係として宣言していないため、ビルドは失敗します。これを修正するには、次の行をpom.xml (
< dependencies >
link:complete/pom.xml[role=include]
dependencies > XML のこのブロックは、プロジェクトの依存関係のリストを宣言します。具体的には、Joda Time ライブラリの単一の依存関係を宣言します。
デフォルトでは、すべての依存関係はcompile依存関係としてスコープされます。つまり、これらはコンパイル時 (および WAR ファイルをビルドしている場合 (WAR の/WEB-INF/libsフォルダーを含む)) で利用可能である必要があります。さらに、
provided - プロジェクト コードのコンパイルに必要な依存関係ですが、コードを実行するコンテナ (Java サーブレット API など) によって実行時に提供されます。
test - テストのコンパイルと実行に使用される依存関係ですが、プロジェクトのランタイム コードのビルドや実行には必要ありません。
ここで、 mvn compileまたはmvn package実行すると、Maven は Maven Central リポジトリから Joda Time の依存関係を解決し、ビルドは成功します。
まず、テスト スコープ内の pom.xml に依存関係として JUnit を追加します。
link:complete/pom.xml[role=include]次に、次のようなテスト ケースを作成します。
src/test/java/hello/GreeterTest.java
link : complete / src / test / java / hello / GreeterTest . java [ role = include ] Maven は、単体テストを実行するために「surefire」というプラグインを使用します。このプラグインのデフォルト設定では、 *Testと一致する名前を持つsrc/test/java内のすべてのクラスがコンパイルされ、実行されます。次のようにコマンドラインでテストを実行できます
mvn テスト
または、上ですでに示したように、単にmvn installステップを使用します (「test」が「install」のステージとして含まれるライフサイクル定義があります)。
完成したpom.xmlファイルは次のとおりです。
pom.xml
link:complete/pom.xml[role=include]注記 | 完成したpom.xmlファイルは、JAR ファイルを実行可能にする簡単な便宜のために Maven Shade プラグインを使用しています。このガイドの焦点は、この特定のプラグインを使用することではなく、Maven を使い始めることです。 |
おめでとう！ Java プロジェクトを構築するための、シンプルかつ効果的な Maven プロジェクト定義が作成されました。
次のガイドも役立つ場合があります。
Gradle を使用した Java プロジェクトの構築
https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/footer.adoc
