How auto-configuration works in Spring Boot

Introduction

Auto-configuration helps your Spring Boot app set up common features automatically. It saves you time by guessing what you need based on what is in your project.

When you want to quickly start a web app without writing setup code.

When you add a database library and want Spring Boot to configure it for you.

When you want to use security features without manual setup.

When you want to avoid writing boilerplate configuration files.

When you want your app to adapt automatically as you add new libraries.

Syntax

Spring Boot

Spring Boot uses special files named spring.factories or META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
These files list classes that provide auto-configuration.
Spring Boot loads these classes if certain conditions are met.

Auto-configuration classes use @Configuration and @Conditional annotations to decide if they should run.

You can disable specific auto-configurations using @SpringBootApplication(exclude = {ClassName.class}) or properties.

Examples

This basic app uses auto-configuration to set up many things automatically.

Spring Boot

@SpringBootApplication
public class MyApp {
  public static void main(String[] args) {
    SpringApplication.run(MyApp.class, args);
  }
}

This disables the auto-configuration for database setup.

Spring Boot

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class MyApp {
  public static void main(String[] args) {
    SpringApplication.run(MyApp.class, args);
  }
}

Auto-configuration classes check if certain classes exist before running.

Spring Boot

@Configuration
@ConditionalOnClass(DataSource.class)
public class DataSourceAutoConfiguration {
  // configures DataSource bean if DataSource class is on classpath
}

Sample Program

This simple Spring Boot app uses auto-configuration to start a web server automatically. You don't write any server setup code. When you run it, it listens on port 8080 and responds with a greeting.

Spring Boot

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

@RestController
class HelloController {
    @GetMapping("/")
    public String hello() {
        return "Hello, Spring Boot!";
    }
}

Important Notes

Auto-configuration runs after your own configuration, so you can override defaults.

Use @Conditional annotations to create your own auto-configurations.

Check the Spring Boot docs for the list of auto-configured features.

Summary

Auto-configuration sets up common features automatically based on your project.

It uses special classes and conditions to decide what to configure.

You can disable or customize auto-configuration easily.

Practice

1. What is the main purpose of Spring Boot's auto-configuration feature?

easy

A. To disable all default Spring features

B. To require manual configuration of all beans and settings

C. To force the use of XML configuration files

D. To automatically set up common configurations based on project dependencies

Solution

1. Step 1: Understand auto-configuration role

   Auto-configuration helps by setting up default configurations automatically when certain dependencies are present.

2. Step 2: Compare options

   Options A, B, and D contradict the purpose of auto-configuration, which is to reduce manual setup, not increase it or disable features.

3. Final Answer:

   To automatically set up common configurations based on project dependencies -> Option D

4. Quick Check:

   Auto-configuration = automatic setup [OK]

Hint: Auto-configuration means less manual setup [OK]

Common Mistakes:

• Thinking auto-configuration disables features
• Assuming all configuration must be manual
• Confusing auto-configuration with XML config

2. Which annotation enables Spring Boot's auto-configuration in a main application class?

easy

A. @SpringBootApplication

B. @EnableAutoConfig

C. @AutoConfigEnabled

D. @ConfigurationAuto

Solution

1. Step 1: Identify the correct annotation

   @SpringBootApplication is a meta-annotation that includes @EnableAutoConfiguration, enabling auto-configuration.

2. Step 2: Verify other options

   Options B, C, and D are not valid Spring Boot annotations and will cause errors.

3. Final Answer:

   @SpringBootApplication -> Option A

4. Quick Check:

   @SpringBootApplication enables auto-config [OK]

Hint: Use @SpringBootApplication for auto-config [OK]

Common Mistakes:

• Using non-existent annotations
• Forgetting @SpringBootApplication on main class
• Confusing with @Configuration only

3. Given this Spring Boot application snippet, what will happen if spring-boot-starter-web is on the classpath?

@SpringBootApplication
public class DemoApplication {
  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

medium

A. Spring Boot auto-configures a web server and MVC setup

B. No web server is configured automatically

C. Application fails to start due to missing annotations

D. Only a command-line runner is configured

Solution

1. Step 1: Check classpath dependency effect

   Presence of spring-boot-starter-web triggers auto-configuration of embedded web server and MVC components.

2. Step 2: Analyze application code

   The main class is annotated with @SpringBootApplication, enabling auto-configuration which activates for web components due to the starter-web dependency.

3. Final Answer:

   Spring Boot auto-configures a web server and MVC setup -> Option A

4. Quick Check:

   Web starter on classpath = web auto-config [OK]

Hint: Web starter triggers web server auto-config [OK]

Common Mistakes:

• Ignoring the effect of dependencies on auto-config
• Assuming no server without explicit config
• Forgetting @SpringBootApplication annotation

4. What is the likely cause of this error in a Spring Boot app?

@SpringBootApplication
public class App {
  public static void main(String[] args) {
    SpringApplication.run(App.class, args);
  }
}

// Error: No qualifying bean of type 'DataSource' available

medium

A. Incorrect main method signature

B. Auto-configuration is disabled by default

C. Missing database driver dependency causing auto-config to fail

D. Spring Boot does not support DataSource auto-configuration

Solution

1. Step 1: Understand DataSource error

   Spring Boot tries to auto-configure a DataSource but fails if no driver dependency is found.

2. Step 2: Check other options

   Main method is correct, auto-configuration is enabled by default, and Spring Boot supports DataSource auto-config.

3. Final Answer:

   Missing database driver dependency causing auto-config to fail -> Option C

4. Quick Check:

   Missing driver = DataSource bean error [OK]

Hint: Add DB driver to fix DataSource bean error [OK]

Common Mistakes:

• Assuming main method is wrong
• Thinking auto-config is off by default
• Believing Spring Boot lacks DataSource support

5. You want to disable Spring Boot's auto-configuration for JPA but keep others enabled. Which is the correct way to do this?

hard

A. Remove all dependencies except JPA starter

B. Add @SpringBootApplication(exclude = JpaAutoConfiguration.class) on main class

C. Set spring.autoconfigure.enabled=false in application.properties

D. Delete the spring.factories file from the jar

Solution

1. Step 1: Identify how to exclude specific auto-config

   Spring Boot allows excluding specific auto-config classes using the exclude attribute on @SpringBootApplication.

2. Step 2: Evaluate other options

   Removing dependencies disables features but is not selective; disabling all auto-config is too broad; deleting spring.factories breaks the framework.

3. Final Answer:

   Add @SpringBootApplication(exclude = JpaAutoConfiguration.class) on main class -> Option B

4. Quick Check:

   Exclude specific auto-config via annotation [OK]

Hint: Use exclude attribute on @SpringBootApplication [OK]

Common Mistakes:

• Disabling all auto-config instead of one
• Removing dependencies instead of excluding config
• Modifying internal Spring Boot files