【Hibernate步步为营】--复合主键映射具体解释

      上篇文章讨论了继承映射，它是对象模型中最主要的特性，对于继承映射它的主要区分是字段类型的不同，所以在生成表结构时须要有新列来标识数据的类型，能够使用<subclass>标签并在标签中加入discriminator-value鉴别器。该篇文章来讨论复合主键映射，它是指主键是多列的组合，如今在设计数据库时非常少用到复合主键，由于考虑到数据库的优化，经常会把复合主键拆分到两个表中，并利用一个关系表来维护两个表的关系，关系表中不加入主键。

一、复合主键映射

       复合主键映射须要在映射配置文件里使用<composite-id>标签，该标签是指将一个类指定为对应的复合主键，它的name属性须要指定类文件里定义的属性值，并在该标签中加入<key-property>子标签。

       Note：想要使用复合映射必需要将复合主键放到一个类中，也就是讲复合主键属性和其他属性分到两个类中，并将复合主键的类实现接口Serializable，该接口隶属于java.io。

       复合主键的映射关系的主键是由多个列复合而成的，相应到数据表中相当的简单，例如以下图：

  1、类文件

       这里就拿上图的表来作为演示样例，在表中有两个字段年限和持续时间组合成为表的主键，所以分成的新类分别命名为FiscalYearPeriod和FiscalYearPeriodPK，当中FiscalYearPeriodPK类封装表的主键属性，FiscalYearPeriod类封装其他属性以及FiscalYearPeriodPK类。

   1.1 FiscalYearPeriod.java

      类中封装有主要的属性，并把FiscalYearPeriodPK类作为属性封装到类中，并在配置文件里配置对应的映射，例如以下代码：

package com.src.hibernate;

import java.sql.Date;

public class FiscalYearPeriod {
	
	//时间主键
	private FiscalYearPeriodPK fiscalYearPeriodPK;
	public FiscalYearPeriodPK getFiscalYearPeriodPK() {
		return fiscalYearPeriodPK;
	}
	public void setFiscalYearPeriodPK(FiscalYearPeriodPK fiscalYearPeriodPK) {
		this.fiscalYearPeriodPK = fiscalYearPeriodPK;
	}
	
	//開始日期
	private Date beginDate;
	public Date getBeginDate() {
		return beginDate;
	}
	public void setBeginDate(Date beginDate) {
		this.beginDate = beginDate;
	}
	
	//结束日期
	private Date endDate;
	public Date getEndDate() {
		return endDate;
	}
	public void setEndDate(Date endDate) {
		this.endDate = endDate;
	}
	
	//阶段时间
	private String periodSts;
	public String getPeriodSts() {
		return periodSts;
	}
	public void setPeriodSts(String periodSts) {
		this.periodSts = periodSts;
	}
}

   1.2 FiscalYearPeriodPK.java

      封装主键属性，该类是从FiscalYearPeriod类中分离出来的，包括了主要的主键属性，而且须要实现接口Serializable，该类是要映射到配置文件里<composite-id>标签中要指定该类，代码例如以下：

package com.src.hibernate;

import java.io.Serializable;

public class FiscalYearPeriodPK implements Serializable {
	
	//年限
	private int fiscalYear;
	public int getFiscalYear() {
		return fiscalYear;
	}
	public void setFiscalYear(int fiscalYear) {
		this.fiscalYear = fiscalYear;
	}

	//持续时间
	private int fiscalPeriod;
	public int getFiscalPeriod() {
		return fiscalPeriod;
	}

	public void setFiscalPeriod(int fiscalPeriod) {
		this.fiscalPeriod = fiscalPeriod;
	}
	
}

  2、配置文件

这里有个疑问两个类都是哪个须要加入映射文件？由于会使用<composite-id>标签，所以仅仅须要为FiscalYearPeriod类加入映射就可以，在该映射文件里加入相应复合主键标签，并在标签中加入相应的主键属性，例如以下代码：

<?xml version="1.0"?>
<!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.src.hibernate.FiscalYearPeriod" table="t_fiscal_year_period_pk">
		<composite-id name="fiscalYearPeriodPK">
			<key-property name="fiscalYear"></key-property>
			<key-property name="fiscalPeriod"></key-property>
		</composite-id>
		<property name="beginDate" type="date"/>
		<property name="endDate" type="date"/>
		<property name="periodSts"/>
	</class>
