Spring 3.0 MVC with Hibernate 3.0 CRUD Example

Spring 3.0 MVC with Hibernate 3.0 CRUD Example

In this example show how to write a simple web based application with CRUD  operation using Spring3 MVC Framwork with Hibernate3 using Annotation, which can handle CRUD inside its controllers. To start with it, let us have working STS IDE in place and follow the following steps to develop a Dynamic Form based Web Application using Spring Web Framework:

Step 1: Create a Database DAVDB on MySql Database and also we create Employee table on this database.

view plainprint?

1. CREATE TABLE Employee(  
2.    EMPID   INT NOT NULL AUTO_INCREMENT,  
3.    EMPNAME VARCHAR(20) NOT NULL,  
4.    EMPAGE  INT NOT NULL,  
5.    SALARY BIGINT NOT NULL,  
6.    ADDRESS VARCHAR(20) NOT NULL  
7.    PRIMARY KEY (ID)  
8. );  

Step 2: Create a database.properties for database configuration information in the resources folder under src folder in the created project.

view plainprint?

1. database.driver=com.mysql.jdbc.Driver  
2. database.url=jdbc:mysql://localhost:3306/DAVDB  
3. database.user=root  
4. database.password=root  
5. hibernate.dialect=org.hibernate.dialect.MySQLDialect  
6. hibernate.show_sql=true  
7. hibernate.hbm2ddl.auto=update  

Step 3: Create a Dynamic Web Project with a name Spring3HibernateApp and create packages com.dineshonjava.controller, com.dineshonjava.bean, com.dineshonjava.dao, com.dineshonjava.service, com.dineshonjava.model under the src folder in the created project.

Step 4: Add below mentioned Spring 3.0 and Hibernate 3.0 related libraries and other libraries into the folder WebRoot/WEB-INF/lib. 

Step 5: Create a Java class EmployeeController, EmployeeBean, Employee, EmployeeDao, EmployeeDaoImpl, EmployeeService, EmployeeServiceImpl under the respective packages..

Step 6: Create Spring configuration files web.xml and sdnext-servlet.xml under the WebRoot/WEB-INF/ and WebRoot/WEB-INF/config folders.

Step 7: Create a sub-folder with a name views under the WebRoot/WEB-INF folder. Create a view file addEmployee.jsp, employeesList.jsp and index.jsp under this sub-folder.

Step 8: The final step is to create the content of all the source and configuration files name sdnext-servlet.xml under the sub-folder /WebRoot/WEB-INF/config and export the application as explained below.

Application Architecture

We will have a layered architecture for our demo application. The database will be accessed by a Data Access layer popularly called as DAO Layer. This layer will use Hibernate API to interact with database. The DAO layer will be invoked by a service layer. In our application we will have a Service interface called EmployeeService.

EmployeeBean.java

1. package com.dineshonjava.bean;  
2.   
3. /** 
4.  * @author Mallikarjun
5.  * 
6.  */  
7. public class EmployeeBean {  
8.  private Integer id;  
9.  private String name;  
10.  private Integer age;  
11.  private Long salary;  
12.  private String address;  
13.    
14.  public Long getSalary() {  
15.   return salary;  
16.  }  
17.  public void setSalary(Long salary) {  
18.   this.salary = salary;  
19.  }  
20.  public Integer getId() {  
21.   return id;  
22.  }  
23.  public void setId(Integer id) {  
24.   this.id = id;  
25.  }  
26.  public String getName() {  
27.   return name;  
28.  }  
29.  public void setName(String name) {  
30.   this.name = name;  
31.  }  
32.  public Integer getAge() {  
33.   return age;  
34.  }  
35.  public void setAge(Integer age) {  
36.   this.age = age;  
37.  }  
38.  public String getAddress() {  
39.   return address;  
40.  }  
41.  public void setAddress(String address) {  
42.   this.address = address;  
43.  }  
44. }  

Employee.java

