2.2.3 设置组件扫描的基础包

到现在为止,我们没有为 @ComponentScan 设置任何属性。这意味着,按照默认规则,它会以配置类所在的包作为基础包(base package)来扫描组件。但是,如果你想扫描不同的包,那该怎么办呢?或者,如果你想扫描多个基础包,那又该怎么办呢?

有一个原因会促使我们明确地设置基础包,那就是我们想要将配置类 放在单独的包中,使其与其他的应用代码区分开来。如果是这样的话,那默认的基础包就不能满足要求了。

要满足这样的需求其实也完全没有问题!为了指定不同的基础包,你所需要做的就是在 @ComponentScan 的 value 属性中指明包的名称:

CDPlayerConfig.java
@Configuration
@ComponentScan("soundsystem")
public class CDPlayerConfig { }

如果你想更加清晰地表明你所设置的是基础包,那么你可以通过 basePackages 属性进行配置:

CDPlayerConfig.java
@Configuration
@ComponentScan(basePackages="soundsystem")
public class CDPlayerConfig { }

可能你已经注意到了 basePackages 属性使用的是复数形式。如果你揣测这是不是意味着可以设置多个基础包,那么恭喜你猜对了。如果想要这么做的话,只需要将 basePackages 属性设置为要扫描包的一个数组即可:

CDPlayerConfig.java
@Configuration
@ComponentScan(basePackages={"soundsystem", "video"})
public class CDPlayerConfig { }

在上面的例子中,所设置的基础包是以 String 类型表示的。我认为这是可以的,但这种方法是类型不安全(not type-safe)的。如果你重构代码的话,那么所指定的基础包可能就会出现错误了。

除了将包设置为简单的 String 类型之外,@ComponentScan 还提供了另外一种方法,那就是将其指定为包中所包含的类或接口:

CDPlayerConfig.java
@Configuration
@ComponentScan(basePackageClasses={CDPlayer.class, DVDPlayer.clas})
public class CDPlayerConfig { }

可以看到,basePackages 属性被替换成了 basePackageClasses。同时,我们不是再使用 String 类型的名称来指定包,为 basePackageClasses 属性所设置的数组中包含了类。这些类所在的包将会作为组件扫描的基础包。

尽管在样例中,我为 basePackageClasses 设置的是组件类,但是你可以考虑在包中创建一个用来进行扫描的空标记接口(marker interface)。通过标记接口的方式,你依然能够保持对重构友好的接口引用,但是可以避免引用任何实际的应用程序代码(在稍后重构中,这些应用代码有可能会从想要扫描的包中移除掉)。

在你的应用程序中,如果所有的对象都是独立的,彼此之间没有任何依赖,就像 SgtPeppersbean 这样,那么你所需要的可能就是组件扫描而已。但是,很多对象会依赖其他的对象才能完成任务。这样的话,我们就需要有一种方法能够将组件扫描得到的 bean 和它们的依赖装配在一起。要完成这项任务,我们需要了解一下 Spring 自动化配置的另外一方面内容,那就是自动装配。

Last updated