Hibernate-インターセプター
Hibernateで学習したように、オブジェクトが作成され、永続化されます。オブジェクトが変更されたら、データベースに保存し直す必要があります。このプロセスは、次にオブジェクトが必要になるまで続き、永続ストアからロードされます。
したがって、オブジェクトはそのライフサイクルのさまざまな段階を通過し、 Interceptor Interfaceいくつかの必要なタスクを実行するためにさまざまな段階で呼び出すことができるメソッドを提供します。これらのメソッドは、セッションからアプリケーションへのコールバックであり、アプリケーションが永続オブジェクトのプロパティを保存、更新、削除、またはロードする前に検査および/または操作できるようにします。以下は、Interceptorインターフェース内で使用可能なすべてのメソッドのリストです-
| シニア番号 | 方法と説明 |
|---|---|
| 1 | findDirty() このメソッドは、 flush() メソッドはSessionオブジェクトで呼び出されます。 |
| 2 | instantiate() このメソッドは、永続化されたクラスがインスタンス化されるときに呼び出されます。 |
| 3 | isUnsaved() このメソッドは、オブジェクトがに渡されるときに呼び出されます。 saveOrUpdate() 方法/ |
| 4 | onDelete() このメソッドは、オブジェクトが削除される前に呼び出されます。 |
| 5 | onFlushDirty() このメソッドは、フラッシュ、つまり更新操作中にオブジェクトがダーティ（つまり変更された）であることをHibernateが検出したときに呼び出されます。 |
| 6 | onLoad() このメソッドは、オブジェクトが初期化される前に呼び出されます。 |
| 7 | onSave() このメソッドは、オブジェクトが保存される前に呼び出されます。 |
| 8 | postFlush() このメソッドは、フラッシュが発生し、オブジェクトがメモリ内で更新された後に呼び出されます。 |
| 9 | preFlush() このメソッドは、フラッシュの前に呼び出されます。 |
Hibernate Interceptorを使用すると、オブジェクトがアプリケーションとデータベースの両方に対してどのように見えるかを完全に制御できます。
インターセプターの使い方は？
インターセプターを構築するには、次のいずれかを実装できます Interceptor クラスを直接または拡張する EmptyInterceptorクラス。以下は、HibernateInterceptor機能を使用するための簡単な手順です。
インターセプターを作成する
この例では、EmptyInterceptorを拡張します。この例では、Interceptorのメソッドが次の場合に自動的に呼び出されます。 Employeeオブジェクトが作成および更新されます。要件に応じて、より多くのメソッドを実装できます。
import java.io.Serializable;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.EmptyInterceptor;
import org.hibernate.Transaction;
import org.hibernate.type.Type;
public class MyInterceptor extends EmptyInterceptor {
private int updates;
private int creates;
private int loads;
public void onDelete(Object entity, Serializable id,
Object[] state, String[] propertyNames, Type[] types) {
// do nothing
}
// This method is called when Employee object gets updated.
public boolean onFlushDirty(Object entity, Serializable id,
Object[] currentState, Object[] previousState, String[] propertyNames,
Type[] types) {
if ( entity instanceof Employee ) {
System.out.println("Update Operation");
return true;
}
return false;
}
public boolean onLoad(Object entity, Serializable id,
Object[] state, String[] propertyNames, Type[] types) {
// do nothing
return true;
}
// This method is called when Employee object gets created.
public boolean onSave(Object entity, Serializable id,
Object[] state, String[] propertyNames, Type[] types) {
if ( entity instanceof Employee ) {
System.out.println("Create Operation");
return true;
}
return false;
}
//called before commit into database
public void preFlush(Iterator iterator) {
System.out.println("preFlush");
}
//called after committed into database
public void postFlush(Iterator iterator) {
System.out.println("postFlush");
}
}POJOクラスを作成する
ここで、EMPLOYEEテーブルとEmployeeクラスを使用して-で遊んだ最初の例を少し変更してみましょう。
public class Employee {
private int id;
private String firstName;
private String lastName;
private int salary;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}データベーステーブルの作成
2番目のステップは、データベースにテーブルを作成することです。各オブジェクトに対応する1つのテーブルがあり、永続性を提供する用意があります。上で説明したオブジェクトについて考えてみましょう。次のRDBMSテーブルに格納および取得する必要があります-
create table EMPLOYEE (
id INT NOT NULL auto_increment,
first_name VARCHAR(20) default NULL,
last_name VARCHAR(20) default NULL,
salary INT default NULL,
PRIMARY KEY (id)
);マッピング構成ファイルの作成
このステップは、Hibernateに指示するマッピングファイルを作成することです—定義されたクラスをデータベーステーブルにマッピングする方法。
<?xml version = "1.0" encoding = "utf-8"?>
<!DOCTYPE hibernate-mapping PUBLIC
"-//Hibernate/Hibernate Mapping DTD//EN"
"http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
<class name = "Employee" table = "EMPLOYEE">
<meta attribute = "class-description">
This class contains the employee detail.
</meta>
<id name = "id" type = "int" column = "id">
<generator class="native"/>
</id>
<property name = "firstName" column = "first_name" type = "string"/>
<property name = "lastName" column = "last_name" type = "string"/>
<property name = "salary" column = "salary" type = "int"/>
</class>
</hibernate-mapping>アプリケーションクラスを作成する
最後に、main（）メソッドを使用してアプリケーションクラスを作成し、アプリケーションを実行します。ここで、セッションオブジェクトの作成中に、Interceptorクラスを引数として使用したことに注意してください。
import java.util.List;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
public class ManageEmployee {
private static SessionFactory factory;
public static void main(String[] args) {
try {
factory = new Configuration().configure().buildSessionFactory();
} catch (Throwable ex) {
System.err.println("Failed to create sessionFactory object." + ex);
throw new ExceptionInInitializerError(ex);
}
ManageEmployee ME = new ManageEmployee();
/* Add few employee records in database */
Integer empID1 = ME.addEmployee("Zara", "Ali", 1000);
Integer empID2 = ME.addEmployee("Daisy", "Das", 5000);
Integer empID3 = ME.addEmployee("John", "Paul", 10000);
/* List down all the employees */
ME.listEmployees();
/* Update employee's records */
ME.updateEmployee(empID1, 5000);
/* Delete an employee from the database */
ME.deleteEmployee(empID2);
/* List down new list of the employees */
ME.listEmployees();
}
/* Method to CREATE an employee in the database */
public Integer addEmployee(String fname, String lname, int salary){
Session session = factory.openSession( new MyInterceptor() );
Transaction tx = null;
Integer employeeID = null;
try {
tx = session.beginTransaction();
Employee employee = new Employee(fname, lname, salary);
employeeID = (Integer) session.save(employee);
tx.commit();
} catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
} finally {
session.close();
}
return employeeID;
}
/* Method to READ all the employees */
public void listEmployees( ){
Session session = factory.openSession( new MyInterceptor() );
Transaction tx = null;
try {
tx = session.beginTransaction();
List employees = session.createQuery("FROM Employee").list();
for (Iterator iterator = employees.iterator(); iterator.hasNext();){
Employee employee = (Employee) iterator.next();
System.out.print("First Name: " + employee.getFirstName());
System.out.print(" Last Name: " + employee.getLastName());
System.out.println(" Salary: " + employee.getSalary());
}
tx.commit();
} catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
} finally {
session.close();
}
}
/* Method to UPDATE salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession( new MyInterceptor() );
Transaction tx = null;
try {
tx = session.beginTransaction();
Employee employee = (Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
} catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
} finally {
session.close();
}
}
/* Method to DELETE an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession( new MyInterceptor() );
Transaction tx = null;
try {
tx = session.beginTransaction();
Employee employee = (Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
} catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
} finally {
session.close();
}
}
}コンパイルと実行
上記のアプリケーションをコンパイルして実行する手順は次のとおりです。コンパイルと実行に進む前に、PATHとCLASSPATHが適切に設定されていることを確認してください。
構成の章で説明されているように、hibernate.cfg.xml構成ファイルを作成します。
上記のように、Employee.hbm.xmlマッピングファイルを作成します。
上記のようにEmployee.javaソースファイルを作成し、コンパイルします。
上記のようにMyInterceptor.javaソースファイルを作成し、コンパイルします。
上記のようにManageEmployee.javaソースファイルを作成し、コンパイルします。
ManageEmployeeバイナリを実行してプログラムを実行します。
次の結果が得られ、EMPLOYEEテーブルにレコードが作成されます。
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
Create Operation
preFlush
postFlush
Create Operation
preFlush
postFlush
Create Operation
preFlush
postFlush
First Name: Zara Last Name: Ali Salary: 1000
First Name: Daisy Last Name: Das Salary: 5000
First Name: John Last Name: Paul Salary: 10000
preFlush
postFlush
preFlush
Update Operation
postFlush
preFlush
postFlush
First Name: Zara Last Name: Ali Salary: 5000
First Name: John Last Name: Paul Salary: 10000
preFlush
postFlushEMPLOYEEテーブルを確認すると、次のレコードが含まれているはずです-
mysql> select * from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 29 | Zara | Ali | 5000 |
| 31 | John | Paul | 10000 |
+----+------------+-----------+--------+
2 rows in set (0.00 sec
mysql>