1. package com.dineshonjava.model;  
2.   
3. import java.io.Serializable;  
4.   
5. import javax.persistence.Column;  
6. import javax.persistence.Entity;  
7. import javax.persistence.GeneratedValue;  
8. import javax.persistence.GenerationType;  
9. import javax.persistence.Id;  
10. import javax.persistence.Table;  
11. @Entity  
12. @Table(name="Employee")  
13. public class Employee implements Serializable{  
14.   
15.  private static final long serialVersionUID = -723583058586873479L;  
16.    
17.  @Id  
18.  @GeneratedValue(strategy=GenerationType.AUTO)  
19.  @Column(name = "empid")  
20.  private Integer empId;  
21.    
22.  @Column(name="empname")  
23.  private String empName;  
24.    
25.  @Column(name="empaddress")  
26.  private String empAddress;  
27.    
28.  @Column(name="salary")  
29.  private Long salary;  
30.    
31.  @Column(name="empAge")  
32.  private Integer empAge;  
33.   
34.  public Integer getEmpId() {  
35.   return empId;  
36.  }  
37.   
38.  public void setEmpId(Integer empId) {  
39.   this.empId = empId;  
40.  }  
41.   
42.  public String getEmpName() {  
43.   return empName;  
44.  }  
45.   
46.  public void setEmpName(String empName) {  
47.   this.empName = empName;  
48.  }  
49.   
50.  public String getEmpAddress() {  
51.   return empAddress;  
52.  }  
53.   
54.  public void setEmpAddress(String empAddress) {  
55.   this.empAddress = empAddress;  
56.  }  
57.   
58.  public Long getSalary() {  
59.   return salary;  
60.  }  
61.   
62.  public void setSalary(Long salary) {  
63.   this.salary = salary;  
64.  }  
65.   
66.  public Integer getEmpAge() {  
67.   return empAge;  
68.  }  
69.   
70.  public void setEmpAge(Integer empAge) {  
71.   this.empAge = empAge;  
72.  }  
73. }  

EmployeeDao.java

1. package com.dineshonjava.dao;  
2.   
3. import java.util.List;  
4.   
5. import com.dineshonjava.model.Employee;  
6. public interface EmployeeDao {  
7.    
8.  public void addEmployee(Employee employee);  
9.   
10.  public List<Employee> listEmployeess();  
11.    
12.  public Employee getEmployee(int empid);  
13.    
14.  public void deleteEmployee(Employee employee);  
15. }  

EmployeeDaoImpl.java

1. package com.dineshonjava.dao;  
2.   
3. import java.util.List;  
4.   
5. import org.hibernate.SessionFactory;  
6. import org.springframework.beans.factory.annotation.Autowired;  
7. import org.springframework.stereotype.Repository;  
8.   
9. import com.dineshonjava.model.Employee;  
10.   
11. @Repository("employeeDao")  
12. public class EmployeeDaoImpl implements EmployeeDao {  
13.   
14.  @Autowired  
15.  private SessionFactory sessionFactory;  
16.    
17.  public void addEmployee(Employee employee) {  
18.    sessionFactory.getCurrentSession().saveOrUpdate(employee);  
19.  }  
20.   
21.  @SuppressWarnings("unchecked")  
22.  public List<Employee> listEmployeess() {  
23.   return (List<Employee>) sessionFactory.getCurrentSession().createCriteria(Employee.class).list();  
24.  }  
25.   
26.  public Employee getEmployee(int empid) {  
27.   return (Employee) sessionFactory.getCurrentSession().get(Employee.class, empid);  
28.  }  
29.   
30.  public void deleteEmployee(Employee employee) {  
31.   sessionFactory.getCurrentSession().createQuery("DELETE FROM Employee WHERE empid = "+employee.getEmpId()).executeUpdate();  
32.  }  
33. }<span style="color: #4c1130;"><b>  
34. </b></span>  

EmployeeService.java

