Integrating Spring with Struts 1x and Hibernate

Integration architecture

Struts (Web page) --- Spring DI --- Hibernate (DAO) --- Database

To integrate all those technologies together, you should : 

• Integrate Spring with Hibernate with Spring’s “LocalSessionFactoryBean” class.
• Integrate Spring with Struts via Spring’s ready make Struts plug-in – “ContextLoaderPlugIn“.

Struts, Spring and Hibernate dependency libraries

• Spring framework = spring 2.5.6, spring-web 2.5.6, spring-struts 2.0.8
• J2EE library = javaee-api 6.0
• Unit Test = junit 3.8.1
• Struts 1.3 framework = struts-core 1.3.10, struts-taglib 1.3.10, struts-extras 1.3.10
• MySQL database driver = mysql-connector-java 5.1.9
• Hibernate core = hibernate 3.2.7.ga
• Hibernate core library dependecy = dom4j 1.6.1, commons-logging 1.1.1, commons-collections 3.2.1, cglib 2.2
• Hibernate query library dependecy = antlr 2.7.7

Hibernate

Nothing much need to configure in Hibernate, just declare a customer XML mapping file and model.

Customer.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>

<class name="com.genius.customer.model.Customer" table="customer" 
       catalog="genius">

  <id name="customerId" type="long">

    <column name="CUSTOMER_ID" />

    <generator class="identity" />

  </id>

  <property name="name" type="string">

    <column name="NAME" length="45" not-null="true" />

  </property>

  <property name="address" type="string">

    <column name="ADDRESS" not-null="true" />

  </property>

  <property name="createdDate" type="timestamp">

    <column name="CREATED_DATE" length="19" not-null="true" />

  </property>

</class>

</hibernate-mapping>

Customer.java

package com.genius.customer.model;

import java.util.Date;

public class Customer implements java.io.Serializable {

  private long customerId;

  private String name;

  private String address;

  private Date createdDate;

  // getter and setter methods

}

Spring

Spring’s beans declaration for Business Object (BO) and Data Access Object (DAO). The DAO class (CustomerDaoImpl.java) is extends Spring’s “HibernateDaoSupport” class to access the Hibernate function easily.

CustomerBean.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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

<bean id="customerBo" class="com.genius.customer.bo.impl.CustomerBoImpl" >

  <property name="customerDao" ref="customerDao" />

</bean>

<bean id="customerDao" class="com.genius.customer.dao.impl.CustomerDaoImpl" >

  <property name="sessionFactory" ref="sessionFactory" />

</bean>

</beans>

CustomerBo.java

package com.genius.customer.bo;

import java.util.List;

import com.genius.customer.model.Customer;

public interface CustomerBo{

  void addCustomer(Customer customer);

  List<Customer> findAllCustomer();

}

CustomerBoImpl.java

package com.genius.customer.bo.impl;

import java.util.List;

import com.genius.customer.bo.CustomerBo;

import com.genius.customer.dao.CustomerDao;

import com.genius.customer.model.Customer;

public class CustomerBoImpl implements CustomerBo{

CustomerDao customerDao;

 public void setCustomerDao(CustomerDao customerDao) {

   this.customerDao = customerDao;

 }

 public void addCustomer(Customer customer){

   customerDao.addCustomer(customer);

 }

 public List<Customer> findAllCustomer(){

   return customerDao.findAllCustomer();

 }

}

CustomerDao.java

package com.genius.customer.dao;

import java.util.List;

import com.genius.customer.model.Customer;

public interface CustomerDao{

  void addCustomer(Customer customer);

  List<Customer> findAllCustomer();

}

CustomerDaoImpl.java

package com.genius.customer.dao.impl;

import java.util.Date;

import java.util.List;

import com.genius.customer.dao.CustomerDao;

import com.genius.customer.model.Customer;

import org.springframework.orm.hibernate3.support.HibernateDaoSupport;

public class CustomerDaoImpl extends HibernateDaoSupport  
       implements CustomerDao{

  public void addCustomer(Customer customer){

    customer.setCreatedDate(new Date());

    getHibernateTemplate().save(customer);

  }

  public List<Customer> findAllCustomer(){

    return getHibernateTemplate().find("from Customer");

  }

}

