Time for action – adding Spring jars to the project
Let's take a look at how we can add the spring-related jars via the Maven configuration:
- Open
pom.xml
; you can findpom.xml
under the root directory of the project itself. - You will see some tabs at the bottom of the
pom.xml
file. If you do not see these tabs, then right-click onpom.xml
and select the Open With option from the context menu and choose Maven POM editor. Select the Dependencies tab and click on the Add button in the Dependencies section. Don't get confused with the Add button of the Dependencies Management section. You should choose the Add button in the left-hand side pane. - A Select Dependency window will appear; enter Group Id as
org.springframework
, Artifact Id asspring-webmvc
, and Version as4.0.3.RELEASE
. Select Scope ascompile
and then click on the OK button, as shown in the following screenshot: - Similarly, add the dependency for JavaServer Pages Standard Tag Library (JSTL) by clicking on the same Add button; this time, enter Group Id as
javax.servlet
, Artifact Id asjstl
, Version as1.2
, and select Scope ascompile
. - Finally, add one more dependency for servlet-api; repeat the same step with Group Id as
javax.servlet
, Artifact Id asjavax.servlet-api
, and Version as3.1.0
, but this time, select Scope asprovided
and then click on the OK button. - As a last step, don't forget to save the
pom.xml
file.
What just happened?
In the Maven world, pom.xml
(Project Object Model) is the configuration file that defines the required dependencies. While building our project, Maven will read that file and try to download the specified jars from the Maven central binary repository. You need Internet access in order to download jars from Maven's central repository. Maven uses an addressing system to locate a jar in the central repository, which consists of Group Id, Artifact Id, and Version.
Every time we add a dependency, an entry will be made within the <dependencies> </ dependencies>
tags in the pom.xml
file. For example, if you go to the pom.xml tab after finishing step 3, you will see an entry for spring-mvc
as follows within the <dependencies> </ dependencies>
tag:
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>4.0.3.RELEASE</version> </dependency>
We added the dependency for spring-mvc in step 3, and in step 4, we added the dependency for JSTL. JSTL is a collection of useful JSP tags that can be used to write JSP pages easily. Finally, we need a servlet-api jar in order to use servlet-related code; this is what we added in step 5.
However, there is a little difference in the scope of the servlet-api dependency compared to the other two dependencies. We only need servlet-api while compiling our project. While packaging our project as war
, we don't want to the ship servlet-api jar as part of our project. This is because the Tomcat web server would provide the servlet-api jar while deploying our project. This is why we selected the scope as provided for the servlet-api.
After finishing step 6, you will see all the dependent jars configured in your project, as shown in the following screenshot, under the Maven Dependencies library:
We added only three jars as our dependencies, but if you notice in our Maven dependency library list, you will see more than three jar entries. Can you guess why? What if our dependent jars have a dependency on other jars and so on?
For example, our spring-mvc jar is dependent on the spring-core, spring-context, and spring-aop jars, but we have not specified those jars in our pom.xml
file; this is called transitive dependencies in the Maven world. In other words, we can say that our project is transitively dependent on these jars. Maven will automatically download all these transitive dependent jars; this is the beauty of Maven. It will take care of all the dependency management automatically; we need to inform Maven only about the first level dependencies.