Project structure walkthrough in Spring Boot - Performance & Optimization

Performance: Project structure walkthrough

MEDIUM IMPACT

This affects the initial load time and maintainability of the application by organizing code and resources efficiently.

Organizing source code and resources in a Spring Boot project

Spring Boot

src/main/java/com/example/app/Application.java
src/main/java/com/example/app/controller/UserController.java
src/main/java/com/example/app/service/UserService.java
src/main/java/com/example/app/repository/UserRepository.java
src/main/resources/application.properties
src/main/resources/static/css/style.css
src/main/resources/templates/index.html

// Files organized by layer and feature for clarity and faster builds.

Clear separation allows build tools to optimize compilation and resource processing, improving load speed and developer productivity.

📈 Performance GainReduces build time by up to 20%; improves incremental compilation and resource caching.

Organizing source code and resources in a Spring Boot project

Spring Boot

src/main/java/com/example/app/Application.java
src/main/java/com/example/app/UserService.java
src/main/java/com/example/app/UserController.java
src/main/resources/application.properties
src/main/resources/static/css/style.css
src/main/resources/templates/index.html

// All files placed in a single flat folder without separation by layers or features.

Mixing all files in one folder causes slower build times and harder maintenance due to lack of clear separation.

📉 Performance CostIncreases build time by 10-20% on medium projects; harder caching and resource loading.

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Flat folder structure mixing all files	N/A	N/A	N/A	[X] Bad
Organized by layer and feature	N/A	N/A	N/A	[OK] Good

Rendering Pipeline

The project structure influences how build tools process source files and resources, affecting the critical rendering path by controlling what gets compiled and loaded first.

→Build Time

→Resource Loading

→Caching

⚠️ BottleneckBuild Time due to inefficient file organization and resource duplication

Core Web Vital Affected

LCP

This affects the initial load time and maintainability of the application by organizing code and resources efficiently.

Optimization Tips

1Organize source files by feature and layer to speed up builds.

2Keep resources like CSS and templates in dedicated folders for efficient loading.

3Avoid mixing unrelated files in the same folder to reduce build and load times.

Performance Quiz - 3 Questions

How does a well-organized Spring Boot project structure affect build time?

A It increases build time due to more files.

B It reduces build time by enabling incremental compilation.

C It has no effect on build time.

D It slows down resource loading in the browser.

DevTools: Network

How to check: Open DevTools > Network tab, reload the app, and observe resource loading order and size.

What to look for: Look for unnecessary or duplicated resource loads that indicate poor project structure or resource management.

Practice

1. In a typical Spring Boot project, where should you place your main application Java files?

easy

A. src/resources/java

B. src/main/resources

C. src/test/java

D. src/main/java

Solution

1. Step 1: Understand Spring Boot folder roles

   The src/main/java folder is for main Java source code including the application entry point.

2. Step 2: Identify correct folder for main Java files

   Main application files should not be in resources or test folders, so src/main/java is correct.

3. Final Answer:

   src/main/java -> Option D

4. Quick Check:

   Main Java code = src/main/java [OK]

Hint: Main Java code always goes under src/main/java [OK]

Common Mistakes:

• Confusing resources folder with Java source folder
• Placing main code in test folder
• Using incorrect folder names like src/resources/java

2. Which file is commonly used to manage dependencies and build steps in a Spring Boot Maven project?

easy

A. pom.xml

B. application.properties

C. build.gradle

D. settings.xml

Solution

1. Step 1: Identify build tool for Maven projects

   Maven uses pom.xml to manage dependencies and build configuration.

2. Step 2: Differentiate from Gradle and config files

   build.gradle is for Gradle, application.properties is for app config, and settings.xml is not for dependencies.

3. Final Answer:

   pom.xml -> Option A

4. Quick Check:

   Maven build file = pom.xml [OK]

Hint: Maven uses pom.xml; Gradle uses build.gradle [OK]

Common Mistakes:

• Confusing application.properties with build files
• Mixing Gradle and Maven build files
• Thinking settings.xml manages dependencies

3. Given this Spring Boot project structure snippet, where will the test Java files be located?

src/
  main/
    java/
    resources/
  test/
    java/
    resources/

medium

A. src/main/resources

B. src/test/java

C. src/main/java

D. src/test/resources

Solution

1. Step 1: Understand test folder purpose

   The src/test/java folder is for Java test source files.

2. Step 2: Identify test Java files location

   Test Java files go under src/test/java, not in main or resources folders.

3. Final Answer:

   src/test/java -> Option B

4. Quick Check:

   Test Java code = src/test/java [OK]

Hint: Test Java files go in src/test/java folder [OK]

Common Mistakes:

• Putting test Java files in src/main/java
• Confusing test resources with test Java code
• Using src/main/resources for tests

4. You accidentally placed your application.properties file inside src/main/java. What problem will this cause?

medium

A. The application will fail to start due to missing config

B. The build will fail with a syntax error

C. The properties file will be ignored and default config used

D. The application.properties will be loaded correctly anyway

Solution

1. Step 1: Know where Spring Boot loads config files

   Spring Boot loads application.properties from src/main/resources or classpath root.

2. Step 2: Effect of wrong file location

   If placed in src/main/java, it won't be found and ignored, so defaults apply.

3. Final Answer:

   The properties file will be ignored and default config used -> Option C

4. Quick Check:

   Config files must be in resources, else ignored [OK]

Hint: Config files must be in resources folder to load [OK]

Common Mistakes:

• Assuming app fails to start immediately
• Thinking build fails due to config file location
• Believing misplaced properties still load

5. You want to add a new configuration file for your Spring Boot app that should be packaged inside the jar and accessible at runtime. Where should you place this file?

hard

A. src/main/resources/config

B. src/main/java/config

C. src/test/resources/config

D. src/main/resources/static

Solution

1. Step 1: Understand resource packaging in Spring Boot

   Files in src/main/resources are packaged inside the jar and available at runtime.

2. Step 2: Choose correct folder for config files

   Config files should be under src/main/resources/config to be included and organized.

3. Final Answer:

   src/main/resources/config -> Option A

4. Quick Check:

   Runtime config files go in src/main/resources [OK]

Hint: Put runtime config files in src/main/resources folder [OK]

Common Mistakes:

• Placing config files in src/main/java which is for code
• Using test resources folder which is not packaged
• Putting config in static folder meant for web assets