ディベロパーのためチュートリアル
概要
DBFluteを利用される「ディベロパー」のためのチュートリアルです。 ここではDBFluteの環境が既に整っていて自動生成が既にされている状態を前提とし、「何を知れば(見れば)実装できるようになるのか?」に焦点を当てています。
DBFluteの説明においてExampleDBを数多く利用します。
最低限のこと
RDBとは?
DBアクセスにおける最低限の基本的な概念的な理解するためにRDBの基本をご覧下さい。
DBFluteとは?
DBFluteは、「データベースにプログラム上からアクセス(検索したり更新したり)するためのフレームワーク(ツール)」です。 詳しくはDBFluteの紹介をご覧下さい。
DBアクセスのスタイル
とりあえずの実装のために、とにかくこれを覚えて下さい。
- 簡単(定型的)なSQL → ConditionBean
- 複雑(非定型)なSQL → 外だしSQL(OutsideSql)
実装が進んできたら、上記の二つの方法でどちらを利用すれば良いのか迷うときがあります。 その場合は“真っ先に”「ConditionBeanのスコープ」を見るようにして下さい。
意識するクラス
ディベロッパーが意識するクラスとして以下のものがあります。
- Entity
- データベースの値を格納するクラス。
テーブル対応(DomainEntity)のものとSQL対応(CustomizeEntity)のものがある。 - Behavior
- DBアクセスの処理を司るクラス(DIコンポーネント)。
一つのテーブルにつき一つのBehaviorがある。 - ConditionBean
- 検索条件を組み立てるクラス。
一つのテーブルにつき一つのConditionBeanがある。
意識するタスク
ディベロッパーが意識するタスクとして以下のものがあります(タスクについてはこちら)。
- ReplaceSchema
- ローカル環境のDBの初回作成・DB変更時都度作成
- Sql2Entity
- 外だしSQL(OutsideSql)利用時に実行する。
Exampleのススメ
基本的なことを覚えるのにも応用的なことを覚えるのにも最適なのはExample実装です。以下からチェックアウトできます。
- SVNリポジトリ:https://www.seasar.org/svn/sandbox/dbflute/
- 参考プロジェクト:dbflute-basic-example
- ExampleDBのERD:exampledb
自動生成済みで、かつ、DBもセットアップ済みですぐに「お試し実装」ならびに「お試し実行(JUnit)」ができる状態になっています。 また、既に幾つものExample実装があり、プログラムを読むことでおおよその使い方を習得することも可能です。 とりあえず見ておくとよいクラスは、BehaviorBasicTestとConditionBeanBasicTestです。 開発中もすぐに参照できる環境にしておくことを強くお奨めします。
そもそもSubversion(SVN)の使い方が分からない方は、こちらのページが参考になります。
雑多な情報
作者のBlog「jfluteの日記」上にDBFluteの情報が更新されます。 実装上の細かいネタもあるので、時々チェックしてみると理解が早まるかもしれません。
C#ユーザの皆様へ
C#ユーザ向けの「C#ユーザの皆様へ」を必ずご覧下さい。