1. package com.dineshonjava.service;  
2.   
3. import java.util.List;  
4.   
5. import com.dineshonjava.model.Employee;  
6.   
7. public interface EmployeeService {  
8.    
9.  public void addEmployee(Employee employee);  
10.   
11.  public List<Employee> listEmployeess();  
12.    
13.  public Employee getEmployee(int empid);  
14.    
15.  public void deleteEmployee(Employee employee);  
16. }  

EmployeeServiceImpl.java

1. package com.dineshonjava.service;  
2.   
3. import java.util.List;  
4.   
5. import org.springframework.beans.factory.annotation.Autowired;  
6. import org.springframework.stereotype.Service;  
7. import org.springframework.transaction.annotation.Propagation;  
8. import org.springframework.transaction.annotation.Transactional;  
9.   
10. import com.dineshonjava.dao.EmployeeDao;  
11. import com.dineshonjava.model.Employee;  
12. @Service("employeeService")  
13. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)  
14. public class EmployeeServiceImpl implements EmployeeService {  
15.   
16.  @Autowired  
17.  private EmployeeDao employeeDao;  
18.    
19.  @Transactional(propagation = Propagation.REQUIRED, readOnly = false)  
20.  public void addEmployee(Employee employee) {  
21.   employeeDao.addEmployee(employee);  
22.  }  
23.    
24.  public List<Employee> listEmployeess() {  
25.   return employeeDao.listEmployeess();  
26.  }  
27.   
28.  public Employee getEmployee(int empid) {  
29.   return employeeDao.getEmployee(empid);  
30.  }  
31.    
32.  public void deleteEmployee(Employee employee) {  
33.   employeeDao.deleteEmployee(employee);  
34.  }  
35.   
36. }  

EmployeeController.java

