DBFlute Maven Plugin

• DBFlute Maven Pluginとは？
• Pluginのインストール
  • 1.1.x なら *Java8
  • 1.0.x なら *Java6,7
• Mavenゴールたち
  • ゴールの実行の仕方
  • それぞれのゴールの概要
• コンフィグたち

DBFlute Maven Pluginとは？

DBFlute Maven Plugin は Apache Maven 2.x, 3.x で利用可能なプラグインです。 DBFlute のセットアップなどの処理を Maven の mvn コマンドを通して実行することができます。

Pluginのインストール

1.1.x なら *Java8

pom.xml の plugins に、dbflute-maven-plugin を設定します。

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

1.0.x なら *Java6,7

1.0.x用の方は、Seasarのリポジトリに入っているので、pluginRepositoryの設定が必要です。

e.g. プラグインのリポジトリを追加 @pom.xml
<?xml version="1.0" encoding="UTF-8"?&gt;
<project&gt;
...
    <pluginRepositories&gt;
        <pluginRepository&gt;
            <id&gt;maven.seasar.org</id&gt;
            <name&gt;The Seasar Foundation Maven2 Repository</name&gt;
            <url&gt;http://maven.seasar.org/maven2/</url&gt;
        </pluginRepository&gt;
    </pluginRepositories&gt;
...
    <build&gt;
        <plugins&gt;
            <plugin&gt;
                <groupId&gt;org.seasar.dbflute</groupId&gt;
                <artifactId&gt;dbflute-maven-plugin</artifactId&gt;
                <version&gt;1.0.0</version&gt;
                <configuration&gt;
                    <dbfluteVersion&gt;1.0.5N</dbfluteVersion&gt;
                    <clientProject&gt;xxxdb</clientProject&gt;
                </configuration&gt;
            </plugin&gt;
        </plugins&gt;
    </build&gt;
...
</project&gt;

Mavenゴールたち

ゴールの実行の仕方

コマンドラインにて、mvnコマンドで dbflute:xxx という形式で実行します。

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

それぞれのゴールの概要

DBFlute Maven Plugin では、以下のゴール (goal) を提供します。

download

指定されたバージョンをダウンロードして、展開。

既存のDBFluteクライアントの参照を変更したりはせずダウンロード展開だけなので、 アップグレード目的の場合はDBFluteクライアントの_project.bat(sh)を手動で修正する必要あり。

create-client

ダウンロードした、指定したバージョンのdbflute_dfclient.zipを展開して、データベースのパラメータなどを更新。 コンフィグ設定を必要とするので、設定内容を確認してから。

1.1.x (Java8) を前提のセットアップドキュメントを参考に。

Mavenによるセットアップ

manage

manage.[sh|bat]を実行。実行後にメニューから実行するタスクを選ぶ

jdbc

jdbc.[sh|bat]を実行。DBスキーマのメタデータを取得

doc

doc.[sh|bat]を実行。ドキュメントなどを自動生成

generate

generate.[sh|bat]を実行。クラスを自動生成

outside-sql-test

outside-sql-test.[sh|bat]を実行。外だしSQLを一括テスト

sql2entity

sql2entity.[sh|bat]を実行。外だしSQL対応のクラスを自動生成

replace-schema

replace-schema.[sh|bat]を実行。開発用DBスキーマを再構築

DBFluteクライアントが二つ存在する場合、DBFluteタスク実行ゴールは clientProject で指定されているDBFluteクライアントのものを実行します。

コンフィグたち

clientProject

DBFluteクライアントの名前、dbflute_xxx の xxx 部分に相当