Hibernate-アノテーション

これまで、HibernateがデータをPOJOからデータベーステーブルに、またはその逆に変換するためにXMLマッピングファイルをどのように使用するかを見てきました。Hibernateアノテーションは、XMLファイルを使用せずにマッピングを定義するための最新の方法です。XMLマッピングメタデータに加えて、またはXMLマッピングメタデータの代わりに注釈を使用できます。

Hibernate Annotationsは、オブジェクトとリレーショナルテーブルのマッピングにメタデータを提供するための強力な方法です。すべてのメタデータは、コードとともにPOJO Javaファイルにまとめられます。これにより、ユーザーは開発中にテーブル構造とPOJOを同時に理解できます。

アプリケーションを他のEJB3準拠のORMアプリケーションに移植できるようにする場合は、注釈を使用してマッピング情報を表す必要がありますが、それでも柔軟性を高めたい場合は、XMLベースのマッピングを使用する必要があります。

Hibernateアノテーションの環境設定

まず最初に、JDK 5.0を使用していることを確認する必要があります。そうでない場合は、アノテーションのネイティブサポートを利用するために、JDKをJDK5.0にアップグレードする必要があります。

次に、sourceforgeから入手できるHibernate 3.xアノテーション配布パッケージをインストールする必要があります:( Hibernate Annotationをダウンロード）そしてコピーhibernate-annotations.jar, lib/hibernate-comons-annotations.jar そして lib/ejb3-persistence.jar HibernateAnnotationsディストリビューションからCLASSPATHへ。

注釈付きクラスの例

Hibernate Annotationの操作中に前述したように、すべてのメタデータはコードとともにPOJO Javaファイルにまとめられます。これにより、ユーザーは開発中にテーブル構造とPOJOを同時に理解できます。

次のEMPLOYEEテーブルを使用してオブジェクトを格納するとします。

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

以下は、定義されたEMPLOYEEテーブルでオブジェクトをマップするための注釈付きのEmployeeクラスのマッピングです。

import javax.persistence.*;

@Entity
@Table(name = "EMPLOYEE")
public class Employee {
   @Id @GeneratedValue
   @Column(name = "id")
   private int id;

   @Column(name = "first_name")
   private String firstName;

   @Column(name = "last_name")
   private String lastName;

   @Column(name = "salary")
   private int salary;  

   public Employee() {}
   
   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;
   }
}

Hibernateは、@ Idアノテーションがフィールド上にあることを検出し、実行時にフィールドを介してオブジェクトのプロパティに直接アクセスする必要があると想定します。getId（）メソッドに@Idアノテーションを配置した場合、デフォルトでgetterメソッドとsetterメソッドを介してプロパティにアクセスできるようになります。したがって、他のすべてのアノテーションも、選択した戦略に従って、フィールドまたはゲッターメソッドのいずれかに配置されます。

次のセクションでは、上記のクラスで使用されるアノテーションについて説明します。

@Entityアノテーション

EJB3標準アノテーションはに含まれています javax.persistenceパッケージなので、最初のステップとしてこのパッケージをインポートします。次に、@Entity このクラスをエンティティBeanとしてマークするEmployeeクラスへのアノテーション。したがって、少なくとも保護されたスコープで表示される引数なしのコンストラクターが必要です。

@Tableアノテーション

@Tableアノテーションを使用すると、データベース内のエンティティを永続化するために使用されるテーブルの詳細を指定できます。

@Tableアノテーションは、4つの属性を提供します。これにより、テーブルの名前、カタログ、およびスキーマをオーバーライドし、テーブルの列に一意の制約を適用できます。今のところ、EMPLOYEEというテーブル名だけを使用しています。

@Idおよび@GeneratedValueアノテーション

各エンティティBeanには主キーがあり、クラスに注釈を付けます。 @Id注釈。主キーは、テーブル構造に応じて、単一のフィールドまたは複数のフィールドの組み合わせにすることができます。

