Hibernate中的自定义类型——UserTypeCompositeUserType

Posted 爱玩技术的淘气包儿

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Hibernate中的自定义类型——UserTypeCompositeUserType相关的知识,希望对你有一定的参考价值。

一、UserType

Hibernate拥有自定义映射表属性的机制,主要通过实现接口UserType,具体的UserType:

import java.sql.PreparedStatement;     
import java.sql.ResultSet;     
import java.sql.SQLException;     
     
import net.sf.hibernate.HibernateException;     
     
/**   
 * @author hy-he   
 *   
 */     
public interface UserType {     
     
 /**   
  * 返回UserType所映射字段的SQL类型(java.sql.Types)   
  * 返回类型为int[],其中包含了映射个字段的SQL类型代码   
  * (UserType可以映射到一个或者多个字段)   
  * @return   
  */     
 public int[]sqlTypes();     
     
     
 /**   
  * UserType.nullSafeGet()所返回的自定义数据类型   
  * @return   
  */     
 public Class returnedClass();     
     
     
 /**   
  * 自定义数据类型的比对方法   
  * 此方法将用作脏数据检查,参数x、y分别为数据的两个副本   
  * 如果equals方法返回false,则Hibernate将认为数据发生变化,并将变化更新到数据库表中   
  * @param x   
  * @param y   
  * @return   
  * @throws HibernateException   
  */     
 public boolean equals(Object x,Object y)throws HibernateException;     
     
     
 /**   
  * 从JDBC ResultSet读取数据,将其转换为自定义类型后返回   
  * (此方法要求对克能出现null值进行处理)   
  * names中包含了当前自定义类型的映射字段名称   
  * @param rs   
  * @param names   
  * @param owner   
  * @return   
  * @throws HibernateException   
  * @throws SQLException   
  */     
 public Object nullSafeGet(ResultSet rs,String[] names,Object owner)throws HibernateException,SQLException;     
     
     
 /**   
  * 本方法将在Hibernate进行数据保存时被调用   
  * 我们可以通过PreparedStateme将自定义数据写入到对应的数据库表字段   
  * @param st   
  * @param value   
  * @param index   
  * @throws HibernateException   
  * @throws SQLException   
  */     
 public void nullSafeSet(PreparedStatement st,Object value,int index)throws HibernateException,SQLException;     
     
     
 /**   
  * 提供自定义类型的完全复制方法   
  * 本方法将用构造返回对象   
  * 当nullSafeGet方法调用之后,我们获得了自定义数据对象,在向用户返回自定义数据之前,   
  * deepCopy方法将被调用,它将根据自定义数据对象构造一个完全拷贝,并将此拷贝返回给用户   
  * 此时我们就得到了自定义数据对象的两个版本,第一个是从数据库读出的原始版本,其二是我们通过   
  * deepCopy方法构造的复制版本,原始的版本将有Hibernate维护,复制版由用户使用。原始版本用作   
  * 稍后的脏数据检查依据;Hibernate将在脏数据检查过程中将两个版本的数据进行对比(通过调用   
  * equals方法),如果数据发生了变化(equals方法返回false),则执行对应的持久化操作   
  *   
  * @param value   
  * @return   
  * @throws HibernateException   
  */     
 public Object deppCopy(Object value)throws HibernateException;     
     
     
 /**   
  * 本类型实例是否可变   
  * @return   
  */     
 public boolean isMutable();     
}     
例子:一个学生有联系地址,而联系地址又分为家庭地址和工作地址,我们可以把两个地址信息抽象成一个新的Address类,作为Student的成员变量。

数据库结构:

 