1. package com.dineshonjava.controller;  
2.   
3. import java.util.ArrayList;  
4. import java.util.HashMap;  
5. import java.util.List;  
6. import java.util.Map;  
7.   
8. import org.springframework.beans.factory.annotation.Autowired;  
9. import org.springframework.stereotype.Controller;  
10. import org.springframework.validation.BindingResult;  
11. import org.springframework.web.bind.annotation.ModelAttribute;  
12. import org.springframework.web.bind.annotation.RequestMapping;  
13. import org.springframework.web.bind.annotation.RequestMethod;  
14. import org.springframework.web.servlet.ModelAndView;  
15.   
16. import com.dineshonjava.bean.EmployeeBean;  
17. import com.dineshonjava.model.Employee;  
18. import com.dineshonjava.service.EmployeeService;  
19. @Controller  
20. public class EmployeeController {  
21.    
22.  @Autowired  
23.  private EmployeeService employeeService;  
24.    
25. @RequestMapping(value = "/save", method = RequestMethod.POST)  
26. public ModelAndView saveEmployee(@ModelAttribute("command")EmployeeBean employeeBean,   
27.    BindingResult result) {  
28.   Employee employee = prepareModel(employeeBean);  
29.   employeeService.addEmployee(employee);  
30.   return new ModelAndView("redirect:/add.html");  
31.  }  
32.   
33.  @RequestMapping(value="/employees", method = RequestMethod.GET)  
34.  public ModelAndView listEmployees() {  
35.   Map<String Object> model = new HashMap<String Object>();  
36.   model.put("employees",  prepareListofBean(employeeService.listEmployeess()));  
37.   return new ModelAndView("employeesList", model);  
38.  }  
39.   
40.  @RequestMapping(value = "/add", method = RequestMethod.GET)  
41.  public ModelAndView addEmployee(@ModelAttribute("command")EmployeeBean employeeBean,  
42.    BindingResult result) {  
43.   Map<String, Object> model = new HashMap<String, Object>();  
44.   model.put("employees",  prepareListofBean(employeeService.listEmployeess()));  
45.   return new ModelAndView("addEmployee", model);  
46.  }  
47.    
48. @RequestMapping(value = "/index", method = RequestMethod.GET)  
49. public ModelAndView welcome() {  
50.   return new ModelAndView("index");  
51.  }  
52.   
53. @RequestMapping(value = "/delete", method = RequestMethod.GET)  
54. public ModelAndView editEmployee(@ModelAttribute("command")EmployeeBean employeeBean,  
55.    BindingResult result) {  
56.   employeeService.deleteEmployee(prepareModel(employeeBean));  
57.   Map<String<b>,</b> Object> model = new HashMap<String, Object>();  
58.   model.put("employee", null);  
59.   model.put("employees",  prepareListofBean(employeeService.listEmployeess()));  
60.   return new ModelAndView("addEmployee", model);  
61.  }  
62.    
63. @RequestMapping(value = "/edit", method = RequestMethod.GET)  
64. public ModelAndView deleteEmployee(@ModelAttribute("command")EmployeeBean employeeBean,  
65.    BindingResult result) {  
66.   Map<String, Object> model = new HashMap<String, Object>();  
67.   model.put("employee", prepareEmployeeBean(employeeService.getEmployee(employeeBean.getId())));  
68.   model.put("employees",  prepareListofBean(employeeService.listEmployeess()));  
69.   return new ModelAndView("addEmployee", model);  
70.  }  
71.    
72.  private Employee prepareModel(EmployeeBean employeeBean){  
73.   Employee employee = new Employee();  
74.   employee.setEmpAddress(employeeBean.getAddress());  
75.   employee.setEmpAge(employeeBean.getAge());  
76.   employee.setEmpName(employeeBean.getName());  
77.   employee.setSalary(employeeBean.getSalary());  
78.   employee.setEmpId(employeeBean.getId());  
79.   employeeBean.setId(null);  
80.   return employee;  
81.  }  
82.    
83.  private List<EmployeeBean> prepareListofBean(List<Employee> employees){  
84.   List<employeebean> beans = null;  
85.   if(employees != null && !employees.isEmpty()){  
86.    beans = new ArrayList<EmployeeBean>();  
87.    EmployeeBean bean = null;  
88.    for(Employee employee : employees){  
89.     bean = new EmployeeBean();  
90.     bean.setName(employee.getEmpName());  
91.     bean.setId(employee.getEmpId());  
92.     bean.setAddress(employee.getEmpAddress());  
93.     bean.setSalary(employee.getSalary());  
94.     bean.setAge(employee.getEmpAge());  
95.     beans.add(bean);  
96.    }  
97.   }  
98.   return beans;  
99.  }  
100.    
101.  private EmployeeBean prepareEmployeeBean(Employee employee){  
102.   EmployeeBean bean = new EmployeeBean();  
103.   bean.setAddress(employee.getEmpAddress());  
104.   bean.setAge(employee.getEmpAge());  
105.   bean.setName(employee.getEmpName());  
106.   bean.setSalary(employee.getSalary());  
107.   bean.setId(employee.getEmpId());  
108.   return bean;  
109.  }  
110. }  

Spring Web configuration file web.xml

1. <web-app version="2.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemalocation="http://java.sun.com/xml/ns/javaee   
2.           http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">  
3.   
4.    <servlet>  
5.      <servlet-name>sdnext</servlet-name>  
6.      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
7.      <init-param>  
8.             <param-name>contextConfigLocation</param-name><param-value>/WEB-INF/config/sdnext-servlet.xml</param-value></init-param>  
9.      <load-on-startup>1</load-on-startup>  
10.    </servlet>  
11.   
12.  <servlet-mapping>  
13.   <servlet-name>sdnext</servlet-name>  
14.   <url-pattern>*.html</url-pattern>  
15.  </servlet-mapping>  
16.   
17.  <welcome-file-list>  
18.   <welcome-file>index.html</welcome-file>  
19.  </welcome-file-list>  
20.   
21. </web-app>  

Spring Web configuration file sdnext-servlet.xml