デフォルトでは、@ Idアノテーションは、使用する最も適切な主キー生成戦略を自動的に決定しますが、これをオーバーライドするには、 @GeneratedValue 2つのパラメータをとる注釈 strategy そして generatorここでは説明しませんので、デフォルトの鍵生成戦略のみを使用しましょう。使用するジェネレーターの種類をHibernateに決定させることで、異なるデータベース間でコードを移植できるようになります。

@Column Annotation

@Columnアノテーションは、フィールドまたはプロパティがマップされる列の詳細を指定するために使用されます。次の最も一般的に使用される属性で列注釈を使用できます-

  • name 属性を使用すると、列の名前を明示的に指定できます。

  • length 属性は、特に文字列値の値をマップするために使用される列のサイズを許可します。

  • nullable 属性を使用すると、スキーマの生成時に列にNOTNULLのマークを付けることができます。

  • unique 属性を使用すると、列を一意の値のみを含むものとしてマークできます。

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

最後に、main（）メソッドを使用してアプリケーションクラスを作成し、アプリケーションを実行します。このアプリケーションを使用して、いくつかの従業員のレコードを保存してから、それらのレコードにCRUD操作を適用します。

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.cfg.AnnotationConfiguration;
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 AnnotationConfiguration().
                   configure().
                   //addPackage("com.xyz") //add package if used.
                   addAnnotatedClass(Employee.class).
                   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();
      Transaction tx = null;
      Integer employeeID = null;
      
      try {
         tx = session.beginTransaction();
         Employee employee = new Employee();
         employee.setFirstName(fname);
         employee.setLastName(lname);
         employee.setSalary(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();
      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();
      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();
      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(); 
      }
   }
}

データベース構成

では、作成しましょう hibernate.cfg.xml データベース関連のパラメータを定義するための構成ファイル。

<?xml version = "1.0" encoding = "utf-8"?>
<!DOCTYPE hibernate-configuration SYSTEM 
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
   <session-factory>
   
      <property name = "hibernate.dialect">
         org.hibernate.dialect.MySQLDialect
      </property>
   
      <property name = "hibernate.connection.driver_class">
         com.mysql.jdbc.Driver
      </property>

      <!-- Assume students is the database name -->
   
      <property name = "hibernate.connection.url">
         jdbc:mysql://localhost/test
      </property>
   
      <property name = "hibernate.connection.username">
         root
      </property>
   
      <property name = "hibernate.connection.password">
         cohondob
      </property>

   </session-factory>
</hibernate-configuration>

コンパイルと実行

上記のアプリケーションをコンパイルして実行する手順は次のとおりです。コンパイルと実行に進む前に、PATHとCLASSPATHが適切に設定されていることを確認してください。

  • パスからEmployee.hbm.xmlマッピングファイルを削除します。

  • 上記のようにEmployee.javaソースファイルを作成し、コンパイルします。

  • 上記のようにManageEmployee.javaソースファイルを作成し、コンパイルします。

  • ManageEmployeeバイナリを実行してプログラムを実行します。

次の結果が得られ、EMPLOYEEテーブルにレコードが作成されます。

$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........

First Name: Zara  Last Name: Ali  Salary: 1000
First Name: Daisy  Last Name: Das  Salary: 5000
First Name: John  Last Name: Paul  Salary: 10000
First Name: Zara  Last Name: Ali  Salary: 5000
First Name: John  Last Name: Paul  Salary: 10000

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>
ja/tutorial
es/tutorial
de/tutorial
fr/tutorial
th/tutorial
pt/tutorial
ru/tutorial
vi/tutorial
it/tutorial
ko/tutorial
tr/tutorial
id/tutorial
pl/tutorial
hi/tutorial
japost
espost
depost
frpost
thpost
ptpost
rupost
vipost
itpost
kopost
trpost
idpost
plpost
hipost

© Copyright 2021 - 2024 | All Rights Reserved