技术分享create table typestu (id varchar(32primary key,name varchar(32),homeaddr varchar(32),workaddr varchar(32));

Hibernate.cfg.xml

 

技术分享<?xml version=‘1.0‘ encoding=‘UTF-8‘?>
技术分享
<!DOCTYPE hibernate-configuration PUBLIC
技术分享          "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
技术分享          "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"
>
技术分享
技术分享
<!-- Generated by MyEclipse Hibernate Tools.                   -->
技术分享
<hibernate-configuration>
技术分享
技术分享
<session-factory>
技术分享    
<property name="connection.username">root</property>
技术分享    
<property name="connection.url">
技术分享        jdbc:mysql://localhost:3306/schoolproject?characterEncoding=gb2312
&amp;useUnicode=true
技术分享    
</property>
技术分享    
<property name="dialect">
技术分享        org.hibernate.dialect.MySQLDialect
技术分享    
</property>
技术分享    
<property name="myeclipse.connection.profile">mysql</property>
技术分享    
<property name="connection.password">1234</property>
技术分享    
<property name="connection.driver_class">
技术分享        com.mysql.jdbc.Driver
技术分享    
</property>
技术分享    
<property name="hibernate.dialect">
技术分享        org.hibernate.dialect.MySQLDialect
技术分享    
</property>
技术分享    
<property name="hibernate.show_sql">true</property>
技术分享    
<property name="current_session_context_class">thread</property>
技术分享    
<mapping resource="Search/UserType/Student.hbm.xml" />
技术分享
技术分享
</session-factory>
技术分享
技术分享
</hibernate-configuration>

 Pojo

 

技术分享package Search.UserType;
技术分享
技术分享
技术分享
public class Student {
技术分享    
private String id; //标识id
技术分享
    private String name; //学生姓名
技术分享
    private AddressType address;//地址
技术分享
    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 AddressType getAddress() {
技术分享        
return address;
技术分享    }

技术分享    
public void setAddress(AddressType address) {
技术分享        
this.address = address;
技术分享    }

技术分享
技术分享 
技术分享 
技术分享 
技术分享}

技术分享

 

自定义类型

 

技术分享
技术分享
package Search.UserType;
技术分享
技术分享
import java.io.Serializable;
技术分享
import java.sql.PreparedStatement;
技术分享
import java.sql.ResultSet;
技术分享
import java.sql.SQLException;
技术分享
import java.sql.Types;
技术分享
技术分享
import org.apache.commons.lang.builder.EqualsBuilder;
技术分享
import org.apache.commons.lang.builder.HashCodeBuilder;
技术分享
import org.hibernate.HibernateException;
技术分享
import org.hibernate.usertype.UserType;
技术分享
技术分享
public class AddressType implements UserType, Serializable {
技术分享    
private String homeAddr;
技术分享    
private String workAddr;
技术分享
技术分享    
/* 有几个字段就有几个值,这里容易出错,要多注意 */
技术分享    
private static final int[] SQL_TYPES = { Types.VARCHAR, Types.VARCHAR };
技术分享
技术分享    
/* 这个方法告诉Hibernate在成生DDL时对列采用什么样的SQL语法 */
技术分享    
public int[] sqlTypes() {
技术分享        
return SQL_TYPES;
技术分享    }

技术分享
技术分享    
/*
技术分享     * Hibernate返回什么样的映射类型,与 <property name="address" type="model.AddressType">
技术分享     * 指定的类一致。事实上也可以把AddressType拆分为两个类,一个类是只携带信息的JavaBean,它里面
技术分享     * 没有逻辑操作也没有实现UserType(比如AddressBean);而另一个类实现了UserType,它所面对的就不是现在这个
技术分享     * AddressType类的homeAddr和homeAddr属性,它面对的是AddressBean。在本例中为了简洁方便,只用了一个类。
技术分享     
*/

技术分享    
public Class returnedClass() {
技术分享        
return AddressType.class;
技术分享    }

技术分享
技术分享    
/*
技术分享     * 表明这个类的实例在创建以后就不可以改变属性。Hibernate能为不可改变的类作一些性能优化。
技术分享     
*/

技术分享    
public boolean isMutable() {
技术分享        
return false;
技术分享    }

技术分享
技术分享    
/*
技术分享     * 由于AddressType是不可变的,所以深拷贝可以直接返回对象引用。拷贝的对象由应用程序使用, 而原版对象由Hibernate维护以做脏数据检查
技术分享     
*/

技术分享    
public Object deepCopy(Object value) {
技术分享        
return value; // Address is immutable
技术分享
    }

技术分享
技术分享    
/* 两个对象是否相等,使用了apache的common工具包来进行属性比对 */
技术分享    
public boolean equals(Object x, Object y) {
技术分享        
if (x == y)
技术分享            
return true;
技术分享        
if (x == null || y == null)
技术分享            
return false;
技术分享        AddressType add1 
= (AddressType) x;
技术分享        AddressType add2 
= (AddressType) y;
技术分享        
return new EqualsBuilder() //使用EqualsBuilder类来方便地进行比对
技术分享
                .append(add1.getHomeAddr(), add2.getHomeAddr()).append(
技术分享                        add2.getWorkAddr(), add2.getWorkAddr()).isEquals();
技术分享    }

技术分享
技术分享    
/* 得到hash码 */
技术分享
技术分享    
public int hashCode(Object x) throws HibernateException {
技术分享        AddressType address 
= (AddressType) x;
技术分享        
return new HashCodeBuilder()//使用HashCodeBuilder类来方便地进行比对
技术分享
                .append(address.getHomeAddr()).append(address.getWorkAddr())
技术分享                .toHashCode();
技术分享    }

技术分享
技术分享    
/* 读取数据并组装成一个AddressType对象。names[]中的参数顺序依照映射文件中定义的顺序 */
技术分享    
public Object nullSafeGet(ResultSet rs, String[] names, Object owner)
技术分享            
throws HibernateException, SQLException {
技术分享        
if (rs.wasNull())
技术分享            
return null;
技术分享        String homeAddr 
= rs.getString(names[0]);
技术分享        String schoolAddr 
= rs.getString(names[1]);
技术分享        AddressType address 
= new AddressType(homeAddr, schoolAddr);
技术分享        
return address;
技术分享    }

技术分享
技术分享    
/* 保存数据,index的顺序按照映射文件定义的顺序,从0开始。 */
技术分享    
public void nullSafeSet(PreparedStatement st, Object value, int index)
技术分享            
throws HibernateException, SQLException {
技术分享        AddressType address 
= (AddressType) value;
技术分享        
if (value == null{
技术分享              st.setNull(index, Types.VARCHAR);
技术分享              st.setNull(index
+1, Types.VARCHAR);
技术分享        }
 else {
技术分享            st.setString(index, address.getHomeAddr());
技术分享            st.setString(index 
+ 1, address.getWorkAddr());
技术分享        }

技术分享         System.out.println(
"Data has been saved! ");
技术分享    }

技术分享
技术分享    
/* 当把AddressType类型数据写入二级缓存时,此方法被调用 */
技术分享    
public Serializable disassemble(Object value) throws HibernateException {
技术分享        
return null;
技术分享    }

技术分享
技术分享    
/* 当从二级缓存中读取AddressType类型数据时,此方法被调用 */
技术分享    
public Object assemble(Serializable cached, Object owner)
技术分享            
throws HibernateException {
技术分享        
// TOD





































































































































































以上是关于Hibernate中的自定义类型——UserTypeCompositeUserType的主要内容,如果未能解决你的问题,请参考以下文章

Hibernate 中的自引用一对一映射

Hibernate学习笔记

如何使用 JPA 和 Hibernate 映射 PostgreSQL 枚举

Hibernate 实体之间的自定义关联

尝试使用 EhCache 使用 Spring 和扩展 Hibernate 的 JpaRepository 的自定义 GenericDao 接口

Spring Boot JPA中的自定义查询问题