Maven 入門 | データベースの利用 | H2 + JPA プロジェクトの作成

Tags:

Maven は開発時に、必要なライブラリを中央リポジトリから自動的にダウンロードしてビルドする。したがって、開発で何かライブラリを使用する場合でも、Maven を使っていれば、そのサイトに行ってライブラリをダウンロードし、プロジェクトに追加する必要はまったくない。pom.xml にライブラリを記述してビルドすれば、すべてのライブラリが自動的に参照され、使用されるためである。

では、実際に何らかのライブラリを利用した開発を行ってみよう。Java アプリケーションでよく使われるライブラリといえば、「データベース」関連だろう。

ここでは “H2” データベースエンジンを使ってみる。H2 は pure Java の SQL データベースライブラリである。pure Java なので、Java プログラム内でそのまま使用できる。また H2 は、ファイルにデータを保存することも、メモリにデータを保存することもできる。開発中はメモリに保存し、リリース時にはファイルに保存するという使い方もできる。

中央リポジトリで検索

H2 を利用するために、<dependency> タグの書き方を確認する。まず、中央リポジトリを検索するサイトにアクセスする。

https://search.maven.org/

ここにアクセスし、入力フィールドに “h2” と入力して検索してみる。検索結果が一覧で表示される。その中から、グループ ID が “org.h2database”、アーティファクト ID が “h2” の項目を探し、その “Latest Version” のバージョン番号リンクをクリックする。バージョン情報が表示される。

ここには、主要なビルドツールでライブラリを追加するためのコードがツール別に整理されている。“Dependency Information” の “Apache Maven” に Maven の <dependency> タグが掲載されている。これをコピーして pom.xml の <dependencies> の中に貼り付ければ、H2 ライブラリをプロジェクトに入れることができる。

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <version>1.4.196</version>
</dependency>

Maven でライブラリを利用するには、このように Maven の検索サイトでライブラリを検索し、その Dependency Information をコピーして pom.xml に貼り付ける形でライブラリを追加できる。慣れれば簡単である。

プロジェクトと pom.xml を完成させる

ではプロジェクトを作成してみよう。今回も、以前使用した SampleMavenApp プロジェクトを再利用できる。もし新しいプロジェクトを生成するなら、mvn archetype:generate コマンドでプロジェクトを作成する。このとき -DarchetypeArtifactId=maven-archetype-quickstart を指定して実行すればよい。

プロジェクトが用意できたら pom.xml を完成させる。H2 ライブラリの <dependency> タグは簡単に用意できたが、このほかにも必要なライブラリがある。今回は JPA を使ってデータベースにアクセスする。そのために javax.persistence と Persistence JPA を用意する必要がある。

以下に完成した pom.xml を示す。

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
        http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>com.devkuma</groupId>
    <artifactId>SampleMavenApp</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>
 
    <name>SampleMavenApp</name>
    <url>http://maven.apache.org</url>
 
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
 
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
 
        <!--h2-->
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <version>1.4.196</version>
        </dependency>
 
        <!-- eclipse.persistence-->
        <dependency>
            <groupId>org.eclipse.persistence</groupId>
            <artifactId>javax.persistence</artifactId>
            <version>2.2.0</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.persistence</groupId>
            <artifactId>org.eclipse.persistence.jpa</artifactId>
            <version>2.7.0</version>
        </dependency>
 
    </dependencies>
 
    <build>
        <!--resource folder-->
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
 
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.6.0</version>
                <configuration>
                    <mainClass>com.devkuma.App</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>
 
</project>

今回はプラグイン関係として、exec:java 用の exec-maven-plugin だけを入れている。ひとまず動作すればよいので、これで十分である。

3 つの <dependency> タグのほかに、<build> タグにも見慣れないタグが追加されている。これらはすべて JPA を利用するために必要なものである。

pom.xml に追加された内容

pom.xml に今回追加した内容を簡単に整理して説明する。

Eclipse の Java Persistence API

JPA を利用するには、Java Persistence API (javax.persistence) と JPA 実装ライブラリが必要である。今回は Eclipse Foundation が開発するオープンソースライブラリを使用している。

Java Persistence API

<dependency>
    <groupId>org.eclipse.persistence</groupId>
    <artifactId>javax.persistence</artifactId>
    <version>2.2.0</version>
</dependency>

javax.persistence パッケージのライブラリである。API がなければ何もできないため、これは必須である。

JPA

<dependency>
    <groupId>org.eclipse.persistence</groupId>
    <artifactId>org.eclipse.persistence.jpa</artifactId>
    <version>2.7.0</version>
</dependency>

JPA の Eclipse Foundation による実装である。JPA を利用するにはこれも必要になる。この 2 つのライブラリはセットで用意するものと考えればよい。

これに先ほどの H2 ライブラリを合わせ、合計 3 つのライブラリを追加すれば、JPA による H2 データベースアクセスを利用できるようになる。

リソースフォルダの登録

このほか、<build> タグにも新しく追加した部分がある。このタグ部分である。

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
    </resource>
</resources>

これはリソースフォルダを登録するためのものである。<resource> はリソースフォルダの情報を記述するもので、ここでは src/main/resources パスを追加している。これにより、main フォルダの resources フォルダにあるリソースファイルが、ビルド時に読み込まれるパッケージに追加される。