Spring?component-scan?XML配置與@ComponentScan注解配置
前言
無論Spring的XML配置或者Java配置，都可以配置自動(dòng)掃描，也就是在指定包及其子包下的component，都會(huì)被自動(dòng)掃描并被Spring容器管理。
注：component指的是被 @Component 注解及其變種（如 @Controller 、 @Service 、 @Repository 、 @Configuration 等）所修飾的類。
環(huán)境：
- Ubuntu 22.04
- IntelliJ IDEA 2022.1.3
- JDK 17.0.3
- Spring 5.3.21
準(zhǔn)備
創(chuàng)建Maven項(xiàng)目 test0831 。
修改 pom.xml 文件，添加依賴：
......
<!-- https://mvnrepository.com/artifact/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.21</version>
</dependency>
......在 src/test/java 目錄下創(chuàng)建測試：
public class MyTest {}創(chuàng)建如下POJO：
Axe：Axe接口；StoneAxe：Axe實(shí)現(xiàn)類；SteelAxe：Axe實(shí)現(xiàn)類；Person：Person持有Axe
package pojo;
public interface Axe {
public void chop();
}package pojo;
import org.springframework.stereotype.Component;
@Component
public class StoneAxe implements Axe{
@Override
public void chop() {
System.out.println("Stone axe!");
}
}package pojo;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
@Component
@Primary
public class SteelAxe implements Axe{
@Override
public void chop() {
System.out.println("Steel axe!");
}
}
package pojo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class Person {
private String name;
private Axe axe;
public void setAxe(Axe axe) {
this.axe = axe;
}
public void setName(String name) {
this.name = name;
}
public void useAxe() {
System.out.println("I am " + name);
axe.chop();
}
@Autowired
public Person(@Value("Tom") String name, Axe axe) {
this.name = name;
this.axe = axe;
}
}注：本例使用了 @Autowired 注解來自動(dòng)裝配注入，默認(rèn)是 byType ，當(dāng)有多個(gè)類都滿足條件時(shí)Spring會(huì)報(bào)錯(cuò)，所以使用了 @Primary 注解來指定優(yōu)先選擇該類。
@Component的bean
XML配置
配置：
在 src/main/resources 目錄下創(chuàng)建 applicationContext.xml 文件：
<?xml version="1.0" encoding="utf-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<context:component-scan base-package="pojo"/>
</beans>測試：
創(chuàng)建測試如下：
@Test
public void test1() {
var ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
var person = ctx.getBean("person", Person.class);
person.useAxe();
}運(yùn)行測試，結(jié)果如下：
I am Tom
Steel axe!
Java配置 配置
創(chuàng)建Java配置類 MyConfig.java 如下：
package config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan(basePackages = {"pojo"})
public class MyConfig {
}測試：
創(chuàng)建測試如下：
@Test
public void test2() {
var ctx = new AnnotationConfigApplicationContext(MyConfig.class);
var person = ctx.getBean("person", Person.class);
person.useAxe();
}運(yùn)行測試，結(jié)果如下：
I am Tom
Steel axe!
@Configuration的bean
自動(dòng)掃描時(shí)，如果遇到Java配置類，也會(huì)加載其配置。
在 pojo 包下添加Java配置類 MyConfig2 ：
package pojo;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyConfig2 {
@Bean
public String xxx() {
return "xxx";
}
}本例中， MyConfig2 是一個(gè)配置類，其中配置了ID為 xxx 的bean。
XML配置 配置
前面已經(jīng)配置了：
<context:component-scan base-package="pojo"/>
MyConfig2 在 pojo 包下，所以無需額外的配置。
測試
創(chuàng)建測試如下：
@Test
public void test3() {
var ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
var xxx = ctx.getBean("xxx", String.class);
System.out.println(xxx);
}運(yùn)行測試，結(jié)果如下：
xxx
Java配置 配置
前面已經(jīng)配置了：
@ComponentScan(basePackages = {"pojo"})MyConfig2 在 pojo 包下，所以無需額外的配置。
測試
創(chuàng)建測試如下：
@Test
public void test4() {
var ctx = new AnnotationConfigApplicationContext(MyConfig.class);
var xxx = ctx.getBean("xxx", String.class);
System.out.println(xxx);
}運(yùn)行測試，結(jié)果如下：
xxx
小結(jié)
@Configuration 是 @Component 的變種，因此也會(huì)被自動(dòng)掃描并加載。
如果Java配置類不是在自動(dòng)掃描的路徑里，則需要顯式加載：
通過XML配置加載：
<context:annotation-config/> <bean class="config.MyConfig3"/>
通過Java配置加載：
@Import({MyConfig3.class})總結(jié)
- 在類上添加
@Component（或者其變種）注解。 - 配置自動(dòng)掃描，以下兩種方式都可以：
XML配置：
<context:component-scan base-package="pojo"/>
Java配置：
@Configuration
@ComponentScan(basePackages = {"pojo"})
public class MyConfig {
}對于自動(dòng)掃描路徑里面的Java配置類（ @Configuration 注解所修飾的類），也會(huì)被加載生效。
注：關(guān)于Spring的XML配置和Java配置，詳見我另一篇文檔 https://blog.csdn.net/duke_ding2/article/details/125605817 。
關(guān)于SpringBoot
SpringBoot的入口程序一般如下：
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}即，調(diào)用 SpringApplication.run() 方法來啟動(dòng)程序，第一個(gè)參數(shù)是一個(gè)類，該類需要被 @SpringBootApplication 注解所修飾。
@SpringBootApplication 該注解包含了以下3個(gè)注解：
- @SpringBootConfiguration
- @EnableAutoConfiguration
- @ComponentScan
也就是說， @SpringBootApplication 包含了上面提到的Java配置的兩個(gè)注解 @Configuration
和 @ComponentScan 。
換句話說， @SpringBootApplication 所修飾的類就是程序的主配置類。
有一點(diǎn)需要注意的是，在默認(rèn)情況下（沒有指定包掃描路徑），會(huì)自動(dòng)掃描主配置類所在的包（及其子包）。因此，該包及子包下的組件類和配置類都會(huì)被掃描。
當(dāng)然也可以顯式指定包掃描路徑，需要注意的是，其屬性名是 scanBasePakcages ，而不是 basePackages 。
對比下面兩個(gè)注解：
- @ComponentScan(basePackages = "com.example.demo.pojo")
- @SpringBootApplication(scanBasePackages = "com.example.demo.pojo")
若顯式指定了包掃描路徑，則會(huì)覆蓋默認(rèn)設(shè)置（主配置類所在的包及子包不會(huì)被掃描）。
到此這篇關(guān)于Spring component-scan XML配置與@ComponentScan注解配置的文章就介紹到這了,更多相關(guān)Spring XML配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了解決@Autowired注入static接口的問題，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-08-08
Java 8 發(fā)布三年多之后，即將快到2017年7月下一個(gè)版本發(fā)布的日期了。 你可能已經(jīng)聽說過 Java 9 的模塊系統(tǒng)，但是這個(gè)新版本還有許多其它的更新。 這里有九個(gè)令人興奮的新功能將與 Java 9 一起發(fā)布。需要的朋友可以參考學(xué)習(xí)，下面來一起看看吧。2017-05-05
SpringBoot整合Mybatis與MybatisPlus方法詳細(xì)講解
這篇文章主要介紹了SpringBoot整合Mybatis與MybatisPlus方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)吧2023-01-01
這篇文章主要介紹了Java觀察者模式例子的相關(guān)資料,需要的朋友可以參考下2015-12-12
這篇文章主要介紹了Java?Bean作用域及它的幾種類型介紹，Spring框架作為一個(gè)管理Bean的IoC容器，那么Bean自然是Spring中的重要資源了，那Bean的作用域又是什么，接下來我們一起進(jìn)入文章詳細(xì)學(xué)習(xí)吧2022-09-09
java split結(jié)果去除空字符串的方法實(shí)現(xiàn)
在Java開發(fā)中,我們經(jīng)常需要對字符串進(jìn)行分割操作,本文主要介紹了java split結(jié)果去除空字符串的方法實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10
SpringBoot集成itext實(shí)現(xiàn)html轉(zhuǎn)PDF
iText是著名的開放源碼的站點(diǎn)sourceforge一個(gè)項(xiàng)目,是用于生成PDF文檔的一個(gè)java類庫,本文主要介紹了如何利用itext實(shí)現(xiàn)html轉(zhuǎn)PDF,需要的可以參考下2024-03-03
這篇文章主要介紹了Java中類的加載順序剖析（常用于面試題）,本文直接給出代碼實(shí)例和運(yùn)行結(jié)果,給后給出了加載過程總結(jié),需要的朋友可以參考下2015-03-03
對于Java虛擬機(jī)在內(nèi)存分配與回收的學(xué)習(xí)，本文主要介紹了JVM自動(dòng)內(nèi)存管理，文中通過圖文示例介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-08-08
這篇文章主要為大家詳細(xì)介紹了java處理日期的工具類DateUtil，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-10-10