 | ||||||
 |
 |
 |
||||
 |
 |
 |
 |
 |
 |
 |
| ||||||
|
このドキュメントはS2Hibernateのバージョン1.1.2のものです。 S2Hibernateの概要S2Hibernateは以下の特徴を持っています。
これまでHibernateで開発するときの悩みの種だったSession管理をS2Hibernateが自動的に行ってくれるので、 開発者はSessionのオープン・クローズ、Transaction処理から開放されます。 SessionはJTAのトランザクション中は維持され、トランザクションの終了時に自動的にクローズ(flushも)されます。
S2Hibernate.daoを使うことで、HibernateのSessionを意識せずにDaoを記述できるようになります。 S2Hibernateリファレンスセットアップ
S2と同様にJDK1.4以上が必要です。
S2Hibernateとして必要なjarファイルは、s2hibernate/lib以下にそろってます。この他にSeasar2のjarファイルが必要です。 libのjarファイル(hsqldb.jarは必要に応じて)とlib/hibernate2またはlib/hibernate3のjarファイル、srcのhibernate.cfg.xml、ehcache.xml、j2ee.dicon、log4j.propertiesをCLASSPATHにとおせば、S2Hibernateを実行できます。Eclipseにインポートして使う場合は設定は不要です。 簡単に機能を試すことができるように、RDBMSとしてHSQLDBを用意しています。機能を試す前にあらかじめHSQLDBを実行しておいてください。HSQLDBを実行するには、bin/runHsqldb.batをダブルクリック(Windowsの場合)します。lib/hsqldb.jarはHSQLDBを実行する上では必要ですが、本番では必要ありません。 Hibernateのバージョンs2hibernateV1.1.0からHibernate3に対応しました。しかし、現在のドキュメントは、Hibernate2を対象に記述していますので、 Hibernate3を利用する場合は、次のように読み替えてください。
※select時に実行するHQL文の優先順位
diconファイル
作成したDaoクラスを追加します。 Example
基本的な使い方の例作成するファイは以下のとおりです。
Employee.java通常のJavaBeanを作成します。S2Hibernateを意識する必要はありませがHibernateで利用できるように記述してください。
package examples.hibernate.entity;
import java.io.Serializable;
public class Employee implements Serializable {
private long empno;
private String ename;
private String job;
private Short mgr;
private java.util.Date hiredate;
private Float sal;
private Float comm;
private short deptno;
public Employee() {}
public Employee(long empno) { this.empno = empno; }
public long getEmpno() { return this.empno; }
public void setEmpno(long empno) { this.empno = empno; }
public java.lang.String getEname() { return this.ename; }
public void setEname(java.lang.String ename) { this.ename = ename; }
public java.lang.String getJob() { return this.job; }
public void setJob(java.lang.String job) { this.job = job; }
public Short getMgr() { return this.mgr; }
public void setMgr(Short mgr) { this.mgr = mgr; }
public java.util.Date getHiredate() { return this.hiredate; }
public void setHiredate(java.util.Date hiredate) { this.hiredate = hiredate; }
public Float getSal() { return this.sal; }
public void setSal(Float sal) { this.sal = sal; }
public Float getComm() { return this.comm; }
public void setComm(Float comm) { this.comm = comm;}
public short getDeptno() { return this.deptno; }
public void setDeptno(short deptno) { this.deptno = deptno; }
public boolean equals(Object other) {
if ( !(other instanceof Employee) ) return false;
Employee castOther = (Employee) other;
return this.getEmpno() == castOther.getEmpno();
}
public int hashCode() {
return (int) this.getEmpno();
}
}
Employee.hbm.xml通常のHibernateのマッピングファイルを作成します。S2Hibernateを意識する必要はありません。<hibernate-mapping> EmployeeDao.javaDao用のインターフェースを宣言します。S2Hibernateを意識する必要はありません。package examples.hibernate.dao;
import examples.hibernate.entity.Employee;
public interface EmployeeDao {
public Employee getEmployee(int empno);
}
EmployeeDaoImpl.javaDao用の実装を記述します。
package examples.hibernate.dao;
import java.util.List;
import net.sf.hibernate.Hibernate;
import org.seasar.hibernate.S2SessionFactory;
import examples.hibernate.entity.Employee;
public class EmployeeDaoImpl implements EmployeeDao {
private static final String HQL = "from Employee where empno = ?";
private S2SessionFactory sessionFactory_;
public EmployeeDaoImpl(S2SessionFactory sessionFactory) {
sessionFactory_ = sessionFactory;
}
public Employee getEmployee(int empno) {
List result = sessionFactory_.getSession().find(
HQL, new Integer(empno), Hibernate.INTEGER);
if (result.size() > 0) {
return (Employee) result.get(0);
} else {
return null;
}
}
}
Employee.dicon作成したDaoクラスとorg.seasar.hibernate.impl.S2SessionFactoryImplを追加します。 <components> EmployeeClient.javaDaoを実行する基本的な方法は以下のようになります。
S2Hibernateではトランザクション制御は行なっていません、トランザクションについてはトランザクションの自動制御を参照して下さい。 実行クラスサンプル
package examples.hibernate.client;
import org.seasar.framework.container.S2Container;
import org.seasar.framework.container.factory.S2ContainerFactory;
import examples.hibernate.service.EmployeeService;
public class EmployeeClient {
private static final String PATH =
"examples/hibernate/client/Employee.dicon";
public static void main(String[] args) {
S2Container container = S2ContainerFactory.create(PATH);/* 手順1 */
container.init();
try {
EmployeeService service =
(EmployeeService) container.getComponent(EmployeeService.class);/* 手順2 */
System.out.println(service.getEmployee(7788).getEname());/* 手順3 */
} finally {
container.destroy();
}
}
}
実行結果DEBUG 2004-04-07 18:53:52,511 [main] トランザクションを開始しました S2hibernate.daoの使い方の例
EmployeeAutoDao
package examples.hibernate.dao;
import java.util.List;
import examples.hibernate.entity.Employee;
public interface EmployeeAutoDao {
public Class BEAN = Employee.class;
//追加、削除、更新、保存or更新をする場合
public void save(Employee employee);
public void delete(Employee employee);
public void update(Employee employee);
public void saveOrUpdate(Employee employee);
//HQLを指定しないで実行する場合
public String getEmployeeByEmpNo_ARGS = "empno";
public Employee getEmployeeByEmpNo(long empNo);
public String getEmployeeByJobDeptno_ARGS = "job, deptno";
public List getEmployeeByJobDeptno(String job, short deptno);
//HQLを指定して実行する場合
public String getHQLAllEmployee_HQL = "from Employee emp order by emp.empno";
public List getHQLAllEmployee();
//何も指定していない場合
public List getAllEmployee();
//firstResult,maxResultsを指定する場合
public String getEmployeeList_ARGS = "firstResult,maxResults";
public String getEmployeeList_HQL = "from Employee emp order by emp.empno";
public List getEmployeeList(int firstResult ,int MaxResults );
//戻り値がintの場合
public String getEmployeeCount_HQL = "select count(emp) from Employee emp";
public int getEmployeeCount();
//戻り値がStringの場合
public String getEmployeeNameById_HQL
= "select emp.ename from Employee emp where empno = :employeeId ";
public String getEmployeeNameById_ARGS = "employeeId";
public String getEmployeeNameById(Long employeeId);
//NamedQuery呼び出しを使う場合
//(Employee.hbm.xmlの"examples.hibernate.dao.EmployeeAutoDao_getEmployeeByJob"に対応)
public String getEmployeeByJob_ARGS = "job";
public List getEmployeeByJob(String job);
//NamedQueryで戻り値がStringになるようなSQL文を使う場合
//(Employee.hbm.xmlの"examples.hibernate.dao.EmployeeAutoDao_getSQLEmployeeNameById"に対応)
public String getSQLEmployeeNameById_ARGS = "employeeId";
public String getSQLEmployeeNameById(Long employeeId);
//NamedQueryで戻り値がLongになるようなSQL文を使う場合
//(Employee.hbm.xmlの"getSQLEmployeeIdByName"NamedQueryを実行)
public String getSQLEmployeeIdByName_ARGS = "employeeName";
public Long getSQLEmployeeIdByName(String employeeName);
}
EmployeeAutoDao.diconS2Hibernate.daoを使うのに必要な設定をまとめた"s2hibernate.dicon"をインクルードします。
<components>
<include path="s2hibernate.dicon"/>
<component class="examples.hibernate.dao.EmployeeAutoDao">
<aspect>j2ee.requiredTx</aspect>
<aspect>s2hibernate.interceptor</aspect>
</component>
</components>
s2hibernate.diconS2Hibernate.daoを使うのに必要な設定をまとめたdiconファイル
<components namespace="s2hibernate">
<include path="j2ee.dicon"/>
<component class="org.seasar.hibernate.impl.S2SessionFactoryImpl"/>
<component name="interceptor"
class="org.seasar.hibernate.dao.interceptors.S2HibernateDaoInterceptor"/>
</components>
EmployeeAutoDaoClient.javadiconファイル名以外は、S2Hibernateの基本的な使い方と同じ流れになります。
package examples.hibernate.client;
import org.seasar.framework.container.S2Container;
import org.seasar.framework.container.factory.S2ContainerFactory;
import examples.hibernate.dao.EmployeeAutoDao;
import examples.hibernate.entity.Employee;
public class EmployeeAutoDaoClient {
private static final String PATH =
"examples/hibernate/client/EmployeeAutoDao.dicon";
public static void main(String[] args) {
S2Container container = S2ContainerFactory.create(PATH);/* 手順1 */
container.init();
try {
EmployeeAutoDao dao = (EmployeeAutoDao) container
.getComponent(EmployeeAutoDao.class);/* 手順2 */
Employee emp = new Employee();
emp.setEmpno( 7788);
emp.setEname("SCOTT");
emp.setDeptno((short)10);
dao.save( emp ); /* 手順3 */
} finally {
container.destroy();
}
}
}
実行結果DEBUG 2004-11-11 19:01:50,163 [main] トランザクションを開始しました INFO 2004-11-11 19:01:50,323 [main] Hibernate 2.1.6 省略 DEBUG 2004-11-11 19:01:51,545 [main] 物理的なコネクションを取得しました DEBUG 2004-11-11 19:01:51,645 [main] 論理的なコネクションを取得しました 省略 Hibernate: insert into EMP (ENAME, JOB, MGR, HIREDATE, SAL, COMM, DEPTNO, EMPNO) values (?, ?, ?, ?, ?, ?, ?, ?) 省略 DEBUG 2004-11-11 19:01:52,025 [main] 論理的なコネクションを閉じました DEBUG 2004-11-11 19:01:52,025 [main] トランザクションをコミットしました DEBUG 2004-11-11 19:01:52,045 [main] 物理的なコネクションを閉じました © Copyright The Seasar Project and the others 2004-2005, all rights reserved. |
| |
|
|