$show=/label

Scanning Multiple Paths Or Packages with @ComponentScan Annotation in Spring Boot

SHARE:

A quick guide to how to scan or load multiple packages or paths in Spring Boot application with @ ComponentScan annotation along with example programs.

1. Introduction

in this article, You'll learn how to scan multiple packages in spring boot application with @ComponentScan annotation.

All the classes and sub-packages will be scanned automatically under Spring Boot main class package. During the scan, it will detect @Component, @Configurations, @Bean annotated classes, and methods.

If you have many packages or paths in your application and all of them are outside the spring boot main class will not be scanned automatically.


Scanning Multiple Paths Or Packages with @ComponentScan Annotation in Spring Boot

2. Adding Single Package Package to @ComponentScan in Spring Boot


Creating a new class EmployeeOne in "com.javaprogramto.packagee.one". This is not under the main boot application.



How to Scan Multiple Packages with @ComponentScan Annotation


package com.javaprogramto.packagee.one;

import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component

public class EmployeeOne {

    private int id;
    private String name;

}

By default, this class will not be scanned. So, you must tell to spring that scan this class.

To tell spring, use @ComponentScan with the argument that takes String value. as below

Note:

When you add @ComponentScan explicitly then-new package and current spring boot main application package will be scanned recursively.


package com.javaprogramto.springboot.SpringBootCofigurations;

import com.javaprogramto.packagee.one.EmployeeOne;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ComponentScan;

import java.util.HashMap;
import java.util.Map;

@SpringBootApplication
@ComponentScan("com.javaprogramto.packagee.one")

public class SpringBootCofigurationsApplication {

    public static void main(String[] args) {

        SpringApplication app = new SpringApplication(SpringBootCofigurationsApplication.class);


        ApplicationContext context =  app.run(args);
        EmployeeOne e = (EmployeeOne)context.getBean("employeeOne");
        System.out.println("Employee bean : "+e);

    }


}

Output:

2020-05-08 20:47:23.666  INFO 7798 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''

2020-05-08 20:47:23.670  INFO 7798 --- [           main] j.s.S.SpringBootCofigurationsApplication : Started SpringBootCofigurationsApplication in 1.458 seconds (JVM running for 1.893)

Employee beab : com.javaprogramto.packagee.one.Employee@2fb69ff6

3. Scanning Multiple Packages in Spring Boot


Next, Create another class in the different packages as below.

package com.javaprogramto.packagee.two;

import org.springframework.stereotype.Component;

@Component
public class EmployeeTwo {

    private int id;
    private String name;
}

To add many packages to Component Scan, you should pass the String[] array to the @ComponentScan annotation.

package com.javaprogramto.springboot.SpringBootCofigurations;

import com.javaprogramto.packagee.one.EmployeeOne;
import com.javaprogramto.packagee.two.EmployeeTwo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ComponentScan;

import java.util.HashMap;
import java.util.Map;

@SpringBootApplication
@ComponentScan({"com.javaprogramto.packagee.one", "com.javaprogramto.packagee.two"})

public class SpringBootCofigurationsApplication {

    public static void main(String[] args) {

        SpringApplication app = new SpringApplication(SpringBootCofigurationsApplication.class);

        Map<String, Object> customConfig = new HashMap<>();
        customConfig.put("server.port", "9009");

        ApplicationContext context =  app.run(args);
        EmployeeOne e = (EmployeeOne)context.getBean("employeeOne");
        System.out.println("EmployeeOne bean : "+e);

        EmployeeTwo e2 = (EmployeeTwo) context.getBean("employeeTwo");
        System.out.println("EmployeeTwo bean : "+e2);

    }

}

Output:

EmployeeOne bean : com.javaprogramto.packagee.one.EmployeeOne@41c89d2f

EmployeeTwo bean : com.javaprogramto.packagee.two.EmployeeTwo@410e94e


4. Scan with @ComponentScan with basePackages Attribute


There is another way to define the package scanning with basePackages attribute in @ComponentScan annotation.

You need not add the @ComponetScan annotation on the main class. Define this annotation in any class.

@ComponentScan(basePackages = "com.javaprogramto.packagee.three")
@Component
public class EmployeeTwo {

    private int id;
    private String name;
}

Next, create a new class in package three as below.

package com.javaprogramto.packagee.three;

import org.springframework.stereotype.Component;

@Component
public class EmployeeThree {
}

Now, run the main class with the below code.


EmployeeThree e3 = (EmployeeThree) context.getBean("employeeThree");
System.out.println("EmployeeThree bean : "+e3);

Output:

[EmployeeThree bean : com.javaprogramto.packagee.three.EmployeeThree@c7a977f]

5. Conclusion


In this article, you've seen how to add multiple packages to be scanned by the Spring Boot applications with @ComponentScan annotation with arguments and with basePackages attribute.


All the code is shown in this article is over GitHub.

You can download the project directly and can run in your local without any errors.



