hibernate映射关系——复合主键映射

     由于中间做.Net项目，所以hibernate的博客更新就短篇了，现在让我们接着上篇hibernate的博客来继续hibernate的关系映射，这篇博客介绍的是复合主键映射。

    

一、复合主键

     简单说一下什么是复合主键：在一个表中，一个字段不能唯一标识一行数据的时候，就需要两个及更多的字段来共同确定记录的唯一。这几个字段就是复合主键。

     在没有ORM的概念时，我们的实体，数据库都是单独来创建，单独维护的。所以，数据库表中的主键一个也好，复合主键也好，都是自己定义。现在，使用了ORM来开发，这个复合主键，我们怎么通过hibernate的XML来识别，持久化到数据库呢？

二、实现方式

   面对这样的情况Hibernate为我们提供了两种方式来解决复合主键问题：

    1、实体类中包含多个主键字段。

    2、将主键属性提取到一个单独的主键类中，业务实体类引用主键类。

   假设现在有一个People类，类中的id 和name 是复合主键。

   实体类定义如下；

public class People implements Serializable{    private static final long serialVersionUID = -4888836126783955019L;        private String id;    private String name;    private int age;    public String getId()    {        return id;    }    public void setId(String id)    {        this.id = id;    }    public String getName()    {        return name;    }    public void setName(String name)    {        this.name = name;    }    public int getAge()    {        return age;    }    public void setAge(int age)    {        this.age = age;    }@Override    public int hashCode()    {        final int prime = 31;        int result = 1;        result = prime * result + ((id == null) ? 0 : id.hashCode());        result = prime * result + ((name == null) ? 0 : name.hashCode());        return result;    }    @Override    public boolean equals(Object obj)    {        if (this == obj)            return true;        if (obj == null)            return false;        if (getClass() != obj.getClass())            return false;        People other = (People) obj;        if (id == null)        {            if (other.id != null)                return false;        }        else if (!id.equals(other.id))            return false;        if (name == null)        {            if (other.name != null)                return false;        }        else if (!name.equals(other.name))            return false;        return true;    } }

对应的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="com.cassie.hibernate.pojos.People" table="people">        <!-- 复合主键使用composite-id标签 -->        <composite-id>            <!-- key-property标签表示哪一些属性对应复合主键 -->            <key-property name="id" column="id" type="string"></key-property>            <key-property name="name" column="name" type="string"></key-property>        </composite-id>        <property name="age" column="age" type="integer"></property>    </class></hibernate-mapping>

    第二种方式：

   提取出来的主键类：

   

/*必须实现Serializable接口*/public class PeoplePrimaryKey implements Serializable{    private static final long serialVersionUID = -1190986010439330142L;        /*复合主键值*/    private String id;    private String name;        public PeoplePrimaryKey()    {            }        /*复合主键值的get和set方法*/    public String getId()    {        return id;    }    public void setId(String id)    {        this.id = id;    }    public String getName()    {        return name;    }    public void setName(String name)    {        this.name = name;    }    @Override    public int hashCode()    {        final int prime = 31;        int result = 1;        result = prime * result + ((id == null) ? 0 : id.hashCode());        result = prime * result + ((name == null) ? 0 : name.hashCode());        return result;    }    @Override    public boolean equals(Object obj)    {        if (this == obj)            return true;        if (obj == null)            return false;        if (getClass() != obj.getClass())            return false;        PeoplePrimaryKey other = (PeoplePrimaryKey) obj;        if (id == null)        {            if (other.id != null)                return false;        }        else if (!id.equals(other.id))            return false;        if (name == null)        {            if (other.name != null)                return false;        }        else if (!name.equals(other.name))            return false;        return true;    }}

  

业务实体类： 

public class People{    /*持有主键类的一个引用，使用该引用作为这个类的OID*/    private PeoplePrimaryKey peoplePrimaryKey;    private int age;        public People()    {            }        public PeoplePrimaryKey getPeoplePrimaryKey()    {        return peoplePrimaryKey;    }    public void setPeoplePrimaryKey(PeoplePrimaryKey peoplePrimaryKey)    {        this.peoplePrimaryKey = peoplePrimaryKey;    }    public int getAge()    {        return age;    }    public void setAge(int age)    {        this.age = age;    }}

  映射文件如下：

<?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="com.suxiaolei.hibernate.pojos.People" table="people">        <!-- 复合主键使用composite-id标签 -->        <!--        name - 指定了复合主键对应哪一个属性        class - 指定了复合主键属性的类型        -->        <composite-id name="peoplePrimaryKey" class="com.suxiaolei.hibernate.pojos.PeoplePrimaryKey">            <!-- key-property指定了复合主键由哪些属性组成 -->            <key-property name="id" column="id" type="string"></key-property>            <key-property name="name" column="name" type="string"></key-property>        </composite-id>        <property name="age" column="age" type="integer"></property>    </class></hibernate-mapping>

到此，两种方式介绍完。

   PS：这个方法，我没有使用过，但是使用这中方式，需要有一些注意事项：

      1. 使用复合主键的实体类必须实现Serializable接口。必须实现Serializable接口的原因很简单，我们查找数据的时候是根据主键查找的。打开Hibernate的帮助文档我们可以找到get与load方法的声明形式如下：

Object load(Class theClass,Serializable id)

Object get(Class theClass,Serializable id)

当我们查找复合主键类的对象时，需要传递主键值给get()或load()方法的id参数，而id参数只能接收一个实现了Serializable接口的对象。而复合主键类的主键不是一个属性可以表示的，所以只能先new出复合主键类的实例（例如：new People()），然后使用主键属性的set方法将主键值赋值给主键属性，然后将整个对象传递给get()或load()方法的id参数，实现主键值的传递，所以复合主键的实体类必须实现Serializable接口。

      2. 使用复合主键的实体类必须重写equals和hashCode方法。必须重写equals和hashCode方法也很好理解。这两个方法使用于判断两个对象(两条记录)是否相等的。为什么要判断两个对象是否相等呢？因为数据库中的任意两条记录中的主键值是不能相同的，所以我们在程序中只要确保了两个对象的主键值不同就可以防止主键约束违例的错误出现。也许这里你会奇怪为什么不使用复合主键的实体类不重写这两个方法也没有主键违例的情况出现，这是因为使用单一主键方式，主键值是Hibernate来维护的，它会确保主键不会重复，而复合主键方式，主键值是编程人员自己维护的，所以必须重写equals和hashCode方法用于判断两个对象的主键是否相同。

      3. 重写的equals和hashCode方法，只与主键属性有关，普通属性不要影响这两个方法进行判断。这个原因很简单，主键才能决定一条记录，其他属性不能决定一条记录。

总结：复合主键在实际开发中不建议使用，建议使用没有业务语义的字段，因为使用业务字段来作为主键，容易发生变化。