Hibernate with Spring

[Yellapa Adepu]

Friends,
I though it may useful to some body who is looking for such information...
Introduction
As most of us well aware of Hibernate and Spring frameworks, I am not getting into much of introduction part. However in short,

Hibernate
� A popular & successful ORM tool
� Abstracting the underlining JDBC programming
� Portable to any supported database with minor configuration changes
� Provides Transaction Management etc�.

Spring
� Implementation Inversion of Control (IOC) design pattern.
� Abstraction to Aspect Oriented Programming (AOP).
� Creates the java object beans from an application context xml (spring configuration file)
I would like to walk you through a running example how they both work together� Please take a look at the below xml..

Header part of spring configuration xml includes spring-bean.dtd

<?xml version=�1.0″ encoding=�UTF-8″?>
<!DOCTYPE beans SYSTEM �http://www.springframework.org/dtd/spring-beans.dtd� >

Loading Hibernate properties: Hibernate properties can be loaded using Spring�s PropertyPlaceholderConfigurer class. Provide hibernate.properties file location as value. If the file placed under any other directory other than WEB-INF directory, use classpath: expression to let the Spring to look for the file in available classpath.

<!� Hibernate Properties �>
<bean id=�PropertyConfigurer� class=�org.springframework.beans.factory.config.PropertyPlaceholderConfigurer�>
<property name=�locations�>
<list>
<value>classpath:/properties/hibernate.properties</value>
</list>
</property>
</bean>

Defining a DataSource: Use JndiObjectFactoryBean class to define the data source by providing JNDI binding name.

<!� Data Source JNDI �>
<bean id=�dataSource� class=�org.springframework.jndi.JndiObjectFactoryBean�>
<property name=�jndiName�>
<value>jdbc/SampleDS</value>
</property>
</bean>

Defining a Session Factory: Hibernate session factory can be defined using LocalSessionFactoryBean class, provides an integration point to Hibernate from Spring.
Here we need to provide data source information and hibernate mapping files (.hbm.xml).
Transaction factory class, hibernate supports
org.hibernate.transaction.JDBCTransactionFactory - delegates to database (JDBC) transactions (default)
org.hibernate.transaction.JTATransactionFactory - delegates to container-managed transaction if an existing transaction is underway in this context (e.g. EJB session bean method), otherwise a new transaction is started and bean-managed transaction are used.
org.hibernate.transaction.CMTTransactionFactory - delegates to container-managed JTA transactions

Transaction Lookup class: It depends on application server on which the application is running, here I am using WebSphere Application Server related one.
Special columns if there are any column defined CLOBs, those can handled using default implementation provided spring. Here as an example I am using CLOB handler.

<!� Session Factory �>
<bean id=�sessionFactory� class=�org.springframework.orm.hibernate3.LocalSessionFactoryBean�>
<property name=�dataSource�><ref local=�dataSource�/></property>
<property name=�mappingResources�>
<list>
<value>com/sample/TableName1.hbm.xml</value>
</list>
</property>
<property name=�hibernateProperties�>
<props>
<prop key=�hibernate.dialect�>${hibernate.dialect}</prop>
<prop key=�hibernate.show_sql�>${hibernate.show_sql}</prop>
<prop key=�hibernate.default_schema�>${hibernate.default_schema}</prop>
<prop key=�hibernate.transaction.factory_class�>
org.hibernate.transaction.JTATransactionFactory</prop>
<prop key=�hibernate.transaction.manager_lookup_class�>
org.hibernate.transaction.WebSphereTransactionManagerLookup</prop>
<prop key=�jta.UserTransaction�>java:comp/UserTransaction</prop>
<prop key=�hibernate.cache.provider_class�>org.hibernate.cache.EhCacheProvider</prop>
<prop key=�hibernate.cache.use_query_cache�>true</prop>
<prop key=�hibernate.cache.use_second_level_cache�>true</prop>
<prop key=�hibernate.temp.use_jdbc_metadata_defaults�>false</prop>
</props>
</property>
<property name=�lobHandler� ref=�lobHandler�>
</property>
</bean>
<!� LOB Hanlder �>
<bean id=�lobHandler� class=�org.springframework.jdbc.support.lob.DefaultLobHandler� lazy-init=�true�>
</bean>