If you have any queries please post in the comment section.

COMMENTS

BLOGGER

About Us

Author: Venkatesh - I love to learn and share the technical stuff.
Name

accumulo,1,ActiveMQ,2,Adsense,1,API,31,ArrayList,16,Arrays,2,Bean Creation,3,Bean Scopes,1,BiConsumer,1,Blogger Tips,1,Books,1,C Programming,1,Collection,4,Collections,20,Collector,1,Command Line,1,Compile Errors,1,Configurations,7,Constants,1,Control Statements,8,Conversions,5,Core Java,71,Corona India,1,Create,2,CSS,1,Date,2,Date Time API,3,Dictionary,1,Difference,1,Download,1,Eclipse,2,Efficiently,1,Error,1,Errors,1,Exception,1,Exceptions,2,Fast,1,Files,9,Float,1,Font,1,For examples,1,For loop examples,1,For Loop in Java,1,Form,1,Freshers,1,Function,3,Functional Interface,2,Garbage Collector,1,Generics,4,Git,4,Grant,1,Grep,1,HashMap,1,HTML,2,HttpClient,2,Immutable,1,Inner for loops,1,Installation,1,Interview Questions,5,Iterate,2,Jackson API,3,Java,28,Java 10,1,Java 11,5,Java 12,5,Java 13,2,Java 14,2,java 5 For loop,1,Java 8,47,Java 9,1,Java Design Patterns,1,Java Files,1,Java for loop,1,Java Program,2,Java Programs,65,java.lang,5,java.util. function,1,jQuery,1,Kotlin,10,Kotlin Programs,6,Lambda,1,lang,29,Leap Year,1,live updates,1,Math,1,Maven,1,Method References,1,Mockito,1,MongoDB,3,Nested for loop,1,Nested for loop examples,1,New Features,1,Operations,1,Optional,4,Oracle,5,Oracle 18C,1,Partition,1,Patterns,1,Programs,1,Property,1,Python,2,Quarkus,1,Read,1,Real Time,1,Recursion,2,Remove,2,Rest API,1,Schedules,1,Serialization,1,Servlet,1,Softwares,1,Sorting Techniques,8,Spring,2,Spring Boot,23,Spring Email,1,Spring MVC,1,Stream,2,Streams,11,String,48,String Programs,8,String Revese,1,Swing,1,System,1,Tags,1,Threads,7,Tomcat,1,Tomcat 8,1,Troubleshoot,16,Unix,2,Updates,3,util,5,While Loop,1,
ltr
item
JavaProgramTo.com: Scanning Multiple Paths Or Packages with @ComponentScan Annotation in Spring Boot
Scanning Multiple Paths Or Packages with @ComponentScan Annotation in Spring Boot
A quick guide to how to scan or load multiple packages or paths in Spring Boot application with @ ComponentScan annotation along with example programs.
https://1.bp.blogspot.com/-JwKDKHLdJEk/XrWEKDdvs3I/AAAAAAAACpc/d8KxVrUmXcs8XiXwdTGgwBVZc7d7gxbjACLcBGAsYHQ/s640/Scanning%2BMultiple%2BPaths%2BOr%2BPackages%2Bwith%2B%2540ComponentScan%2BAnnotation%2Bin%2BSpring%2BBoot-min.png
https://1.bp.blogspot.com/-JwKDKHLdJEk/XrWEKDdvs3I/AAAAAAAACpc/d8KxVrUmXcs8XiXwdTGgwBVZc7d7gxbjACLcBGAsYHQ/s72-c/Scanning%2BMultiple%2BPaths%2BOr%2BPackages%2Bwith%2B%2540ComponentScan%2BAnnotation%2Bin%2BSpring%2BBoot-min.png
JavaProgramTo.com
https://www.javaprogramto.com/2020/05/spring-boot-scan-packages-component-scan.html
https://www.javaprogramto.com/
https://www.javaprogramto.com/
https://www.javaprogramto.com/2020/05/spring-boot-scan-packages-component-scan.html
true
3124782013468838591
UTF-8
Loaded All Posts Not found any posts VIEW ALL Readmore Reply Cancel reply Delete By Home PAGES POSTS View All RECOMMENDED FOR YOU LABEL ARCHIVE SEARCH ALL POSTS Not found any post match with your request Back Home Sunday Monday Tuesday Wednesday Thursday Friday Saturday Sun Mon Tue Wed Thu Fri Sat January February March April May June July August September October November December Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec just now 1 minute ago $$1$$ minutes ago 1 hour ago $$1$$ hours ago Yesterday $$1$$ days ago $$1$$ weeks ago more than 5 weeks ago Followers Follow THIS PREMIUM CONTENT IS LOCKED STEP 1: Share to a social network STEP 2: Click the link on your social network Copy All Code Select All Code All codes were copied to your clipboard Can not copy the codes / texts, please press [CTRL]+[C] (or CMD+C with Mac) to copy Table of Content