</hibernate-mapping>

      将上面的文件生成相应的数据库表，生成的sql语句例如以下：

drop table if exists t_fiscal_year_period_pk
create table t_fiscal_year_period_pk (fiscalYear integer not null, fiscalPeriod integer not null, beginDate date, endDate date, periodSts varchar(255), primary key (fiscalYear, fiscalPeriod))

     相应的表结构例如以下图：

  3、数据操作

        对应的映射文件配置好后，对应的数据操作就变得非常easy了，首先从写入数据開始，向数据库中写入数据时会同一时候把两个类写入到数据库中，所以此时这两个类都必须转化为Transient状态，所以在保存时须要首先将FiscalYearPeriod对象首先保存到数据库中，然后它会自己主动关联复合属性，将信息保存到数据库中。

  3.1 写入操作

      写入的操作方法和曾经的写入方法同样，须要定义两个对象，然后保存对应的对象信息到数据库中，代码例如以下：

public void testSave1(){
	//声明会话对象
	Session session=null;
	
	try{
		//获取会话对象
		session=HibernateUtils.getSession();
		//开启会话
		session.beginTransaction();
		//创建复合对象
		FiscalYearPeriodPK fiscalyearperiodpk=new FiscalYearPeriodPK();
		fiscalyearperiodpk.setFiscalPeriod(2014);
		fiscalyearperiodpk.setFiscalYear(2012);
		
		//创建对象
		FiscalYearPeriod fiscalyearperiod=new FiscalYearPeriod();
		fiscalyearperiod.setFiscalYearPeriodPK(fiscalyearperiodpk);
		
		session.save(fiscalyearperiod);
		//提交会话
		session.getTransaction().commit();
	}catch(Exception e){
		e.printStackTrace();
		session.getTransaction().rollback();
	}finally{
		HibernateUtils.closeSession(session);
	}
}

      运行对应的測试方法，生成的SQL语句例如以下：

Hibernate: insert into t_fiscal_year_period_pk (beginDate, endDate, periodSts, fiscalYear, fiscalPeriod) values (?, ?, ?, ?, ?)

     对应的数据库视图：

  3.2 载入操作

      对应的载入方法会和曾经不同，由于在该表中主键是复合属性，所以须要创建一个类。在载入数据时须要创建主键对象，此时的主键就是一个对象，更须要为对象的属性赋值，这样才干获取对象，代码例如以下：

public void testLoad1(){
	//声明会话对象
	Session session=null;
	
	try{
		//获取会话对象
		session=HibernateUtils.getSession();
		//开启会话
		session.beginTransaction();
		//创建复合对象
		FiscalYearPeriodPK fiscalyearperiodpk=new FiscalYearPeriodPK();
		fiscalyearperiodpk.setFiscalPeriod(2014);
		fiscalyearperiodpk.setFiscalYear(2012);
		
		FiscalYearPeriod fiscalyearperiod=(FiscalYearPeriod)session.load(FiscalYearPeriod.class,fiscalyearperiodpk);
		System.out.println("開始日期： "+fiscalyearperiod.getBeginDate()); 
		//提交会话
		session.getTransaction().commit();
	}catch(Exception e){
		e.printStackTrace();
		session.getTransaction().rollback();
	}finally{
		HibernateUtils.closeSession(session);
	}
}

      生成的结果，例如以下：

Hibernate: select fiscalyear0_.fiscalYear as fiscalYear0_0_, fiscalyear0_.fiscalPeriod as fiscalPe2_0_0_, fiscalyear0_.beginDate as beginDate0_0_, fiscalyear0_.endDate as endDate0_0_, fiscalyear0_.periodSts as periodSts0_0_ from t_fiscal_year_period_pk fiscalyear0_ where fiscalyear0_.fiscalYear=? and fiscalyear0_.fiscalPeriod=?
開始日期： 2013-10-12

结语

      复合主键的使用事实上非常easy，可是须要注意对象须要被拆分，主键自己须要一个类而且该类须要实现java.io.Serializable接口，其他的属性再又一次生成新类，而且类的属性中要有主键类的对象，对应的仅仅须要一个配置文件，在映射文件里使用<composite-id>指明主键，并指明主键的属性。