Struts - Spring - Hibernate Integration Tutorial Part 2 (Java-Based and Annotations)

Welcome to the second part of the Struts - Spring - Hibernate integration tutorial series! In the first part, I guided you how to build a Struts - Spring - Hibernate project with XML configuration. In this second part, you will build a project with the same functionality but with Java-based code and annotations. There is no XML at all! Absolutely no XML!

NOTE: For detailed information about database setup and all Maven dependencies, please consult Struts - Spring - Hibernate Integration Tutorial part 1 (XML configuration).

1. Adding Maven Dependencies

To allow using annotations for mapping Struts action classes, the Struts2 Convention Plugin is required. Put the following dependency into your pom.xml file:

<dependency>
	<groupId>org.apache.struts</groupId>
	<artifactId>struts2-convention-plugin</artifactId>
	<version>${org.strutsframework-version}</version>
</dependency>

For the complete list of Maven dependencies, refer to part 1, or consult the sample project under the Attachments section.

2. Annotating the Model Class

We use JPA annotations for annotating the model class (Product.java) like the following code snippet:

/**
 * Copyright CodeJava.net To Present
 * All rights reserved.
 */
package net.codejava.framework.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name = "product")
public class Product {
	private long id;
	private String name;
	private String description;
	private float price;

	@Id
	@GeneratedValue
	@Column(name = "PRODUCT_ID")
	public long getId() {
		return id;
	}

	// other getters and setters

}

As you can see, using annotations is more convenient and succinct than XML. If you are new to Hibernate annotations, I recommend you read the Getting Started With Hibernate Annotations tutorial later.

3. Annotating Struts Action Class

Now, instead of using Struts XML configuration file (struts.xml), we use annotations for mapping the Struts action class. The following code is the updated version of the ListProductAction class:

/** 
 * Copyright CodeJava.net To Present
 * All rights reserved. 
 */
package net.codejava.framework.action;

import java.util.List;

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.ResultPath;
import org.springframework.beans.factory.annotation.Autowired;

import net.codejava.framework.dao.ProductDAO;
import net.codejava.framework.model.Product;

import com.opensymphony.xwork2.ActionSupport;

@Action("listProduct")
@ResultPath("/WEB-INF/views")
@Result(name = "success", location = "ProductList.jsp")
public class ListProductAction extends ActionSupport {
	
	@Autowired
	private ProductDAO productDAO;
	
	private List<Product> listProduct;

	public String execute() {
		listProduct = productDAO.list();
		return SUCCESS;
	}

	public List<Product> getListProduct() {
		return listProduct;
	}
}

Again, as you can see, using annotations is very convenient. This action class handles the URL pattern /listProduct, and the view SUCCESS is resolved to the ProductList.jsp file which can be found under the /WEB-INF/views directory.

Note that the action method invokes the list() method from a ProductDAO implementation which is injected by Spring, hence the annotation:

@Autowired
private ProductDAO productDAO;

If you are new to Struts annotations, I suggest you to read the Struts Beginner Tutorial with Annotations tutorial.

NOTE: The DAO implementation (ProductDAOImpl.java) is unchanged as compared to the part 1.

4. Integrating Struts, Spring and Hibernate Together Programmatically

This is the most interesting and difficult part of the integration, because if you did something wrong, the application would not start.

Instead of putting XML code into web.xml or Spring XML configuration file, you can take advantage of the code-based approach.

First, we need to bootstrap the Struts and Spring framework together. This can be done by writing a Java class that looks something like this:

/** Copyright CodeJava.net To Present
All rights reserved. 
 */
package net.codejava.framework.config;

import java.util.EnumSet;

import javax.servlet.DispatcherType;
import javax.servlet.FilterRegistration;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;

import org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter;
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.ContextLoaderListener;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;

public class WebAppInitializer implements WebApplicationInitializer {

	@Override
	public void onStartup(ServletContext servletContext) throws ServletException {
		AnnotationConfigWebApplicationContext appContext = new AnnotationConfigWebApplicationContext();
		appContext.register(ApplicationContextConfig.class);

		ContextLoaderListener contextLoaderListener = new ContextLoaderListener(
				appContext);
		servletContext.addListener(contextLoaderListener);

		FilterRegistration.Dynamic filter = servletContext.addFilter(
				"StrutsDispatcher", new StrutsPrepareAndExecuteFilter());
		filter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST),
				true, "/*");
	}

}

