Hibernate複合プライマリ・キー


[zt]hibernate複合プライマリキー
key words:hibernate,複合プライマリキー,composite-id
ビジネス要件に基づいて、複合プライマリ・キーとして2つのフィールドを使用する必要があります.たとえば、Userデータ・テーブルでは、「name」と「phone」の2つのフィールドを使用して複合プライマリ・キーを定義する場合があります.
このようにUserテーブルを作成するとします.
CREATE TABLE user (

    name VARCHAR(100) NOT NULL,

    phone VARCHAR(50) NOT NULL,

    age INT,

    PRIMARY KEY(name, phone)

);

表では、「name」と「age」は複合プライマリ・キーとして定義され、イメージ時にUserカテゴリに「name」と「age」の2つの属性を直接持たせることができますが、Hibernateは複合プライマリ・キー・カテゴリにSerializableインタフェースを実装し、equals()とhashCode()メソッドを定義する必要があります.
User.java
package onlyfun.caterpillar;

 

import java.io.Serializable;

import org.apache.commons.lang.builder.EqualsBuilder;

import org.apache.commons.lang.builder.HashCodeBuilder;

 

//               Serializable  

public class User implements Serializable {

    private String name;

    private String phone;

    private Integer age;

   

    public User() {

    }

 

    public Integer getAge() {

        return age;

    }

 

    public void setAge(Integer age) {

        this.age = age;

    }

 

    public String getName() {

        return name;

    }

 

    public void setName(String name) {

        this.name = name;

    }

 

    public String getPhone() {

        return phone;

    }

 

    public void setPhone(String phone) {

        this.phone = phone;

    }

   

    //       equals() hashCode()

    public boolean equals(Object obj) {

        if(obj == this) {

            return true;

        }

       

        if(!(obj instanceof User)) {

            return false;

        }

       

        User user = (User) obj;

        return new EqualsBuilder()

                 .append(this.name, user.getName())

                 .append(this.phone, user.getPhone())

                 .isEquals();

       

    }

   

    public int hashCode() {

        return new HashCodeBuilder()

                 .append(this.name)

                 .append(this.phone)

                 .toHashCode();

    }

}

equals()とhashCode()法は2つの異なるデータの識別根拠として用いられる.次に、を使用して、マッピングファイルで複合プライマリ・キーとオブジェクトのプロパティを定義します.
User.hbm.xml
<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE hibernate-mapping

    PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"

    "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

 

<hibernate-mapping>

 

    <class name="onlyfun.caterpillar.User" table="user">

        <composite-id>

            <key-property name="name"

                          column="name"

                          type="java.lang.String"/>

            <key-property name="phone"

                          column="phone"

                          type="java.lang.String"/>

        </composite-id>

 

        <property name="age" column="age" type="java.lang.Integer"/>

   

    </class>

</hibernate-mapping>

データの格納では、複合プライマリ・キーの格納に違いはありません.現在の問題は、load()メソッドを使用するなど、複合プライマリ・キーに基づいてデータをクエリーする方法です.Userインスタンスを作成し、複合プライマリ・キーに対応するプロパティを設定し、load()を使用して対応するデータをクエリーします.たとえば、次のようになります.

User user = new User();

user.setName("bush");

user.setPhone("0970123456");

       

Session session = sessionFactory.openSession();

//                  

user = (User) session.load(User.class, user);

       

System.out.println(user.getAge() + "\t" +

                                  user.getName() + "\t" +

                                  user.getPhone());

session.close();

プライマリ・キーの情報は、次のようなカテゴリに独立して使用できます.
UserPK.java
package onlyfun.caterpillar;

 

import java.io.Serializable;

 

import org.apache.commons.lang.builder.EqualsBuilder;

import org.apache.commons.lang.builder.HashCodeBuilder;

 

public class UserPK implements Serializable {

    private String name;

    private String phone;

 

    public String getName() {

        return name;

    }

 

    public void setName(String name) {

        this.name = name;

    }

 

    public String getPhone() {

        return phone;

    }

 

    public void setPhone(String phone) {

        this.phone = phone;

    }

   

    public boolean equals(Object obj) {

        if(obj == this) {

            return true;

        }

       

        if(!(obj instanceof User)) {

            return false;

        }

       

        UserPK pk = (UserPK) obj;

        return new EqualsBuilder()

                 .append(this.name, pk.getName())

                 .append(this.phone, pk.getPhone())

                 .isEquals();

       

    }

   

    public int hashCode() {

        return new HashCodeBuilder()

                 .append(this.name)

                 .append(this.phone)

                 .toHashCode();

    }

}

Userカテゴリのプライマリ・キー情報が分離されました.たとえば、次のようになります.
User.java

package onlyfun.caterpillar;

 

import java.io.Serializable;

 

public class User implements Serializable {

    private UserPK userPK; //   

    private Integer age;

   

    public User() {

    }

 

    public UserPK getUserPK() {

        return userPK;

    }

 

    public void setUserPK(UserPK userPK) {

        this.userPK = userPK;

    }

 

    public Integer getAge() {

        return age;

    }

 

    public void setAge(Integer age) {

        this.age = age;

    }

}

イメージ・ファイルでは、次のようなプライマリ・キー・クラスの情報を指定する必要があります.
User.hbm.xml
<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE hibernate-mapping

    PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"

    "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

 

<hibernate-mapping>

 

    <class name="onlyfun.caterpillar.User" table="user">

        <composite-id name="userPK"

                      class="onlyfun.caterpillar.UserPK"

                      unsaved-value="any">

            <key-property name="name"

                          column="name"

                          type="java.lang.String"/>

            <key-property name="phone"

                          column="phone"

                          type="java.lang.String"/>

        </composite-id>

       

        <property name="age" column="age" type="java.lang.Integer"/>

   

    </class>

 

</hibernate-mapping>

データの問合せには、次のようなプライマリ・キー情報を指定する必要があります.
UserPK pk = new UserPK();

pk.setName("bush");

pk.setPhone("0970123456");

      

Session session = sessionFactory.openSession();

//                     

User user = (User) session.load(User.class, pk);

      

System.out.println(user.getAge() + "\t" +

                                  user.getUserPK().getName() + "\t" +

                                  user.getUserPK().getPhone());

session.close();