What is @ComponentScan in Spring?

#componentscan #spring #springboot

In Spring Framework, the @ComponentScan annotation is used to automatically detect and register Spring components such as classes annotated with @Component, @Service, @Repository, and @Controller.

Instead of manually defining beans in configuration files, @ComponentScan allows Spring to scan specified packages and automatically create beans in the Spring container.

This feature helps reduce configuration and simplifies application development.

How @ComponentScan Works

When Spring Boot starts the application, it scans the base package and its sub-packages to find classes annotated with Spring stereotypes.

These annotations include:

@Component
@Service
@Repository
@Controller
@RestController

Once detected, Spring automatically registers them as beans in the application context.

Example of @ComponentScan

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
}

In this example, Spring will scan the com.example package and all its sub-packages to detect Spring components.

Example with Spring Boot

In Spring Boot, @ComponentScan is automatically included inside the @SpringBootApplication annotation.

Example:

@SpringBootApplication
public class DemoApplication {

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

Here, Spring Boot scans the package of the main class and its sub-packages automatically.

Benefits of @ComponentScan

1. Reduces Configuration

No need to manually define beans in XML or configuration classes.

2. Automatic Bean Registration

Spring automatically creates and manages beans.

3. Simplifies Project Structure

Encourages organized package structure.

4. Improves Developer Productivity

Developers can focus on writing business logic instead of configuration.

Conclusion

The @ComponentScan annotation plays an important role in Spring applications by automatically detecting and registering components within specified packages. This helps reduce manual configuration and simplifies the development of modern Spring-based applications.