Defining a Transaction Manager: By providing the above defined session factory, a transaction manager needs to be defined as below.

<!� Transaction Manager �>
<bean id=�transactionManager� class=�org.springframework.orm.hibernate3.HibernateTransactionManager� abstract=�false� lazy-init=�default� autowire=�default� dependency-check=�default�>
<property name=�sessionFactory�><ref bean=�sessionFactory�/></property>
</bean>
 
<!� DAO Services �>
<bean id=�dao� class=�com.sample.dao.DAOImpl�>
<property name=�sessionFactory�><ref bean=�sessionFactory�/></property>
</bean>
 
<!� Transactional JTA Services �>
<bean id=�txServiceImpl� class=�com.sample.TxServiceImpl�>
<property name=�dao�><ref local=�dao�/></property>
</bean>
 
<!� Persistence Services �>
<bean id=�service� class=�org.springframework.transaction.interceptor.TransactionProxyFactoryBean�>
<property name=�target� ref=�txServiceImpl�/>
<property name=�proxyInterfaces� value=�com.sample.ITxService�/>
<property name=�transactionManager� ref=�transactionManager�/>
<property name=�transactionAttributes�>
<props>
<prop key=�save*�>PROPAGATION_REQUIRED</prop>
<prop key=�update*�>PROPAGATION_REQUIRED</prop>
<prop key=�delete*�>PROPAGATION_REQUIRED</prop>
<prop key=�get*�>PROPAGATION_REQUIRED,readOnly</prop>
</props>
</property>
</bean>

It might be a quick, not much detailed enough as I covered only basic configuration. Please let write your inputs/comments, I will try to add some more details�..
[ June 26, 2008: Message edited by: Yellappa Adepu ]

[subha nair]

Hello,
I am trying to add hibernate to my existing spring application.I am using spring 2.5,hibernate annotations 3.2, mysql and tomcat
I have written applicationcontext.xml and hibernate.cfg.xml.
But I am getting this error

Context initialization failed.org.springframework.beans.factory.beandefinitionstoreexception: IOException parsing XML document from servletcontext resource [/web-inf/applicationcontext.xml]
nested exception is java.io.FilenotfoudException: could not open servletcontext resource [/web-inf/applicationContext.xml]


Below are the two config files

applicationContext.xml
****************************

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-2.0.xsd">
<!-- the parent application context definition for the springapp application -->

<bean id="dataSource"
class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName">
<value>com.mysql.jdbc.Driver</value>
</property>
<property name="url">
<value>jdbc:mysql://localhost:3306/bank</value>
</property>
<property name="username">
<value>root</value>
</property>
<property name="password">
<value>root</value>
</property>
</bean>

<bean id="sessionFactory"
class="org.springframework.orm.hibernate3.
LocalSessionFactoryBean">
<property name="dataSource">
<ref bean="dataSource" />
</property>
<property name="configLocation">
<value>WEB-INF\classes\hibernate.cfg.xml</value>
</property>
<property name="configurationClass">
<value>org.hibernate.cfg.AnnotationConfiguration</value>
</property>
<property name="hibernateProperties">
<props>
<prop key="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</prop>
<prop key="hibernate.hbm2ddl.auto">create</prop>
</props>
</property>
</bean>
<bean id="customerDAOimpl">
<property name="sessionFactory">
<ref bean="sessionFactory" />
</property>
</bean>

<bean id="customerDAO" class="com.palnar.college.DAO.customerDAOHibernateImpl.java"
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>


</beans>

hibernate.cfg.xml
************************

<hibernate-configuration>
<session-factory>
<mapping package="com.palnar.college.service" />
<mapping class="com.palnar.college.service.Customer" />
</session-factory>
</hibernate-configuration>

web.xml
*************
......
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>

......

PLEASE HELP ME OUT.THIS IS VERY URGENT

[Yellapa Adepu]

Where is your applicationContext.xml located. If it is not there under WEB-INF, you may encounter the described error.

1. Try to move the applicationContext.xml under WEB-INF folder.
OR
2. Use classpath expression from where your loading the applicationContext.xml. eg.

<param-value>classpath*:/properties/applicationContext.xml</param-value>

Let me know if I can be more helpful.

Thanks