はじめに
DreamHanksの松下です。今回はMavenの解説をしていきます。
こちらの記事は下記の記事の補足説明です。
【第二回】SpringとMySqlとMyBatisの連動方法
ビルドツールとは
ビルドツールは、ソースコードからの実行可能アプリケーションの作成を自動化するプログラムです。
今回解説するMavenはpom.xml(Project Object Model)に基づきプロジェクトのライフサイクル全体を管理するものです。
Mavenビルドライフサイクルとは
一般的に「ビルドをする」ということは下記の３つのことを言います。
①作ったソースコードをコンパイルする
②モジュールをWARファイルに圧縮する
③Webアプリケーションサーバにデプロイ（配置）する
しかし実際にはビルドツールはもっと細かい作業を行っています。
ここではその細かい作業とは何があるかを解説していきます。
仕事として「ビルドをする」という言葉を聞いた場合は
上記の3つのことを言っていると覚えておいてください。
Mavenビルドライフサイクル：イメージ図
Mavenのビルドライフサイクルを通ることで安全かつ、自動的にインストールor公開ができます。
◆①pomの作成段階
下記の命令文を使って、pom.xmlの検証やリソースの生成を行います
| 種類 | 内容 |
|---|---|
| validate | 正しい入力値を入力されたかを検証する |
| generate-resources | パッケージに含むリソースを生成する |
| process-resources | リソースを配布用ディレクトリにコピーする |
◆②コンパイル段階
下記の命令文を使って、コンパイルなどを行います。
開発したWebアプリをローカルリポジトリにインストールした後に、ソースの修正をした場合
「①pomの作成段階」からではなくこの段階からライフサイクルを回します。
| 種類 | 内容 |
|---|---|
| compile | ソースコードのコンパイルを行う |
◆③テスト段階
実はMavenを使うことによって単体テストを行うためのソースコードをjunitというテストツールに作る必要がありますが
単体テストを自動化することができます。
開発したWebアプリをローカルリポジトリにインストールした後に、動作確認中に不具合が発生した場合
テストするためにこの段階からライフサイクルを回します。
単体テストをするためのモジュールがない場合は、この段階はスキップします
| 種類 | 内容 |
|---|---|
| generate-test-sources | コンパイルに含むテストソースコードを生成する |
| process-test-sources | テストソースコードに対して処理を行う（フィルタリングなど） |
| generate-test-resources | テスト用リソースを生成する |
| process-test-resources | リソースをテスト用ディレクトリにコピーする |
| test-compile | テストソースコードをコンパイルする |
| process-test-classes | コンパイルで生成したテスト用ファイルに対して後処理を行う（バイトコードの拡張など） |
| test | ユニットテストを行う |
◆④パッケージング段階
下記の命令文を使って、モジュールをwarファイルに圧縮、モジュール全体の結合テストを行います。
| 種類 | 内容 |
|---|---|
| prepare-package | パッケージングの前段階の処理で、ここではパッケージングはされない |
| package | コンパイルコードのパッケージング(jarなど)を行う |
| pre-integration-test | 統合テストの前処理で、必要な環境のセットアップなどを行う |
| integration-test | 統合テストを行う |
| post-integration-test | 統合テストの後処理で、環境のクリーンなどを行う |
| verify | パッケージが有効であること、品質基準を満たしていることをチェックする |
◆⑤インストール段階
下記の命令文を使って、ローカルのWebアプリケーションサーバに
パッケージされたWarファイルをデプロイ（配置）を行います。
| 種類 | 内容 |
|---|---|
| install | ローカルリポジトリにインストールする |
◆⑤公開段階
開発したWebアプリはリモートのWebアプリケーションサーバに
パッケージされたWarファイルをデプロイ（配置）します。
自分で開発したライブラリをMVNリポジトリにデプロイすることもできるようです。
| 種類 | 内容 |
|---|---|
| deploy | リモートリポジトリにデプロイする |
◆ドキュメンテーションについて
これはライフサイクル外の話です。
覚えておくと、自分の開発しているモジュールを分析をするときに役に立ちます。
javadocの作成とは
モジュールの下記のような/** */で囲われた
コメントの＠paramなどのアノテーションに定義されている
コメントを読み取り、下記の画像のように自分の作ったモジュールのjavadocを作ることです。
|
1 2 3 4 5 6 |
<span style="background-color: #f4f4f4; font-family: 'Courier 10 Pitch', Courier, monospace; font-size: 14.4px;"> /**</span> * ログイン画面を開くためのメソッド * @param loginForm クライアント側でloginFormを使えるようにする空クラス * @param model ControllerからViewに値を受け渡すためのパラメータ * @return ログイン画面のJSPファイル名 */ |
javadocの作成の命令文
|
1 |
mvn javadoc |
サイトの作成とは
下記の画像のようにモジュールが
どのようなライブラリやプラグインを使っているのかを分析できるサイトを作ることです。
サイトの作成の命令文
|
1 |
mvn site |
実行方法
①「mvn + 上記の表の命令コマンド」
例）[mvn test]とやることで、コマンドプロンプトなどからコマンド実行ができます。
②下記のようにeclipseから実行することもできます。
しかし個々にMavenの命令文を実行する必要はありません。
・「全てビルド」をする
・「自動的にビルド」にチェックを入れておくだけで、ソースを保存するたびに
eclipseが内部でmvnの命令文を全て実行してくれます。
これをすることでとても便利にMavenを使うことができますが、
普段はMavenを意識するする必要がなくなり、
pomの設定も始めから用意されている開発しか経験をしないと
Mavenってなに？、ビルドツールってなに？という開発者が誕生してしまいます。
Mavenの仕組み
Mavenビルドライフサイクルのイメージ図ある「リモートリポジトリ」とは
具体的に下記のサイトのことです。
Mavenのリモートリポジトリ
このサイトから「ライブラリ」をダウンロードして、ローカルで使えるようにします。
「プラグイン」は上記のサイトではなく、
そのプラグインを提供している公式サイトからダウンロードします。
（例）MyBatis Generator
pom.xmlの構成解説
◆上部の解説
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<span class="o"><?</span><span class="nx">xml</span> <span class="nx">version</span><span class="o">=</span><span class="s2">"1.0"</span> <span class="nx">encoding</span><span class="o">=</span><span class="s2">"UTF-8"</span><span class="cp">?></span> <span class="nt"><project</span> <span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd"</span><span class="nt">></span> <span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span> <span class="nt"><groupId></span>com.dreamhanks<span class="nt"></groupId></span> <span class="nt"><artifactId></span>workmanager<span class="nt"></artifactId></span> <span class="nt"><name></span>WorkManager<span class="nt"></name></span> <span class="nt"><packaging></span>war<span class="nt"></packaging></span> <span class="nt"><version></span>1.0.0-BUILD-SNAPSHOT<span class="nt"></version></span> <span class="nt"><properties></span> <span class="nt"><java-version></span>1.6<span class="nt"></java-version></span> <span class="nt"><org</span><span class="err">.</span><span class="na">springframework-version</span><span class="nt">></span>3.1.1.RELEASE<span class="nt"></org</span><span class="err">.springframework-version</span><span class="nt">></span> <span class="nt"><org</span><span class="err">.</span><span class="na">aspectj-version</span><span class="nt">></span>1.6.10<span class="nt"></org</span><span class="err">.aspectj-version</span><span class="nt">></span> <span class="nt"><org</span><span class="err">.</span><span class="na">slf4j-version</span><span class="nt">></span>1.6.6<span class="nt"></org</span><span class="err">.slf4j-version</span><span class="nt">></span> <span class="nt"></properties></span> |
| 種類 | 内容 |
|---|---|
| modelVersion | POM のバージョン。 特に変更する必要はありません。 |
| groupId | プロジェクトを一意に識別する名前。 プロジェクトのルートパッケージ名を指定するのが一般的です。 |
| artifactId | プロジェクトの成果物の名前。 作成する JAR や WAR, EAR ファイルなどの名前に使用されます。 |
| packaging | 作成する成果物のパッケージング・タイプ。 jar (デフォルト), war, ear などがあります。 |
| version | プロジェクトのバージョン。 |
| name | プロジェクトの表示名。 ドキュメントを作成するときなどに使用されます。 |
| url | プロジェクトのサイトの URL。 ドキュメントを作成するときなどに使用されます。 |
| dependencies | プロジェクトが依存するライブラリの情報。 |
warファイルとは
Webアプリケーションの圧縮ファイル。
このwarファイルをWebアプリケーションサーバにデプロイ（配置）することでアプリケーションを公開（動かすこと）ができる。
Webアプリケーションサーバとは
アプリケーションの実行環境。代表的なものがapach tomcat。
◆ライブラリの解説
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<span class="o"><</span><span class="nx">dependencies</span><span class="o">></span> <span class="o"><!--</span> <span class="nx">MySQL</span> <span class="o">--></span> <span class="o"><</span><span class="nx">dependency</span><span class="o">></span> <span class="o"><</span><span class="nx">groupId</span><span class="o">></span><span class="nx">mysql</span><span class="o"></</span><span class="nx">groupId</span><span class="o">></span> <span class="o"><</span><span class="nx">artifactId</span><span class="o">></span><span class="nx">mysql</span><span class="o">-</span><span class="nx">connector</span><span class="o">-</span><span class="nx">java</span><span class="o"></</span><span class="nx">artifactId</span><span class="o">></span> <span class="o"><</span><span class="nx">version</span><span class="o">></span><span class="mf">8.0</span><span class="o">.</span><span class="mi">11</span><span class="o"></</span><span class="nx">version</span><span class="o">></span> <span class="o"></</span><span class="nx">dependency</span><span class="o">></span> <span class="nx">ほしいライブラリを定義していく</span> <span class="err"> ・</span> <span class="err"> ・</span> <span class="err"> ・</span> <span class="o"></</span><span class="nx">dependencies</span><span class="o">></span> |
dependencyとは
ライフサイクルにおけるリモートリポジトリから
ライブラリをローカルリポジトリにインストールするということです。
このdependenciesタグ内にほしい外部ライブラリを定義することによって
Mavenが外部からダウンロードしてくれます。
このようにMaven依存関係フォルダを見ると、ダウンロードされていることがわかります。
その他にライブラリの追加は下記の方法があります。
・マーケットプレイスからダウンロードする方法
・MVNリポジトリ（Mavenのリポジトリサイト）から直接ダウンロードして、Mavenの依存関係フォルダに配置する方法
◆プラグインの解説
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
<span class="o"><</span><span class="nx">plugins</span><span class="o">></span> <span class="o"><</span><span class="nx">plugin</span><span class="o">></span> <span class="o"><</span><span class="nx">artifactId</span><span class="o">></span><span class="nx">maven</span><span class="o">-</span><span class="nx">eclipse</span><span class="o">-</span><span class="nx">plugin</span><span class="o"></</span><span class="nx">artifactId</span><span class="o">></span> <span class="o"><</span><span class="nx">version</span><span class="o">></span><span class="mf">2.9</span><span class="o"></</span><span class="nx">version</span><span class="o">></span> <span class="o"><</span><span class="nx">configuration</span><span class="o">></span> <span class="o"><</span><span class="nx">additionalProjectnatures</span><span class="o">></span> <span class="o"><</span><span class="nx">projectnature</span><span class="o">></span><span class="nx">org</span><span class="o">.</span><span class="nx">springframework</span><span class="o">.</span><span class="nx">ide</span><span class="o">.</span><span class="nx">eclipse</span><span class="o">.</span><span class="nx">core</span><span class="o">.</span><span class="nx">springnature</span><span class="o"></</span><span class="nx">projectnature</span><span class="o">></span> <span class="o"></</span><span class="nx">additionalProjectnatures</span><span class="o">></span> <span class="o"><</span><span class="nx">additionalBuildcommands</span><span class="o">></span> <span class="o"><</span><span class="nx">buildcommand</span><span class="o">></span><span class="nx">org</span><span class="o">.</span><span class="nx">springframework</span><span class="o">.</span><span class="nx">ide</span><span class="o">.</span><span class="nx">eclipse</span><span class="o">.</span><span class="nx">core</span><span class="o">.</span><span class="nx">springbuilder</span><span class="o"></</span><span class="nx">buildcommand</span><span class="o">></span> <span class="o"></</span><span class="nx">additionalBuildcommands</span><span class="o">></span> <span class="o"><</span><span class="nx">downloadSources</span><span class="o">></span><span class="kc">true</span><span class="o"></</span><span class="nx">downloadSources</span><span class="o">></span> <span class="o"><</span><span class="nx">downloadJavadocs</span><span class="o">></span><span class="kc">true</span><span class="o"></</span><span class="nx">downloadJavadocs</span><span class="o">></span> <span class="o"></</span><span class="nx">configuration</span><span class="o">></span> <span class="o"></</span><span class="nx">plugin</span><span class="o">></span> <span class="nx">ほしいプラグインを定義していく</span> <span class="err"> ・</span> <span class="err"> ・</span> <span class="err"> ・</span> <span class="o"></</span><span class="nx">plugins</span><span class="o">></span> |
pluginとは
ライフサイクルにおけるリモートリポジトリから
プラグインをローカルリポジトリにインストールするということです。
このpluginsタグ内にほしい外部プラグインを定義することによって
Mavenが外部からダウンロードしてくれます。
コメント