Spring + Hibernate

Declare the database details and integrate Spring and Hibernate together via “LocalSessionFactoryBean“

database.properties

jdbc.driverClassName=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql://localhost:3306/shaan

jdbc.username=root

jdbc.password=password

DataSource.xml

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

<bean 
 class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

  <property name="location">

    <value> 
     WEB-INF/classes/config/database/properties/database.properties 
   </value>

  </property>

</bean>

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">

  <property name="driverClassName" value="${jdbc.driverClassName}" />

  <property name="url" value="${jdbc.url}" />

  <property name="username" value="${jdbc.username}" />

  <property name="password" value="${jdbc.password}" />

</bean>

</beans>

HibernateSessionFactory.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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

<!-- Hibernate session factory -->

<bean id="sessionFactory" 
 class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">

  <property name="dataSource">

    <ref bean="dataSource"/>

  </property>

  <property name="hibernateProperties">

    <props>

      <prop key="hibernate.dialect">
          org.hibernate.dialect.MySQLDialect 
      </prop>

      <prop key="hibernate.show_sql">true</prop>

    </props>

  </property>

  <property name="mappingResources">

    <list>

        <value> 
          com/genius/customer/hibernate/Customer.hbm.xml
        </value>

    </list>

  </property>

</bean>

</beans>

SpringBeans.xml

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

 <!-- Database Configuration -->

 <import resource="config/database/spring/DataSource.xml"/>

 <import resource="config/database/spring/HibernateSessionFactory.xml"/>

 <!-- Beans Declaration -->

 <import resource="com/genius/customer/spring/CustomerBean.xml"/>

</beans>

Struts + Spring

To integrate Spring with Struts, you need to registering a Spring’s build-in Struts plug-in “ContextLoaderPlugIn” in struts-config.xml file. 
In Action class, it have to extends the Spring’s “ActionSupport” class, and you can get the Spring bean via getWebApplicationContext()

AddCustomerAction.java

package com.genius.customer.action;

public class AddCustomerAction extends ActionSupport{

 public ActionForward execute(ActionMapping mapping,
     ActionForm form,HttpServletRequest request,
     HttpServletResponse response) throws Exception {

   CustomerBo customerBo = 
     (CustomerBo) getWebApplicationContext().getBean("customerBo");

   CustomerForm customerForm = (CustomerForm)form;

   Customer customer = new Customer();

   // copy customerform to model

   BeanUtils.copyProperties(customer, customerForm);

   // save it

   customerBo.addCustomer(customer);

   return mapping.findForward("success");

 }

}

ListCustomerAction.java

package com.genius.customer.action;

public class ListCustomerAction extends ActionSupport {

 public ActionForward execute(ActionMapping mapping,
      ActionForm form, HttpServletRequest request,
      HttpServletResponse response) throws Exception {

   CustomerBo customerBo = 
      (CustomerBo) getWebApplicationContext().getBean("customerBo");

   DynaActionForm dynaCustomerListForm = (DynaActionForm) form;

   List<Customer> list = customerBo.findAllCustomer();

   dynaCustomerListForm.set("customerList", list);

   return mapping.findForward("success");

  }

}

CustomerForm.java

package com.genius.customer.form;

public class CustomerForm extends ActionForm {

  private String name;

  private String address;

  // getter and setter, basic validation

}

Customer.properties

#customer module label message

customer.label.name = Name

customer.label.address = Address

customer.label.button.submit = Submit

customer.label.button.reset = Reset

#customer module error message

customer.err.name.required = Name is required

customer.err.address.required = Address is required

JSP

add_customer.jsp

<%@taglib uri="http://struts.apache.org/tags-html" prefix="html"%>

<%@taglib uri="http://struts.apache.org/tags-bean" prefix="bean"%>

<html>

<head></head>

<body>

<h1>Struts + Spring + Hibernate example</h1>

<h2>Add Customer</h2>

<div style="color:red" mce_style="color:red" mce_style="color:red">

   <html:errors/>

