Hibernate如何映射enum

注:内容来自http://blog.csdn.net/76ersjy2/archive/2009/01/10/3747356.aspx

先看一张表：

Create table test(

Test_id integer not null auto_increment,

gender Enum(MALE, FEMALE)

)

 

在hibernate的pojo中可以这样描述：

 

  

1. public final class TestVO {
3.     private Integer id;
5. public static enum Gender {
6.         MALE, FEMALE;
7.     }
8.     private Gender gender;
11.     public Integer getId() {
12.         return id;
13.     }
15.     public void setId(Integer id) {
16.         this.id = id;
17.     }   
18.     
20.     public Gender getGender() {
21.         return gender;
22.     }
24.     public void setGender(Gender gender) {
25.         this.gender = gender;
26.     }
28. }

而后要自己写一个适合enum的在hibernate中的类型，虽然hibernate已经有了

Org.hibernate.type.EnumType.但是这个类是用于annotation的（在后面会讨论怎么用annotation技术映射enum）.

 

 

创建一个自己的EnumUserType:

1. import java.io.Serializable;
2. import java.sql.PreparedStatement;
3. import java.sql.ResultSet;
4. import java.sql.SQLException;
5. import java.sql.Types;
7. import org.hibernate.HibernateException;
8. import org.hibernate.usertype.UserType;
9. import org.apache.log4j.*;
11. public class EnumUserType<E extends Enum<E>> implements UserType {
12.     private Logger log = Logger.getLogger(EnumUserType.class);
14.     private Class<E> clazz = null;
16.     private static final int[] SQL_TYPES = { Types.VARCHAR };
18.     protected EnumUserType(Class<E> c) {
19.         this.clazz = c;
20.     }
22.     public int[] sqlTypes() {
23.         return SQL_TYPES;
24.     }
26.     public Class<E> returnedClass() {
27.         return clazz;
28.     }
30.     public Object assemble(Serializable cached, Object owner)
31.             throws HibernateException {
32.         // TODO Auto-generated method stub
33.         return cached;
34.     }
36.     public Object deepCopy(Object value) throws HibernateException {
37.         // TODO Auto-generated method stub
38.         return value;
39.     }
41.     public Serializable disassemble(Object value) throws HibernateException {
42.         // TODO Auto-generated method stub
43.         return (Serializable) value;
44.     }
46.     public boolean equals(Object x, Object y) throws HibernateException {
47.         // TODO Auto-generated method stub
48.         if (x == y)
49.             return true;
50.         if (null == x || null == y)
51.             return true;
52.         return x.equals(y);
53.     }
55.     public int hashCode(Object x) throws HibernateException {
56.         // TODO Auto-generated method stub
57.         return x.hashCode();
58.     }
60.     public boolean isMutable() {
61.         // TODO Auto-generated method stub
62.         return false;
63.     }
65.     public Object nullSafeGet(ResultSet resultSet, String[] names, Object owner)
66.             throws HibernateException, SQLException {
67.         // TODO Auto-generated method stub
69.         E result = null;
70.         if (!resultSet.wasNull()) {
71.             String name = resultSet.getString(names[0]).toUpperCase();
72.             result = Enum.valueOf(clazz, name);
73.         }
74.         return result;
75.     }
77.     public void nullSafeSet(PreparedStatement prepareStatement, Object value,
78.             int index) throws HibernateException, SQLException {
79.         // TODO Auto-generated method stub
80.         if (null == value) {
81.             prepareStatement.setNull(index, Types.VARCHAR);
82.         } else {
83.             prepareStatement.setString(index, ((Enum) value).name());
84.         }
86.     }
88.     public Object replace(Object original, Object target, Object owner)
89.             throws HibernateException {
90.         // TODO Auto-generated method stub
91.         return original;
92.     }
93. }

 

在这里笔者严重提醒大家：

如果你的枚举类里定义的是大写字母，比如：

public static enum Gender {

        MALE, FEMALE;

    }

那么在String name = resultSet.getString(names[0]).toUpperCase();

这里一定要加上toUpperCase()方法。笔者这里介绍的方法，只适用于enmu里的类型为String类型，若要映射其他类新，可以自己修改。

 

最后创建一个子类，继承于这个类：

 

1. public class GenderEnumType extends EnumUserType<Gender> {
3.     public GenderEnumType() {
4.         super(Gender.class);
5.         // TODO Auto-generated constructor stub
6.     }
7. }

 

这样，GenderEnumType就是你在hibernate中定义的可以映射enum的类。

 

当然要写入**.hbm.xml了：

<?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 package=" ">

 

    <class name="TestVO" table="test">

        <id name="id" column="test_id">

            <generator class="native" />

        </id>

        <property name="gender" not-null="true" column="gender"

            type="GenderEnumType" />

    </class>

</hibernate-mapping>

（注释：包的命名可以自己去改，这里不在解释）。

 

也许你认为这种方法，是在是太麻烦了，当然了，肯定有好的解决方法：JDK5.0中的annotation的技术。（请关注下会分解）。