利用方法

DBFlute Maven Plugin の基本的な利用方法について説明します。

利用する前に(事前準備)

DBFlute Maven Plugin を利用するた̈1;には̀1;Maven のインストールおよびMaven のプロジェクトをu1f;b10;しておく必࢘1;があります。 Maven プロジェクトのu1f;b10;には̀1;Maven の archetype 機構を利用すると߂1;単にu1f;b10;することができます。たとえば̀1;Maven のインストール後に̀1;以下のように実行すると Maven プロジェクトが作b10;されます。

mvn archetype:generate \
    -DgroupId=グループID \
    -DartifactId=プロジェクトID \
    -DarchetypeArtifactId=maven-archetype-webapp

groupId にはu1f;b10;するプロジェクトのグループ ID̀1;artifactId にはu1f;b10;するプロジェクトのプロジェクト ID̀1;archetypeArtifactId にはu1f;b10;するプロジェクトのタイプをしていします。 archetypeArtifactId には以下のものなどを指定できます。詳細については̀1;Maven Archetype Plugin を参167;してください。

maven-archetype-quickstart: jar フ̊1;イルをu1f;b10;するプロジェクト
maven-archetype-webapp: war フ̊1;イルをu1f;b10;するプロジェクト
maven-archetype-j2ee: J2EE プロジェクトをu1f;b10;するプロジェクト
maven-archetype-mojo: Maven プラグインをu1f;b10;するプロジェクト

pom.xml の更新

DBFlute Maven Plugin を利用するた̈1;に̀1;開発するプロジェクトの pom.xml にプラグイン情փ1;を追加します。以下のように追加してください。バージョン (version࢘1;素) は最新のバージョンを利用してください。

<?xml version="1.0" encoding="UTF-8"?>
<project>
...
  <build>
    <plugins>
...
      <plugin>
        <groupId>org.seasar.dbflute</groupId>
        <artifactId>dbflute-maven-plugin</artifactId>
        <!-- DBFlute Maven Plugin のバージョン -->
        <version>1.0.0</version>
        <configuration>
          <dbfluteVersion>1.0.0</dbfluteVersion>
          <dbPackage>sample.app.db</dbPackage>
          <clientProject>sample</clientProject>
        </configuration>
      </plugin>
...
    </plugins>
  </build>
...
</project>

configuration ࢘1;素以下で DBFlute Maven Plugin の̍1;ラ̎1;ータを設定することができます。 dbfluteVersion はプロジェクトにインストールする DBFlute のバージョン̀1;dbPackage は DBFlute によりu1f;b10;されるクラスをインストールする̍1;ッ̋1;ージ名̀1;clientProject はプロジェクト名で DBFlute クライアント185;の build-プロジェクト名.properties などで利用されます。

デフォルトでは H2 のデータベースが設定されますが̀1;Oracle など別な DB を設定するなどカスタマイズしたい場合は̀1;configuration ࢘1;素以下に以下のように指定します。この設定は̀1;DBFlute クライアントだ̅1;に適用されるものなので̀1;アプリが使う jdbc.dicon などのその他の設定は別14;行ってください。

...
        <configuration>
...
          <database>mysql</database>
          <databaseDriver>com.mysql.jdbc.Driver</databaseDriver>
          <databaseUrl>jdbc:mysql://localhost/DB名?useUnicode=true&amp;amp;characterEncoding=UTF-8</databaseUrl>
          <databaseUser>ユーザ名</databaseUser>
          <databasePassword>̍1;スワード</databasePassword>
        </configuration>
      </plugin>
...

DBFluteのダウンロード・展開 (dbflute:download)

dbflute:download ゴールを実行すると̀1;dbfluteVersion で指定されたバージョンの DBFlute を mydbflute ディレクトリ以下に展開します。

mvn dbflute:download

DBFluteクライアントの展開 (dbflute:create-client)

dbflute:create-client ゴールを実行すると̀1;dbfluteVersion で指定されたバージョンの DBFlute の DBFlute クライアントを展開します。展開時に database などの̍1;ラ̎1;ータが pom.xml などで設定されている場合は̀1;それらの値が適用されます。このゴールを実行する前に̀1;dbflute:download ゴールを実行しておく必࢘1;があります。

mvn dbflute:create-client

スキーマの作b10; (dbflute:replace-schema)

dbflute:replace-schema ゴールを実行すると̀1;DBFlute クライアントの replace-schema.[sh|bat] が実行されます。 replace-schema については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:replace-schema

スキーマ情փ1;の取得 (dbflute:jdbc)

dbflute:jdbc ゴールを実行すると̀1;DBFlute クライアントの jdbc.[sh|bat] が実行されます。 jdbc については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:jdbc

スキーマ情փ1;のHTMLS16; (dbflute:doc)

dbflute:doc ゴールを実行すると̀1;DBFlute クライアントの doc.[sh|bat] が実行されます。 doc については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:doc

クラスフ̊1;イルの1ea;動u1f;b10; (dbflute:generate)

dbflute:generate ゴールを実行すると̀1;DBFlute クライアントの generate.[sh|bat] が実行されます。 generate については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:generate

SQLから対応するEntityの1ea;動u1f;b10; (dbflute:sql2entity)

dbflute:sql2entity ゴールを実行すると̀1;DBFlute クライアントの sql2entity.[sh|bat] が実行されます。 sql2entity については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:sql2entity

Y16;だしSQLの確認 (dbflute:outside-sql-test)

dbflute:outside-sql-test ゴールを実行すると̀1;DBFlute クライアントの outside-sql-test.[sh|bat] が実行されます。 outside-sql-test については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:generate

޺1;理タスクの実行 (dbflute:manage)

dbflute:manage ゴールを実行すると̀1;DBFlute クライアントの manage.[sh|bat] が実行されます。 manage については̀1;DBFlute のサイトを参167;してください。

mvn dbflute:manage ...

DBFluteのアップグレード (dbflute:upgrade)

dbflute:upgrade ゴールを実行すると̀1;利用している DBFlute を dbfluteVersion で指定されたバージョンにアップグレードします。アップグレードは̀1;DBFlute をダウンロード・展開し̀1;DBFlute クライアントの _project.[sh|bat] を更新します。このゴールを実行する前に̀1;dbflute:download ゴールを実行しておく必࢘1;があります。

mvn dbflute:upgrade

CRUDページの1ea;動u1f;b10; (dbflute:generate-crud)

dbflute:generate-crud ゴールを実行すると̀1;指定された DB の各テーブルに関する SAStruts 用の一覧・u1f;b10;・更新・削除のページをu1f;b10;します。

mvn dbflute:generate-crud

基本的な利用方法

実際̀1;DBFlute Maven Plugin を利用した開発において̀1;以下のゴールを実行すれば̀1;Java のソースコードがu1f;b10;され̀1;プロジェクトで利用可能になります。

mvn dbflute:download
mvn dbflute:create-client

dbflute_プロジェクト名ディレクトリ以下を必࢘1;に応じて変更して以下を実行するとソースコードがu1f;b10;されます。

mvn dbflute:jdbc
mvn dbflute:generate

DBFlute Maven Plugin