When the application starts up, Struts is loaded as the primary filter dispatcher which intercepts all requests coming through the application. And Spring is loaded alongside Struts as a context listener. Spring will look for and instantiate beans declared in the ApplicationContextConfig file which is described next.

And here is code of the ApplicationContextConfig class:

/** Copyright CodeJava.net To Present
All rights reserved. 
*/
package net.codejava.framework.config;

import javax.sql.DataSource;

import net.codejava.framework.dao.ProductDAO;
import net.codejava.framework.dao.ProductDAOImpl;
import net.codejava.framework.model.Product;

import org.apache.commons.dbcp2.BasicDataSource;
import org.hibernate.SessionFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.orm.hibernate4.HibernateTransactionManager;
import org.springframework.orm.hibernate4.LocalSessionFactoryBuilder;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@ComponentScan("net.codejava.framework")
@EnableTransactionManagement
public class ApplicationContextConfig {

	@Bean(name = "dataSource")
	public DataSource getDataSource() {
	    BasicDataSource dataSource = new BasicDataSource();
	    dataSource.setDriverClassName("com.mysql.jdbc.Driver");
	    dataSource.setUrl("jdbc:mysql://localhost:3306/productsdb");
	    dataSource.setUsername("root");
	    dataSource.setPassword("P@ssw0rd");
	 
	    return dataSource;
	}
	
	@Autowired
	@Bean(name = "sessionFactory")
	public SessionFactory getSessionFactory(DataSource dataSource) {
	 
	    LocalSessionFactoryBuilder sessionBuilder = new LocalSessionFactoryBuilder(dataSource);
	 
	    sessionBuilder.addAnnotatedClasses(Product.class);
	 
	    return sessionBuilder.buildSessionFactory();
	}
	
	@Autowired
	@Bean(name = "transactionManager")
	public HibernateTransactionManager getTransactionManager(
	        SessionFactory sessionFactory) {
	    HibernateTransactionManager transactionManager = new HibernateTransactionManager(
	            sessionFactory);
	 
	    return transactionManager;
	}	
	
	@Autowired
	@Bean(name = "productDAO")
	public ProductDAO getProductDAO(SessionFactory sessionFactory) {
		return new ProductDAOImpl(sessionFactory);
	}
}

This class is the last piece of the whole integration picture, as it makes Struts, Spring and Hibernate fully integrated together and working seamlessly. This class does most of the tasks of Spring and Hibernate integration by specifying data source, session factory and transaction manager for the session which is used by the DAO implementation.

If you are curious and want to learn more about this, here are two great resources you can refer:

• Bootstrapping a Spring Web MVC application programmatically
• Spring and Hibernate Integration Tutorial Part 2: Java-based Configuration

5. Reviewing Project Structure

That’s all! So far I have discussed all the necessary stuffs in order to successfully integrate Struts, Spring and Hibernate in a Java web application. It’s time to review the project structure (Eclipse project), for your reference:

To test out the sample application, download the Eclipse project attached below.

Read Part 1: Struts - Spring - Hibernate Integration Tutorial Part 1 - XML Configuration

Other Struts Tutorials:

• Introduction to Struts framework
• Struts beginner tutorial (Eclipse + Tomcat + XML)
• Struts Beginner Tutorial with Annotations
• Struts beginner tutorial with Convention Plugin (zero-configuration)
• How to handle exceptions in Struts
• Struts Form Handling Tutorial
• Struts Form Validation Tutorial
• Send e-mail with attachments in Struts
• Struts File Download Tutorial

About the Author:

Nam Ha Minh is certified Java programmer (SCJP and SCWCD). He began programming with Java back in the days of Java 1.4 and has been passionate about it ever since. You can connect with him on Facebook and watch his Java videos on YouTube.

Attachments:

Struts2Spring4Hibernate4Annotations.zip

[Struts - Spring - Hibernate Integration Sample Project]

26 kB