Igor Kromin |   Consultant. Coder. Blogger. Tinkerer. Gamer.

I've written articles about building web services using Maven in the past as well as various other articles to do with Maven in general. This time I want to cover how Maven's dependency mechanism relates to WAR file packaging, specifically to the WEB-INF/lib directory.

I'm going to use JUnit as the dependency since it is pretty much guaranteed to be available in any Maven repository. Hence, my dependency inside the pom.xml is defined like this (minus the scope element)...
 pom.xml
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>


There are 5 dependency scopes available (actually 6 but the import scope is not of interest here). The default scope is compile. Taking each of the scopes into account this is what will be packaged inside the WEB-INF/lib directory inside the WAR file when each of the scopes is used...

Scopes: compile, runtime:
mvndep_compile_runtime.png


For the compile and runtime scopes, the WEB-INF/lib directory will contain the JAR files of the dependencies as well as any dependencies that the project's dependencies have that use a transient scope. For example since JUnit depends on Hamcrest Core, both the junit-4.12.jar and hamcrest-core-1.3.jar files are included in the WEB-INF/lib directory.



Scopes: provided, test, system:
mvndep_provided_test_system.png


For the provided, test and system scopes the WEB-INF/lib directory will not contain JAR files of the dependencies. In this case the WEB-INF/lib directory is not created at all since there aren't any other JARs are inside it.

As a side note - NEVER use the system scope in a J2EE project unless there is a really good reason for it (usually there isn't).

-i

Did you like this post or found it useful? Considering supporting this Blog to keep its web servers running, any amount helps! Thanks!
Have comments or feedback on what I wrote? Please share them below!
comments powered by Disqus
Other posts you may like...