POM.xml and dependencies in Spring Boot - Mini Project: Build & Apply

POM.xml and dependencies

📖 Scenario: You are starting a new Spring Boot project to build a simple web application. To manage your project and its libraries, you will use a pom.xml file. This file tells your project which tools and libraries it needs to work properly.

🎯 Goal: Create a basic pom.xml file with the essential Spring Boot dependencies to run a web application.

📋 What You'll Learn

Create a pom.xml file with the correct project coordinates

Add the Spring Boot starter parent

Add the Spring Boot starter web dependency

Add the Spring Boot starter test dependency

💡 Why This Matters

🌍 Real World

Managing dependencies and project setup with <code>pom.xml</code> is essential for building reliable Spring Boot applications.

💼 Career

Understanding <code>pom.xml</code> files is a key skill for Java developers working with Spring Boot in professional environments.

1

Create the basic pom.xml structure

Create a pom.xml file with the root project element. Set the xmlns attribute to "http://maven.apache.org/POM/4.0.0" and the xmlns:xsi attribute to "http://www.w3.org/2001/XMLSchema-instance". Also add the xsi:schemaLocation attribute with value "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd".

Spring Boot

Hint

The project tag is the root of the pom.xml file. It needs the correct XML namespace and schema location attributes.

2

Add project coordinates and Spring Boot parent

Inside the project element, add the following child elements: modelVersion with value "4.0.0", groupId with value "com.example", artifactId with value "demo", version with value "0.0.1-SNAPSHOT", and parent element with child elements groupId "org.springframework.boot", artifactId "spring-boot-starter-parent", and version "3.0.6".

Spring Boot

Hint

These elements identify your project and set the Spring Boot starter parent to manage versions.

3

Add Spring Boot dependencies

Inside the project element, add a dependencies element. Inside it, add two dependency elements: one with groupId "org.springframework.boot", artifactId "spring-boot-starter-web"; and another with groupId "org.springframework.boot", artifactId "spring-boot-starter-test", and scope "test".

Spring Boot

  4.0.0

  
    org.springframework.boot
    spring-boot-starter-parent
    3.0.6
  

  com.example
  demo
  0.0.1-SNAPSHOT

  

Hint

Dependencies tell your project which libraries to include. The web starter is for building web apps, and the test starter is for testing.

4

Add the packaging type and final project closing

Inside the project element, add a packaging element with value "jar" to specify the output type of the project.

Spring Boot

  4.0.0

  
    org.springframework.boot
    spring-boot-starter-parent
    3.0.6
  

  com.example
  demo
  0.0.1-SNAPSHOT

  
    
      org.springframework.boot
      spring-boot-starter-web
    
    
      org.springframework.boot
      spring-boot-starter-test
      test
    
  

  

Hint

The packaging element tells Maven to build a JAR file for your project.

Practice

1. What is the main purpose of the pom.xml file in a Spring Boot project?

easy

A. To configure the web server settings

B. To manage project configuration and dependencies

C. To store database records

D. To write Java code for the application

Solution

1. Step 1: Understand the role of pom.xml

   The pom.xml file is used to organize project settings and list needed libraries.

2. Step 2: Identify what pom.xml does not do

   It does not contain Java code, database data, or server settings directly.

3. Final Answer:

   To manage project configuration and dependencies -> Option B

4. Quick Check:

   Project setup = Manage dependencies [OK]

Hint: Think of pom.xml as your project's shopping list [OK]

Common Mistakes:

• Confusing pom.xml with Java source files
• Thinking it stores runtime data
• Assuming it configures server directly

2. Which of the following is the correct way to add the Spring Boot starter web dependency in pom.xml?

easy

A. \n org.springframework.boot\n spring-boot-starter-web\n

B. \n springframework.boot\n spring-web-starter\n

C. \n org.springframework\n boot-starter-web\n

D. \n org.boot.spring\n starter-web\n

Solution

1. Step 1: Check the correct groupId and artifactId for Spring Boot web starter

   The official groupId is org.springframework.boot and artifactId is spring-boot-starter-web.

2. Step 2: Compare options to official naming

   Only \n org.springframework.boot\n spring-boot-starter-web\n matches the exact correct groupId and artifactId.

3. Final Answer:

   Correct dependency XML with org.springframework.boot and spring-boot-starter-web -> Option A

4. Quick Check:

   Correct groupId/artifactId = \n org.springframework.boot\n spring-boot-starter-web\n [OK]

Hint: Remember exact spelling of groupId and artifactId [OK]

Common Mistakes:

• Swapping groupId and artifactId
• Misspelling 'spring-boot-starter-web'
• Using wrong groupId like 'springframework.boot'

3. Given this pom.xml snippet, what will happen when you run mvn clean install?

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

medium

A. Only the JPA API will be included, no implementation

B. The project will fail because version is missing

C. The project will include JPA support and related libraries automatically

D. The dependency will be ignored without a scope tag

Solution

1. Step 1: Understand Spring Boot starter dependencies

   Spring Boot starters manage versions internally, so explicit version is not needed if parent is set.

2. Step 2: Recognize what spring-boot-starter-data-jpa provides

   It includes JPA API and an implementation like Hibernate automatically.

3. Final Answer:

   The project will include JPA support and related libraries automatically -> Option C

4. Quick Check:

   Spring Boot starters handle versions and implementations [OK]

Hint: Spring Boot starters bundle needed libs and versions [OK]

Common Mistakes:

• Thinking version tag is always required
• Assuming only API without implementation
• Believing scope tag is mandatory for dependencies

4. You added this dependency to your pom.xml but get a build error:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <version>2.3.0.RELEASE</version>
</dependency>

What is the likely cause?

medium

A. Incorrect groupId spelling

B. Missing scope tag causes build failure

C. Dependency must be in build section, not dependencies

D. Version conflicts because Spring Boot parent manages versions

Solution

1. Step 1: Understand Spring Boot parent version management

   Spring Boot starter parent manages dependency versions automatically.

2. Step 2: Identify problem with manually specifying version

   Manually adding version can cause conflicts and build errors.

3. Final Answer:

   Version conflicts because Spring Boot parent manages versions -> Option D

4. Quick Check:

   Let parent manage versions to avoid conflicts [OK]

Hint: Avoid manual versions if using Spring Boot starter parent [OK]

Common Mistakes:

• Adding version manually when parent manages it
• Thinking scope is required for starters
• Misplacing dependencies outside dependencies

5. You want to add a custom library that is not in Maven Central to your Spring Boot project. Which is the best way to include it in your pom.xml?

hard

A. Upload the library to a remote repository and add its repository URL and dependency with version

B. Install the library in your local Maven repository and add a dependency without version

C. Add the library jar directly to your project and reference it in pom.xml with system scope

D. Add the dependency with a fake groupId and artifactId to trick Maven

Solution

1. Step 1: Understand how Maven resolves dependencies

   Maven downloads dependencies from repositories defined in pom.xml or local repo.

2. Step 2: Identify best practice for custom libraries

   Uploading to a remote repository and adding its URL in pom.xml is clean and maintainable.

3. Step 3: Why other options are less ideal

   Local install requires manual setup; system scope is discouraged; fake IDs cause errors.

4. Final Answer:

   Upload the library to a remote repository and add its repository URL and dependency with version -> Option A

5. Quick Check:

   Use remote repo for custom libs [OK]

Hint: Use remote repo URLs for custom dependencies [OK]

Common Mistakes:

• Using system scope which is deprecated
• Skipping repository URL for custom libs
• Not specifying version for custom dependencies