Spring Hibernate Integration Example

Spring Hibernate Integration Example

We can simply integrate hibernate application with spring application.

In hibernate framework, we provide all the database information hibernate.cfg.xml file.

But if we are going to integrate the hibernate application with spring, we don't need to create the hibernate.cfg.xml file. We can provide all the information in the applicationContext.xml file.

---

Advantage of Spring framework with hibernate

The Spring framework provides HibernateTemplate class, so you don't need to follow so many steps like create Configuration, BuildSessionFactory, Session, beginning and committing transaction etc.

So it saves a lot of code.

Understanding problem without using spring:

Let's understand it by the code of hibernate given below:

1. //creating configuration  
2. Configuration cfg=new Configuration();    
3. cfg.configure("hibernate.cfg.xml");    
4.     
5. //creating seession factory object    
6. SessionFactory factory=cfg.buildSessionFactory();    
7.     
8. //creating session object    
9. Session session=factory.openSession();    
10.     
11. //creating transaction object    
12. Transaction t=session.beginTransaction();    
13.         
14. Employee e1=new Employee(111,"arun",40000);    
15. session.persist(e1);//persisting the object    
16.     
17. t.commit();//transaction is commited    
18. session.close();    

As you can see in the code of sole hibernate, you have to follow so many steps.

Solution by using HibernateTemplate class of Spring Framework:

Now, you don't need to follow so many steps. You can simply write this:

1. Employee e1=new Employee(111,"arun",40000);    
2. hibernateTemplate.save(e1);  

Methods of HibernateTemplate class

Let's see a list of commonly used methods of HibernateTemplate class.

No.	Method	Description
1)	void persist(Object entity)	persists the given object.
2)	Serializable save(Object entity)	persists the given object and returns id.
3)	void saveOrUpdate(Object entity)	persists or updates the given object. If id is found, it updates  the record otherwise saves the record.
4)	void update(Object entity)	updates the given object.
5)	void delete(Object entity)	deletes the given object on the basis of id.
6)	Object get(Class entityClass, Serializable id)	returns the persistent object on the basis of given id.
7)	Object load(Class entityClass, Serializable id)	returns the persistent object on the basis of given id.
8)	List loadAll(Class entityClass)	returns the all the persistent objects.

---

Steps

Let's see what are the simple steps for hibernate and spring integration:

1. create table in the database It is optional.
2. create applicationContext.xml file It contains information of DataSource, SessionFactory etc.
3. create Employee.java file It is the persistent class
4. create employee.hbm.xml file It is the mapping file.
5. create EmployeeDao.java file It is the dao class that uses HibernateTemplate.
6. create InsertTest.java file It calls methods of EmployeeDao class.

---

Example of Hibernate and spring integration

In this example, we are going to integrate the hibernate application with spring. Let's see the directory structure of spring and hibernate example.

1) create the table in the database

In this example, we are using the Oracle as the database, but you may use any database. Let's create the table in the oracle database

1. CREATE TABLE  "EMP558"   
2.    (    "ID" NUMBER(10,0) NOT NULL ENABLE,   
3.     "NAME" VARCHAR2(255 CHAR),   
4.     "SALARY" FLOAT(126),   
5.      PRIMARY KEY ("ID") ENABLE  
6.    )  
7. /  

---

2) Employee.java

It is a simple POJO class. Here it works as the persistent class for hibernate.

1. package com.javatpoint;  
2.   
3. public class Employee {  
4. private int id;  
5. private String name;  
6. private float salary;  
7.   
8. //getters and setters  
9.   
10. }  

---

3) employee.hbm.xml

This mapping file contains all the information of the persistent class.

1. <?xml version='1.0' encoding='UTF-8'?>  
2. <!DOCTYPE hibernate-mapping PUBLIC  
3. "-//Hibernate/Hibernate Mapping DTD 3.0//EN"  
4. "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  
5.   
6. <hibernate-mapping>  
7. <class name="com.javatpoint.Employee" table="emp558">  
8.           <id name="id">  
9.           <generator class="assigned"></generator>  
10.           </id>  
11.             
12.           <property name="name"></property>  
13.           <property name="salary"></property>  
14. </class>  
15.             
16. </hibernate-mapping>  

---

4) EmployeeDao.java

It is a java class that uses the HibernateTemplate class method to persist the object of Employee class.

