こちらの記事でMavenのインストールから各種設定ファイルの説明を行います。
Maven入門編
Mavenの超入門編です。少し長いですが頑張って環境構築を行いましょう！
この記事の対象となる方々
- Mavenを使用したいが、環境構築がうまくいかずにはまってしまっている。
- とりあえずMavenの環境構築が早くしたい。仕組みや内容理解は後でいい。
そんな方々のための記事になってると思います。
Mavenとは何か？
こちらに記載させていただいているので、Mavenとは？から知りたい方はこちらを読んでから進んでください。
Mavenのダウンロード
Maven公式(Apache Software Foundation)ページ
公式(Apache Software Foundation)ページよりMavenをダウンロードします。
このページをスクロールしていくと、「Files」というタブがあります。
ここにMaven関連のファイルがまとめてあります。
「Link」列に並ぶのがMaven本体です。
MacOSユーザーであれば⇨「apache-maven-3.5.4-bin.tar.gz」
Windowsユーザーであれば⇨「apache-maven-3.5.4-bin.zip」
リンクをクリックすれば圧縮ファイルがダウンロードできます。
Maven各種ファイルの説明
ダウンロードされた圧縮ファイルを展開すると、新しくフォルダが作成されフォルダ内に以下のようなものが展開されます。
bin | 実行するコマンドのプログラムがまとめてあります。後述するPATHの指定先でもあります。これがあることでmvnコマンドは使用できます。 |
boot | Plexus classwordsというクラスローダープログラムが入っています。 |
conf | 設定情報を記述したXMLファイルが格納されています。settings.xmlファイル格納先。 |
lib | ライブラリファイルがまとめられています。Mavenの本体部分。 |
LICENSE | ライセンス。 |
NOTICE | 気づき？注意事項か何かでしょう。 |
README.txt | ガイドライン的なREADEファイル。 |
フォルダの配置
展開したフォルダを適当な場所において下さい。
例）「C:¥apache-maven-3.5.4」、「C:¥user¥apache-maven-3.5.4」
適当と書きましたが、Cドライブ直下か、ユーザの直下が良いでしょう。
環境設定
MacOSユーザー
- ターミナルを起動後、以下コマンドでバッシュプロファイルを開きます。
view ~/.bash_profile
- ホームディレクトリに「apache-maven-3.5.4」を配置したなら以下のように記述します。
export PATH=$PATH:~/apache-maven-3.5.4/bin
Windowsユーザー
- 「システム」⇨「コントロールパネル」⇨「システム詳細設定」⇨「環境変数」
変数名：Maven_HOME(任意)、変数値：Mavenのディレクトリまでのパス
（例）「C:¥apache-maven-3.5.4」、「C:¥user¥apache-maven-3.5.4」）
- Maven_HOMEを設定したら、PATHに設定したMaven_HOMEを追加します。
Pathの最後に以下を記する。
%Maven_HOME%¥bin
注意「;」で各Pathは区切られていないといけません。「;」がない場合は追記して下さい。
これで.bash_profileが書き換えられ、PATHにMavenディレクトリのbinフォルダが通りました。
binフォルダはmvnコマンドに必要なので、これでmvnコマンドが使用できるようになったはずです。
動作確認
環境設定が完了したら、Mavenのコマンドが実行できるか確認しましょう。
ターミナルorコマンドプロンプトで以下のコマンドを実行して下さい。
mvn -v
これで上記のような画面が出力されれば、正常に動作しています。
Mavenの設定
Mavenが正しくインストールされたことで、今度は設定に入ります。
こちらの設定はプロジェクトで違うと思いますが、必ずやるであろうと思うローカルリポジトリの設定から説明していきます。
ローカルリポジトリの設定は「settings.xml」で行います。
Mavenディレクトリ(Maven_HOME)内の、confディレクトリにある、「settings.xml」にリポジトリのパスを記述することで設定します。
こちらに記載しても良いのですが、「Maven-Settings Reference」に記載があります。
以下そのURL。
https://maven.apache.org/settings.html
There are two locations where a settings.xml file may live:
The Maven install: ${maven.home}/conf/settings.xml
A user’s install: ${user.home}/.m2/settings.xml
The former settings.xml are also called global settings, the latter settings.xml are referred to as user settings.
If both files exists, their contents gets merged, with the user-specific settings.xml being dominant.settings.xmlファイルが存在する場所は2つあります。
Mavenのインストール：$ {maven.home} /conf/settings.xml
ユーザーのインストール：$ {user.home} /。m2 / settings.xml
以前のsettings.xmlはグローバル設定とも呼ばれ、後者のsettings.xmlはユーザー設定と呼ばれます。
両方のファイルが存在する場合、それらの内容はマージされ、ユーザー固有のsettings.xmlが支配的になります。つまり、
「.m２」にユーザ設定として「settings.xml」を配置できます。
そして、ファイルが2つある場合はユーザ設定(.m2ディレクトリ内のsettings.xml)が優先されます。と記載があります。
そのため、筆者は「confディレクトリのsettings.xml」はほとんど修正せずに、「.m2ディレクトリ内のsettings.xml」を修正しています。
前置きが長くなりました。
ローカルリポジトリの設定
「.m2ディレクトリ」はおそらくまだ作成されていないはずなので作成しましょう。
user--.m2--repository
└─settings.xmlsettings.xmlはconfディレクトリ内の物をまるまるコピーして同様の物を作成し、修正しましょう。
コメント分下に以下を記入することでローカルリポジトリの設定は完了します。
C:/user/.m2/repository/
localRepositoryタブで囲んで下さいね。
これでローカルリポジトリの設定は完了しました。
プロキシの設定方法、プロジェクトごとのローカルリポジトリの設定方法等あるのですが、今回は省略します。
pom.xmlの基本を覚える
Mavenを最大限活用するには、「pom.xml」についてマスターすることです。
これだけ書くことができれば、pom.xmlの内容でMavenが自動で作業を行ってくれます。
pom.xmlとは何か
「pom.xml」とは「Project Object Model」の略です。
こちらにプロジェクトに関することを記述しますということですね。
「dependencies」タグ
Mavenがライブラリを管理することができるのは、この「dependencies」タグのおかげです。
直訳で「依存性」。これは、依存しているライブラリなどを自動的にダウンロードしますということを記載するタグです。
「build」タグ
「build」タグの中に「plugin」の情報が記載されています。
ビルドに関する情報を記載するタグです。
コメント