1. <beans xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.springframework.org/schema/beans" xsi:schemalocation="  
2. http://www.springframework.org/schema/beans  
3. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  
4. http://www.springframework.org/schema/context  
5. http://www.springframework.org/schema/context/spring-context-3.0.xsd  
6. http://www.springframework.org/schema/tx  
7. http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">  
8.   
9. <context:property-placeholder location="classpath:resources/database.properties">  
10. </context:property-placeholder>  
11. <context:component-scan base-package="com.dineshonjava">  
12. </context:component-scan>  
13.   
14. <tx:annotation-driven transaction-manager="hibernateTransactionManager">  
15. </tx:annotation-driven>  
16.   
17. <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="jspViewResolver">  
18.  <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"></property>  
19.  <property name="prefix" value="/WEB-INF/views/"></property>  
20.  <property name="suffix" value=".jsp"></property>  
21. </bean>  
22.   
23. <bean class="org.springframework.jdbc.datasource.DriverManagerDataSource" id="dataSource">  
24.  <property name="driverClassName" value="${database.driver}"></property>  
25.  <property name="url" value="${database.url}"></property>  
26.  <property name="username" value="${database.user}"></property>  
27.  <property name="password" value="${database.password}"></property>  
28. </bean>  
29.   
30. <bean class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean" id="sessionFactory">  
31.  <property name="dataSource" ref="dataSource"></property>  
32.  <property name="annotatedClasses">  
33.   <list>  
34.    <value>com.dineshonjava.model.Employee</value>  
35.   </list>  
36.  </property>  
37.  <property name="hibernateProperties">  
38.  <props>  
39.   <prop key="hibernate.dialect">${hibernate.dialect}</prop>  
40.   <prop key="hibernate.show_sql">${hibernate.show_sql}</prop>  
41.   <prop key="hibernate.hbm2ddl.auto">${hibernate.hbm2ddl.auto}  </prop>      
42.         </props>  
43.       </property>  
44. </bean>  
45.   
46.   <bean class="org.springframework.orm.hibernate3.HibernateTransactionManager" id="hibernateTransactionManager">  
47.  <property name="sessionFactory" ref="sessionFactory"></property>  
48.   </bean>  
49. </beans>  

addEmployee.jsp

1. <%@ page language="java" contentType="text/html; charset=ISO-8859-1"  
2.     pageEncoding="ISO-8859-1"%>  
3. <%@taglib uri="http://www.springframework.org/tags/form" prefix="form"%>  
4. <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>  
5. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
6. <html>  
7.  <head>  
8.   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">  
9.   <title>Spring MVC Form Handling</title>  
10.  </head>  
11.  <body>  
12.   <h2>Add Employee Data</h2>  
13.   <form:form method="POST" action="/sdnext/save.html">  
14.       <table>  
15.        <tr>  
16.            <td><form:label path="id">Employee ID:</form:label></td>  
17.            <td><form:input path="id" value="${employee.id}" readonly="true"/></td>  
18.        </tr>  
19.        <tr>  
20.            <td><form:label path="name">Employee Name:</form:label></td>  
21.            <td><form:input path="name" value="${employee.name}"/></td>  
22.        </tr>  
23.        <tr>  
24.            <td><form:label path="age">Employee Age:</form:label></td>  
25.            <td><form:input path="age" value="${employee.age}"/></td>  
26.        </tr>  
27.        <tr>  
28.            <td><form:label path="salary">Employee Salary:</form:label></td>  
29.            <td><form:input path="salary" value="${employee.salary}"/></td>  
30.        </tr>  
31.          
32.        <tr>  
33.            <td><form:label path="address">Employee Address:</form:label></td>  
34.                     <td><form:input path="address" value="${employee.address}"/></td>  
35.        </tr>  
36.           <tr>  
37.          <td colspan="2"><input type="submit" value="Submit"/></td>  
38.         </tr>  
39.    </table>   
40.   </form:form>  
41.     
42.   <c:if test="${!empty employees}">  
43.   <h2>List Employees</h2>  
44.  <table align="left" border="1">  
45.   <tr>  
46.    <th>Employee ID</th>  
47.    <th>Employee Name</th>  
48.    <th>Employee Age</th>  
49.    <th>Employee Salary</th>  
50.    <th>Employee Address</th>  
51.            <th>Actions on Row</th>  
52.   </tr>  
53.   
54.   <c:forEach items="${employees}" var="employee">  
55.    <tr>  
56.     <td><c:out value="${employee.id}"/></td>  
57.     <td><c:out value="${employee.name}"/></td>  
58.     <td><c:out value="${employee.age}"/></td>  
59.     <td><c:out value="${employee.salary}"/></td>  
60.     <td><c:out value="${employee.address}"/></td>  
61.     <td align="center"><a href="edit.html?id=${employee.id}">Edit</a> | <a href="delete.html?id=${employee.id}">Delete</a></td>  
62.    </tr>  
63.   </c:forEach>  
64.  </table>  
65. </c:if>  
66.  </body>  
67. </html>  