</div>

<html:form action="/AddCustomer.do">

<div style="padding:16px" mce_style="padding:16px" mce_style="padding:16px">

<div style="float:left;width:100px;" mce_style="float:left;width:100px;" mce_style="float:left;width:100px;">

  <bean:message key="customer.label.name" /> :

</div>

  <html:text property="name" size="40" maxlength="20"/>

</div>

<div style="padding:16px" mce_style="padding:16px" mce_style="padding:16px">

<div style="float:left;width:100px;" mce_style="float:left;width:100px;" mce_style="float:left;width:100px;">

  <bean:message key="customer.label.address" /> :

</div>

  <html:textarea property="address" cols="50" rows="10"/>

</div>

<div style="padding:16px" mce_style="padding:16px" mce_style="padding:16px">

<div style="float:left;padding-right:8px;" mce_style="float:left;padding-right:8px;" mce_style="float:left;padding-right:8px;">

<html:submit>

  <bean:message key="customer.label.button.submit" />

</html:submit>

</div>

<html:reset>

  <bean:message key="customer.label.button.reset" />

</html:reset>

</div>

</html:form>

</body>

</html>

list_customer.jsp

<%@taglib uri="http://struts.apache.org/tags-html" prefix="html"%>

<%@taglib uri="http://struts.apache.org/tags-bean" prefix="bean"%>

<%@taglib uri="http://struts.apache.org/tags-logic" prefix="logic"%>

<html>

<head>

</head>

<body>

<h1>Struts + Spring + Hibernate example</h1>

<h2>List All Customers</h2>

<table border="1">

<tr><td>Customer Name</td><td>Address</td></tr>

<logic:iterate id="customer" name="dynaCustomerListForm" property="customerList">

<tr>

  <td><bean:write name="customer" property="name"/></td>

  <td><bean:write name="customer" property="address"/></td>

</tr>

</logic:iterate>

 </table>

<html:link action="/AddCustomerPage.do">Add Customer</html:link>

</body>

</html>

Struts 1x configuration

struts-config.xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE struts-config PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 1.3//EN" "http://jakarta.apache.org/struts/dtds/struts-config_1_3.dtd">

<struts-config>

  <form-beans>

   <form-bean name="customerForm" type="com.genius.customer.form.CustomerForm" />

   <form-bean name="dynaCustomerListForm" type="org.apache.struts.action.DynaActionForm">

     <form-property name="customerList" type="java.util.List"/>

   </form-bean>

  </form-beans>

  <action-mappings>

    <action path="/AddCustomerPage" 
            type="org.apache.struts.actions.ForwardAction" 
            parameter="/pages/customer/add_customer.jsp"/>

    <action path="/AddCustomer" 
            type="com.genius.customer.action.AddCustomerAction"    
            name="customerForm" validate="true" 
            input="/pages/customer/add_customer.jsp">

      <forward name="success" redirect="true" 
               path="/ListCustomer.do"/>

    </action>

    <action path="/ListCustomer" 
            type="com.genius.customer.action.ListCustomerAction" 
            name="dynaCustomerListForm">

     <forward name="success" 
              path="/pages/customer/list_customer.jsp"/>

    </action>

  </action-mappings>

  <message-resources 
          parameter="com.genius.customer.properties.Customer" />

<!-- Spring Struts plugin -->

<plug-in 
  className="org.springframework.web.struts.ContextLoaderPlugIn">

  <set-property property="contextConfigLocation" 
                value="/WEB-INF/classes/SpringBeans.xml" />

</plug-in>

</struts-config>

web.xml

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>

<display-name>Struts Hibernate Examples</display-name>

<servlet>

  <servlet-name>action</servlet-name>

  <servlet-class> 
    org.apache.struts.action.ActionServlet 
  </servlet-class>

  <init-param>

    <param-name>config</param-name>

    <param-value>/WEB-INF/struts-config.xml</param-value>

  </init-param>

  <load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

  <servlet-name>action</servlet-name>

  <url-pattern>*.do</url-pattern>

</servlet-mapping>

</web-app>

Reference