Spring 3 Hello World Example / Tutorial using Maven Tool and Eclipse IDE

你的名字 2022-08-26 12:20 171阅读 0赞

# Spring 3 Hello World Example / Tutorial using Maven Tool and Eclipse IDE #

26,905 views

By [ Abhijit Ghosh][Abhijit Ghosh] on 2012-9-2 15:01:57

This tutorial will help you to write your first Hello World Spring program. We will use Maven tool to generate the project and Eclipse IDE to implement a method which will print 'Hello World!' in the console.

Tools and Technologies used in this article :

1.  Spring 3.1
2.  Maven
3.  JDK 1.6
4.  Eclipse 3.7

**Note :** Spring 3 requires at least JDK 5. So, make sure you have JDK 5 or above.

**Download :**

*  [Spring Framework][]
 *  [Maven][]

## 1. Create a Java Project using Maven Tool ##

In the command prompt execute the following command to generate Maven compatible Java project named as 'SpringCoreHelloWorld'.

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>mvn archetype:generate -DgroupId=com.srccodes.example.spring -DartifactId=SpringCoreHelloWorld -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=</code> 
      <code>false</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

*Generated Maven Java Project structure*

![Maven Java Project structure][]

## 2. Update pom.xml ##

Add dependency of Spring core and context.

*File : pom.xml*

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>project</code> 
      <code>xmlns</code> 
      <code>=</code> 
      <code>"<a href="http://maven.apache.org/POM/4.0.0" rel="nofollow">http://maven.apache.org/POM/4.0.0</a>"</code> 
      <code>xmlns:xsi</code> 
      <code>=</code> 
      <code>"<a href="http://www.w3.org/2001/XMLSchema-instance" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a>"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>xsi:schemaLocation</code> 
      <code>=</code> 
      <code>"<a href="http://maven.apache.org/POM/4.0.0" rel="nofollow">http://maven.apache.org/POM/4.0.0</a> <a href="http://maven.apache.org/maven-v4_0_0.xsd" rel="nofollow">http://maven.apache.org/maven-v4_0_0.xsd</a>"</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>modelVersion</code> 
      <code>&gt;4.0.0&lt;/</code> 
      <code>modelVersion</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;com.srccodes.example.spring&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;SpringCoreHelloWorld&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>packaging</code> 
      <code>&gt;jar&lt;/</code> 
      <code>packaging</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.0-SNAPSHOT&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>name</code> 
      <code>&gt;SpringCoreHelloWorld&lt;/</code> 
      <code>name</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>url</code> 
      <code>&gt;<a href="http://maven.apache.org/" rel="nofollow">http://maven.apache.org</a>&lt;/</code> 
      <code>url</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>properties</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>org.springframework-version</code> 
      <code>&gt;3.1.1.RELEASE&lt;/</code> 
      <code>org.springframework-version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>properties</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>dependencies</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-context&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;${org.springframework-version}&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-core&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;${org.springframework-version}&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;junit&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;junit&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;3.8.1&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>scope</code> 
      <code>&gt;test&lt;/</code> 
      <code>scope</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>dependencies</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>project</code> 
      <code>&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## 3. Convert to Eclipse compatible Java project ##

Open the directory 'SpringCoreHelloWorld' in command prompt and run the following maven command.

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>mvn eclipse:eclipse</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

*Screenshot of command prompt*

![Maven Java Project][]

On completion of the above command, Maven Java project will be converted to Eclipse compatible java project.

*Eclipse compatible Java Project structure*

![Eclipse Java Project][]

## 4. Import project in Eclipse ##

Open Eclipse IDE and select from the menu File --> Import --> General --> Existing Projects into Workspace

![Existing Projects into Workspace][]

Browse to the directory of the newly converted Eclipse compatible Java Project and click 'Finish' button.

![Browse project][]

*Screenshot of Eclipse project structure*

![Eclipse project structure][]

## 5. Write Spring bean ##

Create a class 'SpringCoreHelloWorld' under the package 'com.srccodes.example.spring' and copy the following content.

[?][Link 1]

We will use Spring framework to get the instance of this class from Spring runtime and call the 'sayHello()' method to print 'Hello World!' message in the console.

**Note :**   
Though Interface based implementation is advisable in Spring Framework, we have not written any interface for our bean class 'SpringCoreHelloWorld'to keep it simple for our first Spring Hello World program.

## 6. Add Spring Application context Configuration file ##

Right click on 'main' and select from context menu 'New' --> 'Folder'.

![new folder][]

Enter 'resources' in the 'Folder name' field and click the 'Finish' button.

![resources folder][]

Copy the 'springApplicationContext.xml' file in the 'resources' folder.

