Mavenによるセットアップ

こちらは、DBFlute-1.1.x (Java8) のためのドキュメントになっています。

• 前提条件 ※Java8
  • 前提となる環境
• セットアップ手順
  • 1. DBFluteランタイムの設定 (JDBCドライバも)
  • 2. DBFlute Maven Plugin のインストール
  • 3. DBFluteエンジンのダウンロード
  • 4. DBFluteクライアントの作成
  • 5. DBFluteプロパティの基本設定 (DB接続情報やDIコンテナなど)
  • 6. 特定環境適用プロパティ
  • 7. JDBCドライバの準備 (Oracle や DB2 などであれば)
  • 8. クラスの自動生成
  • 9. DI設定の調整
  • 10. その後の設定
  • UnsupportedClassVersionErrorが発生したら

前提条件 ※Java8

前提となる環境

Java8

DBFlute は Apache Ant を利用するため、Java8 以上の実行環境が必要

Maven

コマンドラインで mvn -version が打てる必要あり

pom.xml

アプリ用の pom.xml が既に用意されている必要あり

インターネット

Maven経由でDBFlute Engineをダウンロードするため

もし、複数DB対応をする場合、事前にポイントを抑えておきましょう。

セットアップ手順

1. DBFluteランタイムの設定 (JDBCドライバも)

アプリケーションのクラスパスにDBFluteランタイム(JAR)を追加して下さい。

2. DBFlute Maven Plugin のインストール

そして、pom.xml の plugins に、"DBFlute Maven Plugin" を入れます。

clientProject

そのデータベース(スキーマ)を表現する名前 ※"スキーマ名そのまま" がオススメ

packageBase

自動生成クラスのパッケージ ※"アプリのパッケージ.dbflute" がオススメ

e.g. プラグイン情報の追加 (実行のための基本的な設定) @pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project>
...
    <build>
        <plugins>
            ...
            <plugin>
                <groupId>org.dbflute</groupId>
                <artifactId>dbflute-maven-plugin</artifactId>
                <version>1.1.0</version>
                <configuration>
                    <clientProject>xxxdb</clientProject>
                    <packageBase>com.xxx.dbflute</packageBase>
                </configuration>
            </plugin>
            ...
        </plugins>
    </build>
...
</project>

Github に pom.xml の example がありますので参考に。

3. DBFluteエンジンのダウンロード

コマンドラインで dbflute:download ゴールを叩きます。

e.g. dbflute:download ゴールを叩く！ @Command
...$ mvn -e dbflute:download

すると、mydbflute配下に、DBFluteエンジンがダウンロードされます。 こちらは、この後に作成するDBFluteクライアントから参照されるだけで、基本的にさわることはありません。 (mydbflute配下を見るのは、DBFluteエンジンのバージョンを確認するときくらい)

e.g. mydbfluteにDBFluteエンジン(1.1.0)がダウンロードされる @Directory
[PROJECT_ROOT]
 |-src/main/java
 |-src/main/resources
 |-...
 |-mydbflute
    |-dbflute-1.2.5 // これをDBFluteエンジンと呼ぶ
       |-ant
       |-...
       |-templates
       |-build-torque.xml
       |-product-is-dbflute-1.2.5

4. DBFluteクライアントの作成

コマンドラインで dbflute:create-client ゴールを叩きます。

e.g. dbflute:create-client ゴールを叩く！ @Command
...$ mvn -e dbflute:create-client

すると、dbflute_xxxdb というディレクトリが作成されます。これを "DBFluteクライアント" と呼び、DBFluteをアプリに合わせるための設定や、DBFlute実行するためのスクリプトがあり、何かと見たりさわったりする機会の多いところです。

e.g. DBFluteクライアントが作成される @Directory
[PROJECT_ROOT]
 |-src/main/java
 |-...
 |-dbflute_xxxdb // ここをDBFluteクライアントと呼ぶ
    |-dfprop     // DBFluteプロパティ(dfprop)がたくさん置いてあるディレクトリ
    |-...
 |-mydbflute
    |-dbflute-1.2.5 // こちらはDBFluteエンジンと呼ぶ

5. DBFluteプロパティの基本設定 (DB接続情報やDIコンテナなど)

