Mavenを利用して、好きなJavaライブラリを環境に追加する。

はじめに

ちょっと前に自作したJavaの動画エンコードアプリをメンテしようと思ったのですが、環境が変わると再度外部ライブラリ(JavaCV, JavaCPP)周りをまた構築しなければならない作りになっていました。(流石Windowsアプリ初心者、いけてない)

というわけで、いつでも簡単にJavaCVが使えるようMaven環境を作成したのでその覚書です。

Mavenとは？

色々あると思いますが、本記事でのポイントになることだけ抜粋。

1. ビルド情報はpom.xmlファイルに記載すればOK！
2. 必要なJavaのライブラリは、pom.xmlに記載すればMavenリポジトリから依存するライブラリを含め自動的にダウンロードしてきてくれる

本記事では2のpom.xmlに関する記載方法を紹介します。

Mavenについてはこちらの記事で環境構築まで丁寧に記載してくれているので、興味のある方は参照ください。

Mavenを利用したライブラリ追加。JavaCVの例

公式サイトでインストール方法の確認

JavaCVの設定

JavaCVとは、画像変換ツールであるOpenCVと動画エンコードツールであるFFmpegの両方がJavaで使用できる便利なツールです。

公式サイトを確認すると、Mavenの記載方法が書いていますね。

pom.xml

  <dependency>
    <groupId>org.bytedeco</groupId>
    <artifactId>javacv-platform</artifactId>
    <version>1.4.2</version>
  </dependency>

なるほど、これだけでいいのかと思いながら読み進めると、JavaCPP Presetsというのも必要らしいです。実はこちらにOpenCV, FFmpegの本体と関連している処理が含まれるのでこちらも必須になります。

JavaCPPの設定

というわけでJavaCPPの公式サイトも確認。

pom.xml

  <dependency>
    <groupId>org.bytedeco.javacpp-presets</groupId>
    <artifactId>${moduleName}-platform</artifactId>
    <version>${moduleVersion}-1.4.2</version>
  </dependency>

こちらも書いてますね、よし完了！…って、moduleNameとmoduleVersionって何なんだ？

groupIdでサポートしているartifactを確認する。

JavaCPPはMavenリポジトリ内に色々なartifactを含んでいるため、使いたいものを抜粋する必要があります。しかもバージョンも合わせる必要があったりと調べるのが面倒だったり。
とにかく調べてみます。

リポジトリからartifactを確認

javacpp-presetsでググっていると、以下のリポジトリサイトを見つけました。
https://mvnrepository.com/
ピンポイントで調べる際はhttps://mvnrepository.com/artifact/グループIDでOK。

今回の対象であるorg.bytedeco.javacpp-presetsを指定してみると、こんな感じでいくつかのartifactが出てきます。

今回はFFmpegとOpenCVだったのでffmpeg-platformとopencv-platformの内容を確認。するとこのようにサポートしているVersion情報が出てきます。

上記の例でJavaCPPの公式サイトと比較すると、moduleName⇒ffmpeg-platform, moduleVersion⇒4.0.1-1.4.2となるようですね。

最終的な設定

上記を参考に以下のようにpom.xmlにdependencyを追加しました。ビルド結果、無事ビルドが通り作成していたJavaアプリケーションが動作するようになりました。
やったー！

pom.xml

    <dependency>
    	<groupId>org.bytedeco</groupId>
    	<artifactId>javacv-platform</artifactId>
    	<version>1.4.2</version>
    </dependency>
    <dependency>
	    <groupId>org.bytedeco.javacpp-presets</groupId>
	    <artifactId>opencv-platform</artifactId>
	    <version>3.4.2-1.4.2</version>
    </dependency>
    <dependency>
	    <groupId>org.bytedeco.javacpp-presets</groupId>
	    <artifactId>ffmpeg-platform</artifactId>
	    <version>4.0.1-1.4.2</version>
    </dependency>

最後に

今回は特に**dependencyのversionってどうやって調べるんだ？**という点を残しておきたくて記事にしました。

こうやって見ていると、最近の開発は

• ビルド環境⇒MavenやGradle
• 動作ツール⇒rubyのgemやpythonのpip、Linuxのapt/yum
• 動作環境⇒Docker

と、いつでもどこでも同じものを使えるようにするというのが一般的ですね。
社内の閉じた環境等で開発していると触れる機会が少なかったりしますが、自作で新しいツールを作るのであれば、こういった便利な機能は積極的に使っていきたいです。

参考

Mavenのベース:【超初心者向け】Maven超入門
最初に参考にした記事: Eclipse+Maven という便利な開発環境をインストールからプロジェクト作成まで