employeesList.jsp

1. <%@ page language="java" contentType="text/html; charset=ISO-8859-1"  
2.     pageEncoding="ISO-8859-1"%>  
3. <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>  
4. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
5. <html>  
6. <head>  
7. <title>All Employees</title>  
8. </head>  
9. <body>  
10. <h1>List Employees</h1>  
11. <h3><a href="add.html">Add More Employee</a></h3>  
12.   
13. <c:if test="${!empty employees}">  
14.  <table align="left" border="1">  
15.   <tr>  
16.    <th>Employee ID</th>  
17.    <th>Employee Name</th>  
18.    <th>Employee Age</th>  
19.    <th>Employee Salary</th>  
20.    <th>Employee Address</th>  
21.   </tr>  
22.   
23.   <c:forEach items="${employees}" var="employee">  
24.    <tr>  
25.     <td><c:out value="${employee.id}"/></td>  
26.     <td><c:out value="${employee.name}"/></td>  
27.     <td><c:out value="${employee.age}"/></td>  
28.     <td><c:out value="${employee.salary}"/></td>  
29.     <td><c:out value="${employee.address}"/></td>  
30.    </tr>  
31.   </c:forEach>  
32.  </table>  
33. </c:if>  
34. </body>  
35. </html>  

index.jsp

1. <%@ page language="java" contentType="text/html; charset=ISO-8859-1"  
2.     pageEncoding="ISO-8859-1"%>  
3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
4. <html>  
5.   <head>  
6.     <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">  
7.     <title>Spring3MVC with Hibernate3 CRUD Example using Annotations</title>  
8.   </head>  
9.   <body>  
10.     <h2>Spring3MVC with Hibernate3 CRUD Example using Annotations</h2>  
11.     <h2>1. <a href="employees.html">List of Employees</a></h2>  
12.     <h2>2. <a href="add.html">Add Employee</a></h2>  
13.   </body>  
14. </html>  

Once you are done with creating source and configuration files, export your application. Right click on your application and use Export-> WAR File option and save your Spring3HibernateApp.war file in Tomcat's webapps folder.

Now start your Tomcat server and make sure you are able to access other web pages from webapps folder using a standard browser. Now try a URL http://localhost:8080/sdnext/ and you should see the following result if everything is fine with your Spring Web Application:

1. CREATE EMPLOYEE: Now click on the Add Employee link we get the following form for Create Employee.

 Now click on the Submit button data are saved to the employee table on the database. And we get the following 

 2 READ EMLOYEE : Now click on the List of Employee link we get the following employee list.

 3.UPDATE EMPLOYEE: for update the emloyee form we have to click on the Edit link in the table of employees show on the broswer.
we click Edit button for fifth record of table the >>

 Now update the name field value from Sweety to Sweety Rajput and salary filed value 35000 to 36000 and submit the data after submit we get the following updaed table against fifth row of table.

4.DELETE EMPLOYEE: Now we want to delete the one employee record from the table the we click on the delete button. we want to delete fifth records of the above table now click on the delete button of the corresponding records and we get the final list as below.

 Download Source code
Spring3HibernateApp.zip