まずは、DBFluteクライアント (dbflute_xxxdb) の dfprop 配下にある、ふたつの dfprop ファイルを修正しましょう。 (dfpropファイルの設定を "DBFluteプロパティ" と呼びます)

basicInfoMap.dfprop

database と targetContainer をアプリに合わせる

databaseInfoMap.dfprop

driver や url などのDB接続情報をアプリに合わせる

basicInfoMap.dfprop にて、データベース(DBMS)とDIコンテナをアプリで利用するものに修正します。以下は MySQL と Spring の例。

e.g. basicInfoMap.dfprop で、MySQL と Spring を指定 @basicInfoMap.dfprop
    ...
    # /- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # o database: (Required)
    #  This is the target database, only considered when generating
    #  the SQL for your DBFlute project.
    #  Your possible choices are:
    #
    #    mysql, postgresql, oracle, db2, sqlserver,
    #    h2, derby, (sqlite, firebird, msaccess)
    #
    ; database = mysql
    # - - - - - - - - - -/
    ...

    # /- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # o targetContainer: (Required)
    #  The target DI container.
    #  If your target language is 'csharp', you can specify 'seasar' only.
    #  Your possible choices are:
    #
    #       spring, guice, seasar, cdi
    #
    ; targetContainer = spring
    # - - - - - - - - - -/
    ...

databaseInfoMap.dfprop は、DBFluteクライアント作成直後はデフォルト設定なので、 アプリで利用するDMBSのJDBCの設定に修正します。以下は MySQL の例。

e.g. databaseInfoMap.dfprop で、MySQLのJDBC設定 @basicInfoMap.dfprop
...
map:{
    ; driver   = com.mysql.jdbc.driver
    ; url      = jdbc:mysql://localhost:3306/xxxdb?characterEncoding=UTF-8
    ; schema   =  
    ; user     = xxxdb
    ; password = xxxdb
    ...
}

DBMSごとのDB接続情報は、"DBMSごとの取扱い" のページを参考に。

dfpropは、テキストエディタで開くことができます。もし、Eclipse環境が整っているなら、DBFlute の Eclipse プラグインである "EMecha" で dfprop を開けば、dfpropの色付けや重複キーや閉じ括弧チェックがされて編集しやすくなります。

6. 特定環境適用プロパティ

ここからは、DBFlute Maven Plugin に関係なく、どのセットアップ方法でも必要な手順です。

dfpropは、実際に使い始めてからつどつど微調整していく形でOKですが、 さすがに自動生成前にやっておいたほうがいいだろう "特定環境適用プロパティ" もあるので、そちらのページをサッと目を通して必要であれば直しておきましょう。

7. JDBCドライバの準備 (Oracle や DB2 などであれば)

DBFluteエンジンに同梱されていない DBMS (Oracle や DB2 など) であれば、JDBCドライバをダウンロードしてDBFluteクライアントの extlib に配置する必要があります。

H2, MySQL, PostgreSQL は同梱されているので、この手順はスキップしてOKです。

8. クラスの自動生成

それでは、自動生成 (ReplaceSchema & Generate) をしてみましょう。

DBFluteタスク実行時に、 java.lang.UnsupportedClassVersionError, Unsupported major.minor version 52.0 のエラーが発生したときは、JAVA_HOME の設定を確認してみましょう。

9. DI設定の調整

アプリケーションで利用しているDIコンテナの環境にDBFluteのクラスを認識させて下さい。

10. その後の設定

ひとまず、アプリケーション上でDBFluteのクラスを利用することができるようになりました。 しかし、ディベロッパーに横展開するまでには、まだあともうちょい頑張りが必要です。 より良い環境で実装してもらうために、現場フィットな機能を整えましょう！

e.g. Macで一時的に JAVA_HOME を設定 @.bash_profile
...$ export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)

e.g. Macで .bash_profile に JAVA_HOME を設定 @.bash_profile
#!/bin/bash

export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
...

e.g. _project.sh Macで .bash_profile に JAVA_HOME を設定 @.bash_profile
#!/bin/bash

export ANT_OPTS=-Xmx512m

export DBFLUTE_HOME=../mydbflute/dbflute-1.x

export MY_PROPERTIES_PATH=build.properties

if [ `uname` = "Darwin" ]; then
  export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
fi