关于Clob类型在Hibernate中 的应用小结.doc

Clob数据类型在Hibernate中的应用小结关于Oracle的 Clob数据类型在Hibernate中的应用小结作者： 陈智峰 日期： 2004-12-9Email: QQ:21843781MSN: 欢迎交流!目 录1.文档背景介绍32.问题的出现43.改进方案43.1传统的jbdc方式43.2把clob以string方式处理43.3直接使用clob类型54.实现过程64.1基本配置64.1.1实体类64.1.2实体Form74.1.3hibernate映射文件74.2CRUD的实现74.2.1创建(Create)74.2.2更新(Update)84.2.3读取(Read)94.2.4删除(Delete)105.参考文献10附录111. 文档背景介绍文档主要以本人在一个类似日志系统的项目中对“会议记要”模块进行修改时所遇到的问题为背景，描述了Oracle 的Clob数据类型在Hibernate中的应用心得。现把心得小结一下，跟大家一块交流学习，本文的有关代码均已调试通过。下面是“会议记要”模块的基本信息（其它与本文主题无关的信息均已省略）：名称图表说明实体(MeetingHead)1、 “summaryClob”属性是记录会议内容，类型为Clob。2、 “summaryClobString”属性是String类型的辅助字段，其作用是配合“summaryClob”属性的读取，此属性不映射到数据库中。实体Form(MeetingHeadForm)1、 “summaryClobString”是与MeetingHead实体相对应的属性。数据库表结构(Meeting_Head)1、“summaryClob”是Clob类型的字段。2. 问题的出现summaryClob-是“会议记要”中的“会议内容”字段，这个字段是记录会议内容的主要地方，原来设计时定为VARCHAR2类型，最大长度为4000 bytes，即可以支持两千汉字以内的长度，而我们在实际的应用中，会议内容往往会超过两千汉字，从而导致超出的部分不能写入数据库中，因此我们有必要改为大字段类型。3. 改进方案通常，要解决超过4000字节的数据，一种做法是将数据写入文件，xml或plain file都可以，数据表中保存文件的路径即可。这种做法不必处理clob(Character Large Object), blob(Binary Large Object)等格式的字段类型，但不易做transaction的控制，而且增加了对文件的处理操作，不算是较佳的一个方案。另一个做法是使用clob, blob等字段类型，主要有：采用传统的jbdc方式、把clob以string方式处理、直接使用clob类型三种方案，下面分别作简要介绍 。3.1 传统的jbdc方式写入Blob/Clob字段和写入其它类型字段的方式非常不同，因为Blob/Clob自身有一个cursor，必须使用cursor对Blob/Clob进行操作，因而在写入Blob/Clob之前，必须获得cursor才能进行写入，那就需要先插入一个empty的Blob/Clob，这将创建一个Blob/Clob的cursor，然后再把这个empty的Blob/Clob的cursor用select查询出来，这样通过两步操作，就获得了Blob/Clob的cursor，可以真正的写入Blob/Clob数据了。这种方式比较麻烦，读写都要增加不少工作量 。关于这种方式的具体实现代码，在Hibernate的中国网站中，其站长robbin已详细描述过，具体请参照：/viewtopic.php?t=254 3.2 把clob以string方式处理此方法主要是通过继承net.sf.hibernate.type.ImmutableType类或cirrus.hibernate.UserType类来创建一个新的类如：StringClobType，然后在相应的配置文件里面，把该字段映射为StringClobType类型，即可正常操作。此方法的优点主要体现在具体实现操作的代码较为简单，但在第一步的映射问题上，较难理解。有关此方法的具体实现代码请参照：/76.html 3.3 直接使用clob类型第三种方法是直接使用clob类型，它主要是在实体中增加一个clobString字段，通过对该字段的读写，在DAOImpl层进行特殊处理后，转换为真正的clob类型，从而实现clob类型字段的CRUD操作，其大致的处理流程如下图所示：此方法主要优点体现在配置文件的映射类型上，只需要像映射其它基本类型一样，直接写上 type=clob 就OK了。这对初次遇到这种问题的人来说入门相对容易。由于第二种方法需要额外地创建一个新类型，而且对ImmutableType和UserType类不太了解，因此我推荐采用第三种方法。关于此方法的官方文档请参照：Using Clobs with Oracle and Hibernate 1.2下面，我将按照本部门约定的标准开发架构，结合tmsht项目的“会议记要”模块，从实体类到DAOImpl实现类，分别详细地描述clob类型的配置及其CRUD操作的具体实现代码。4. 实现过程本章节主要分为“基本配置”及“CRUD的实现”两小节。第一小节分别从实体类、实体类对应的Form类以及hibernate映射文件三个方面描述了clob类型的配置步骤；第二小节则描述了CRUD操作的具体实现代码，由于主要的实现代码在DAOImpl层出现，因此Delegate、Service 、ServiceImpl 、DAO四层的代码将省略。注意：1、所有实际代码均在黑方框内，并带有灰色底纹。 2、与本文档主题无关的代码统一用 ” 表示。4.1 基本配置4.1.1 实体类在该字段对应的实体文件里面，增加以下两个变量及其相应的get/set方法。注意：summaryClobString并不映射到数据库的CLOB字段，只是方便需要使用这个BO的人用get / set 处理CLOB字段。private Clob summaryClob; private String summaryClobString;public Clob getSummaryClob() return summaryClob;public void setSummaryClob(Clob summaryClob) this.summaryClob = summaryClob;public String getSummaryClobString() return summaryClobString;public void setSummaryClobString(String summaryClobString) this.summaryClobString = summaryClobString;4.1.2 实体Form在该实体对应的Form里添加一个字符串变量及相应的get/ser方法：private String summaryClobString;public String getSummaryClobString() return summaryClobString;public void setSummaryClobString(String summaryClobString) this.summaryClobString = summaryClobString;注意：在Form里面只需要用summaryClobString与实体类进行对应就可以了，这样，在下面的Delegate层里，就可以不用作其它特殊处理，直接用CommonUtil.copyProperties()方法对实体和Form进行转换。4.1.3 hibernate映射文件在该实体对应的映射文件里只需要增加下面一行，直接声明该字段为clob类型：4.2 CRUD的实现4.2.1 创建(Create) public class MeetingHeadDAOHibernate extends BaseDAOHibernate implements MeetingHeadDAO /* * author CZF * Description：创建一个新的会议记要 */ public Serializable createMeetingHead(MeetingHead mh) throws DAOException try Session sess = HibernateHelper.currentTransaction(); Serializable result = sess.save(mh); sess.flush(); /初始化SummaryClob字段 oracle.sql.CLOB clob = oracle.sql.CLOB.empty_lob(); mh.setSummaryClob(clob); /*也可采用此方法进行初始化 mh.setSummaryClob (Hibernate.createClob(); */ /此处一定要用lockMode.UPGRADE模式进行锁定刷新 sess.refresh(mh, LockMode.UPGRADE); /获取MeetingHead实体的SummaryClobString属性值 String content = mh.getSummaryClobString(); /将获取的辅助字段的值通过oracle.sql.CLOB的putString（）方法赋 值给实体内的summaryClob字段 oracle.sql.CLOB clob = (oracle.sql.CLOB) mh.getSummaryClob(); clob.putString(1, content); HbernateHelper.endCurrentTransaction(); return result;4.2.2 更新(Update) “更新”原理跟“创建”类似，但记住在更新前一定要先将原实体的clob类型的字段内容清空，然后再赋新值进去，否则会出现不能删除旧内容的情况。public class MeetingHeadDAOHibernate extends BaseDAOHibernate implements MeetingHeadDAO /* * author CZF * Description：更新一个新的会议记要 */public void updateMeetingHead(MeetingHead mh) throws DAOException Class clazz = this.getEntityClass(); try Session sess = HibernateHelper.currentTransaction(); / 首先通过锁模式把该实体读出来 MeetingHead oldMh = (MeetingHead) sess.load(clazz, mh.getId(), LockMode.UPGRADE); / 获取辅助字段的值 String newMhValue = mh.getSummaryClobString(); / 更新前首先要清空原clob字段的内容 oracle.sql.CLOB clob_empty = oracle.sql.CLOB.empty_lob(); oldMh.setSummaryClob(clob_empty); / 必须要执行以下两步，否则将抛出“不能对空clob进行读写操作”的异常 sess.flush(); sess.refresh(oldMh, LockMode.UPGRADE); /将获取的辅助字段的值通过oracle.sql.CLOB的putString（）方法赋 值给实体内的summaryClob字段 oracle.sql.CLOB clob = (oracle.sql.CLOB) oldMh.getSummaryClob(); clob.putString(1, newMhValue);4.2.3 读取(Read) public class MeetingHeadDAOHibernate extends BaseDAOHibernate implements MeetingHeadDAO /* * author CZF * Description：读取一个会议记要* / public MeetingHead getMeetingHeadById(String id) throws BusinessException, SQLException MeetingHead mh = (MeetingHead) service.getMeetingHeadById(id); /获取实体的Clob字段的值 java.sql.Clob clob = mh.getSummaryClob(); /将获取的Clob值通过java.sql.Clob的getSubString()方法赋值给实体的 辅助字段 if (clob != null) String b1 = clob.getSubString(1, (int) clob.length(); mh.setSummaryClobString(b1); return mh; 4.2.4 删除(Delete) 由于删除操作不需要对Clob类型作特殊处理，只要通过id找出相应的实体删掉就行，具体代码在此就不列出了。5.