Using Spring Framework with Maven

You need have Maven Java project to start with Spring Framework. I you don't have one, you can run this maven command to generate some:

mvn archetype:generate -DarchetypeArtifactId=maven-archetype-quickstart -DgroupId={project packaging} -DartifactId=TestAppSpringMvn -Dverison=1.0-SNAPSHOT

Now you can import generated project to IDE.

To start with Spring Framework you need add its artifacts to POM file. The following list contains all Spring Framework dependencies which allow you to work with Spring 3:

<!--

Core utilities used by other modules.

Define this if you use Spring Utility APIs (org.springframework.core.*/org.springframework.util.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-core</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Expression Language (depends on spring-core)

Define this if you use Spring Expression APIs (org.springframework.expression.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-expression</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Bean Factory and JavaBeans utilities (depends on spring-core)

Define this if you use Spring Bean APIs (org.springframework.beans.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-beans</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Aspect Oriented Programming (AOP) Framework (depends on spring-core, spring-beans)

Define this if you use Spring AOP APIs (org.springframework.aop.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-aop</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Application Context (depends on spring-core, spring-expression, spring-aop, spring-beans)

This is the central artifact for Spring's Dependency Injection Container and is generally always defined

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Various Application Context utilities, including EhCache, JavaMail, Quartz, and Freemarker integration

Define this if you need any of these integrations

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context-support</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Transaction Management Abstraction (depends on spring-core, spring-beans, spring-aop, spring-context)

Define this if you use Spring Transactions or DAO Exception Hierarchy

(org.springframework.transaction.*/org.springframework.dao.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-tx</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

JDBC Data Access Library (depends on spring-core, spring-beans, spring-context, spring-tx)

Define this if you use Spring's JdbcTemplate API (org.springframework.jdbc.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-jdbc</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Object-to-Relation-Mapping (ORM) integration with Hibernate, JPA, and iBatis.

(depends on spring-core, spring-beans, spring-context, spring-tx)

Define this if you need ORM (org.springframework.orm.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-orm</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Object-to-XML Mapping (OXM) abstraction and integration with JAXB, JiBX, Castor, XStream, and XML Beans.

(depends on spring-core, spring-beans, spring-context)

Define this if you need OXM (org.springframework.oxm.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-oxm</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Web application development utilities applicable to both Servlet and Portlet Environments

(depends on spring-core, spring-beans, spring-context)

Define this if you use Spring MVC, or wish to use Struts, JSF, or another web framework with Spring (org.springframework.web.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Spring MVC for Servlet Environments (depends on spring-core, spring-beans, spring-context, spring-web)

Define this if you use Spring MVC with a Servlet Container such as Apache Tomcat (org.springframework.web.servlet.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-webmvc</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Spring MVC for Portlet Environments (depends on spring-core, spring-beans, spring-context, spring-web)

Define this if you use Spring MVC with a Portlet Container (org.springframework.web.portlet.*)

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-webmvc-portlet</artifactId>

<version>${org.springframework.version}</version>

</dependency>

<!--

Support for testing Spring applications with tools such as JUnit and TestNG

This artifact is generally always defined with a 'test' scope for the integration testing framework and unit testing stubs

-->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-test</artifactId>

<version>${org.springframework.version}</version>

<scope>test</scope>

</dependency>

Now you have to define context configuration XML file. This file has contains bean declarations, but since Spring 3 support annotation-based bean declarations, the context file can also contains additional configuration such as the package paths which Spring should scan for annotation-based beans. This autoscan context file component can looks like this:

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

    <context:component-scan base-package="com.springApp.packt.maven" />

</beans>

If you using Spring in your project, you will need to write tests that require the injection of Spring Beans. Now I will show you simple example of that test:

First lets create service class:

package com.springApp.packt.maven.services;

import org.springframework.stereotype.Service;

@Service("myServiceOne")
public class MyServiceOneImpl {

    public String getA(){
        return "A";
    }

}

@Service - annotation preceding the class definition and note that the annotation contains the bean name: @Service("beanNameHere")

Before you start to create your test class, you have to add jUnit dependencies to your pom.xml file:

</dependencies>
    ...
     <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.8.1</version>
     </dependency>

  </dependencies>


Test class with one simple test looks like this:

package com.springApp.packt.maven.services;

import junit.framework.Assert;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractJUnit4SpringContextTests;

@ContextConfiguration("classpath:context.xml")
public class MyServiceOneTest extends AbstractJUnit4SpringContextTests{

    @Autowired
    private MyServiceOneImpl myServiceOne;

   @Test
   public void shoulGetA(){
       Assert.assertEquals(myServiceOne.getA(),"A");
   }

}

AbstractIUnit4SpringContextTests-initialize Spring
@ContextConfiguration - define the location of the context file for Test
@Autowired - injecting the bean


Now if you build you project by command mvn clean install, you should see short test execution raport in the end of your build process.