1. package com.javatpoint;  
2. import org.springframework.orm.hibernate3.HibernateTemplate;  
3. import java.util.*;  
4. public class EmployeeDao {  
5. HibernateTemplate template;  
6. public void setTemplate(HibernateTemplate template) {  
7.     this.template = template;  
8. }  
9. //method to save employee  
10. public void saveEmployee(Employee e){  
11.     template.save(e);  
12. }  
13. //method to update employee  
14. public void updateEmployee(Employee e){  
15.     template.update(e);  
16. }  
17. //method to delete employee  
18. public void deleteEmployee(Employee e){  
19.     template.delete(e);  
20. }  
21. //method to return one employee of given id  
22. public Employee getById(int id){  
23.     Employee e=(Employee)template.get(Employee.class,id);  
24.     return e;  
25. }  
26. //method to return all employees  
27. public List<Employee> getEmployees(){  
28.     List<Employee> list=new ArrayList<Employee>();  
29.     list=template.loadAll(Employee.class);  
30.     return list;  
31. }  
32. }  

---

5) applicationContext.xml

In this file, we are providing all the informations of the database in the BasicDataSource object. This object is used in the LocalSessionFactoryBeanclass object, containing some other informations such as mappingResources and hibernateProperties. The object of LocalSessionFactoryBean class is used in the HibernateTemplate class. Let's see the code of applicationContext.xml file.

File: applicationContext.xml

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans  
3.     xmlns="http://www.springframework.org/schema/beans"  
4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
5.     xmlns:p="http://www.springframework.org/schema/p"  
6.     xsi:schemaLocation="http://www.springframework.org/schema/beans  
7.         http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
8.   
9.   
10.     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">  
11.         <property name="driverClassName"  value="oracle.jdbc.driver.OracleDriver"></property>  
12.         <property name="url" value="jdbc:oracle:thin:@localhost:1521:xe"></property>  
13.         <property name="username" value="system"></property>  
14.         <property name="password" value="oracle"></property>  
15.     </bean>  
16.       
17.     <bean id="mysessionFactory"  class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">  
18.         <property name="dataSource" ref="dataSource"></property>  
19.           
20.         <property name="mappingResources">  
21.         <list>  
22.         <value>employee.hbm.xml</value>  
23.         </list>  
24.         </property>  
25.           
26.         <property name="hibernateProperties">  
27.             <props>  
28.                 <prop key="hibernate.dialect">org.hibernate.dialect.Oracle9Dialect</prop>  
29.                 <prop key="hibernate.hbm2ddl.auto">update</prop>  
30.                 <prop key="hibernate.show_sql">true</prop>  
31.                   
32.             </props>  
33.         </property>  
34.     </bean>  
35.       
36.     <bean id="template" class="org.springframework.orm.hibernate3.HibernateTemplate">  
37.     <property name="sessionFactory" ref="mysessionFactory"></property>  
38.     </bean>  
39.       
40.     <bean id="d" class="com.javatpoint.EmployeeDao">  
41.     <property name="template" ref="template"></property>  
42.     </bean>  
43.       
44.       
45.     </beans>  

---

6) InsertTest.java

This class uses the EmployeeDao class object and calls its saveEmployee method by passing the object of Employee class.

1. package com.javatpoint;  
2.   
3. import org.springframework.beans.factory.BeanFactory;  
4. import org.springframework.beans.factory.xml.XmlBeanFactory;  
5. import org.springframework.core.io.ClassPathResource;  
6. import org.springframework.core.io.Resource;  
7.   
8. public class InsertTest {  
9. public static void main(String[] args) {  
10.       
11.     Resource r=new ClassPathResource("applicationContext.xml");  
12.     BeanFactory factory=new XmlBeanFactory(r);  
13.       
14.     EmployeeDao dao=(EmployeeDao)factory.getBean("d");  
15.       
16.     Employee e=new Employee();  
17.     e.setId(114);  
18.     e.setName("varun");  
19.     e.setSalary(50000);  
20.       
21.     dao.saveEmployee(e);  
22.       
23. }  
24. }  

Now, if you see the table in the oracle database, record is inserted successfully.

---

download this example (developed using MyEclipse IDE)

---

Enabling automatic table creation, showing sql queries etc.

You can enable many hibernate properties like automatic table creation by hbm2ddl.auto etc. in applicationContext.xml file. Let's see the code:

1. <property name="hibernateProperties">  
2.             <props>  
3.                 <prop key="hibernate.dialect">org.hibernate.dialect.Oracle9Dialect</prop>  
4.                 <prop key="hibernate.hbm2ddl.auto">update</prop>  
5.                 <prop key="hibernate.show_sql">true</prop>  
6.                   
7.             </props>  

If you write this code, you don't need to create table because table will be created automatically.