*File: springApplicationContext.xml*

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;?</code> 
      <code>xml</code> 
      <code>version</code> 
      <code>=</code> 
      <code>"1.0"</code> 
      <code>encoding</code> 
      <code>=</code> 
      <code>"UTF-8"</code> 
      <code>?&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>beans</code> 
      <code>xmlns</code> 
      <code>=</code> 
      <code>"<a href="http://www.springframework.org/schema/beans" rel="nofollow">http://www.springframework.org/schema/beans</a>"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>xmlns:xsi</code> 
      <code>=</code> 
      <code>"<a href="http://www.w3.org/2001/XMLSchema-instance" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a>"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>xsi:schemaLocation="<a href="http://www.springframework.org/schema/beans" rel="nofollow">http://www.springframework.org/schema/beans</a> </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code><a href="http://www.springframework.org/schema/beans/spring-beans-3.1.xsd" rel="nofollow">http://www.springframework.org/schema/beans/spring-beans-3.1.xsd</a>"&gt;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>bean</code> 
      <code>id</code> 
      <code>=</code> 
      <code>"helloWorldBean"</code> 
      <code>class</code> 
      <code>=</code> 
      <code>"com.srccodes.example.spring.SpringCoreHelloWorld"</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>property</code> 
      <code>name</code> 
      <code>=</code> 
      <code>"message"</code> 
      <code>value</code> 
      <code>=</code> 
      <code>"Hello World!"</code> 
      <code>/&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>bean</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>beans</code> 
      <code>&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

**Note :**   
We have used Spring's *setter injection* to pass our message 'Hello World!' to 'setMessage' method of 'SpringCoreHelloWorld'. This message is printed by the 'sayHello()' method.

## 7. Configure Java Build Path ##

Right click on 'SpringCoreHelloWorld' project and select from context menu 'Properties' --> 'Java Build Path'.  
Add 'resources' folder as shown in the screenshot below

![Java Build Path][]

## 8. Code to interact with Spring's application context ##

Copy the following code to 'App' class of package 'com.srccodes.example.spring'.

[?][Link 1]

## 9. Final project structure ##

After doing all the changes the overall project structure will look like this

![overall project structure][]

## 10. Run Your Code ##

Right click on 'App.java' and select from context menu 'Run As' --> 'Java Application'.

## 11. Console Output ##

*Console*

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>Sep 2, 2012 9:01:13 PM org.springframework.context.support.AbstractApplicationContext prepareRefresh</code> 
     </div> 
     <div> 
      <code>INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@145d068: startup </code> 
      <code>date</code> 
      <code>[Sun Sep 02 21:01:13 IST 2012]; root of context hierarchy</code> 
     </div> 
     <div> 
      <code>Sep 2, 2012 9:01:13 PM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions</code> 
     </div> 
     <div> 
      <code>INFO: Loading XML bean definitions from class path resource [springApplicationContext.xml]</code> 
     </div> 
     <div> 
      <code>Sep 2, 2012 9:01:14 PM org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons</code> 
     </div> 
     <div> 
      <code>INFO: Pre-instantiating singletons </code> 
      <code>in</code> 
      <code>org.springframework.beans.factory.support.DefaultListableBeanFactory@f11404: defining beans [helloWorldBean]; root of factory hierarchy</code> 
     </div> 
     <div> 
      <code>Hello World!</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## Download Source Code ##

***SrcCodes*** : [ SpringCoreHelloWorld.zip][SpringCoreHelloWorld.zip]

[Abhijit Ghosh]: http://www.srccodes.com/p/user/1/abhijit-ghosh
[Spring Framework]: http://www.springsource.org/download/
[Maven]: http://maven.apache.org/download.html
[Link 1]: http://www.srccodes.com/p/article/11/spring-3-hello-world-example-tutorial-using-maven-tool-and-eclipse-ide#
[Maven Java Project structure]: 
[Maven Java Project]: /images/20220824/237447b8fe9b4143a21140fbfb2025f6.png
[Eclipse Java Project]: /images/20220824/c83ac4ce21654ccaa170f929fe06f14f.png
[Existing Projects into Workspace]: /images/20220824/96cdb3de59c3427880e795d0a3048519.png
[Browse project]: /images/20220824/0ad55d0683ec4f118b6c36f53a73c464.png
[Eclipse project structure]: /images/20220824/5f43505fe2434ac3864e446ca2a4e718.png
[new folder]: /images/20220824/e73b1378f5eb4ba39913c7df53dfcba1.png
[resources folder]: /images/20220824/8182ded91aeb4f09bd82d08891399a2d.png
[Java Build Path]: /images/20220824/706c793692a64139bfe8ac4e8a5ce73e.png
[overall project structure]: /images/20220824/607d039a7f9640049a2d60a30c6a5225.png
[SpringCoreHelloWorld.zip]: http://cdn.srccodes.com/c/092012/11/SpringCoreHelloWorld.zip