Hibernate-interceptors

Hibernate-インターセプター

Hibernateで学習したように、オブジェクトが作成され、永続化されます。 オブジェクトを変更したら、データベースに保存する必要があります。 このプロセスは、オブジェクトが次に必要になるまで続き、永続ストアからロードされます。

したがって、オブジェクトはライフサイクルのさまざまな段階を通過し、 Interceptor Interface はメソッドを提供します。これらのメソッドはさまざまな段階で呼び出して、いくつかの必要なタスクを実行できます。 これらのメソッドは、セッションからアプリケーションへのコールバックであり、アプリケーションが保存、更新、削除、またはロードされる前に、永続オブジェクトのプロパティを検査および/または操作できるようにします。 以下は、Interceptorインターフェース内で使用可能なすべてのメソッドのリストです-

Sr.No.	Method & Description
1	findDirty() このメソッドは、Sessionオブジェクトで* flush（）*メソッドが呼び出されたときに呼び出されます。
2	instantiate() このメソッドは、永続化されたクラスがインスタンス化されるときに呼び出されます。
3	isUnsaved() このメソッドは、オブジェクトが* saveOrUpdate（）*メソッドに渡されたときに呼び出されます/
4	onDelete() このメソッドは、オブジェクトが削除される前に呼び出されます。
5	onFlushDirty() このメソッドは、オブジェクトがダーティであることをHibernateが検出したときに呼び出されます（つまり、 フラッシュ中に変更されました） 更新操作。
6	onLoad() このメソッドは、オブジェクトが初期化される前に呼び出されます。
7	onSave() このメソッドは、オブジェクトが保存される前に呼び出されます。
8	postFlush() このメソッドは、フラッシュが発生し、メモリ内のオブジェクトが更新された後に呼び出されます。
9	preFlush() このメソッドは、フラッシュの前に呼び出されます。

Hibernate Interceptorは、アプリケーションとデータベースの両方に対してオブジェクトがどのように見えるかを完全に制御します。

インターセプターの使用方法

インターセプターを作成するには、 Interceptor クラスを直接実装するか、 EmptyInterceptor クラスを拡張します。 以下は、Hibernate Interceptor機能を使用する簡単な手順です。

インターセプターを作成する

この例では、 Employee オブジェクトが作成および更新されたときにInterceptorのメソッドが自動的に呼び出されるEmptyInterceptorを拡張します。 要件に応じてより多くのメソッドを実装できます。

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");
   }
}

Copy

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;
   }
}

Copy

データベーステーブルを作成する

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)
);

Copy

マッピング構成ファイルの作成

この手順では、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>

Copy

アプリケーションクラスを作成する

最後に、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();
      }
   }
}

Copy

コンパイルと実行

上記のアプリケーションをコンパイルして実行する手順は次のとおりです。 コンパイルと実行に進む前に、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
postFlush

Copy

あなたのEMPLOYEEテーブルをチェックする場合、それは次のレコードを持つ必要があります-

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>

Copy