【手撕 Spring】Spring 如何装配 Bean

蔚落 2024-05-04 08:02 73阅读 0赞

![在这里插入图片描述][3b7bd5fa1f104d42a7a1af7513dbc402.png]

> ?**博主介绍**： 博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：[个人社区][Link 1]  
? 个人主页：[个人主页][Link 2]  
? 专栏地址： ✅ [带你手撕 Spring][Spring]  
?八股文专题：[剑指大厂，手撕 Java 八股文][Java]

#### 文章目录 ####

*  写在前面
 *  1、Spring 配置的可选方案
 *  2、自动化装配 bean
 *  3、创建可被发现的bean
 *  4、为组件扫描的bean命名
 *  5、设置组件扫描的基础包
 *  6、通过为bean添加注解实现自动装配
 *  7、验证自动装配

## 写在前面 ##

在 Spring 中，对象无需自己查找或创建与其所关联的其他对象。相反，容器负责把需要相互协作的对象引用赋予各个对象。例如，一个订单管理组件需要信用卡认证组件，但它不需要自己创建信用卡认证组件。订单管理组件只需要表明自己两手空空，容器就会主动赋予它一个信用卡认证组件。

创建应用对象之间协作关系的行为通常称为装配(wiring)，这也是依赖注入 (D) 的本质。在本章我们将介绍使用Sring装配 bean的基础知识。因为D是Spring的最基本要素，所以在开发基于Spring的应用时，你随时都在使用这些技术。

在Spring中装配bean有多种方式。我们先花一点时间来介绍一下配置Spring容器最常见的三种方法。

## 1、Spring 配置的可选方案 ##

Spring 容器负责创建应用程序中的bean并通过D来协调这些对象之间的关系。但是，作为开发人员，你需要告诉Spring要创建哪些bean并且如何将其装配在一起。

当描述bean如何进行装配时，Spring具有非常大的灵活性，它提供了三种主要的装配机制：

*  在XML中进行显式配置。
 *  在Java中进行显式配置。
 *  隐式的bean发现机制和自动装配。

乍看上去，提供三种可选的配置方案会使Spring变得复杂。每种配置技术所提供的功能会有一些重叠，所以在特定的场景中，确定哪种技术最为合适就会变得有些困难。但是，不必紧张一-在很多场景下，选择哪种方案很大程度上就是个人喜好的问题，你尽可以选择自己最喜欢的方式。

Spring有多种可选方案来配置bean，这是非常棒的，但有时候你必须要在其中做出选择。

这方面，并没有唯一的正确答案。你所做出的选择必须要适合你和你的项目。而且，谁说我们只能选择其中的一种方案呢? SOrO的配置风格是可以互相搭配的，所以你可以选择使用XML装配一些ben，使用Sorino 基于Java的配置 (JavaConio) 来装配另一些bean，而将剩余的bean让Spring去自动发现。

即便如此。我的建议是尽可能地使用自动配置的机制。显式配置越少越好。当你必须要显式配置be8n的时候(比如，有些源码不是中你来维护的，而当你需要为这些代码配置bean的时候)，我推荐使用类型安全并且比XML更加强大的JavaConig。最后，只有当你想要使用便利的XMI命名空间，并且在JavaConfig中没有同样的实现时，才应该使用XML。

现在，我们会尝试一下每种方法，对它们是什么样子的有一个直观的印象。作为Spring配置的开始，我们先看一下Spring的自动化配置。

## 2、自动化装配 bean ##

尽管你会发现这些显式装配技术非常有用，但是在便利性方面，最强大的还是Spring的自动化配置。如果Spring能够进行自动化装配的话，那何苦还要显式地将这些bean装配在一起呢?

Spring从两个角度来实现自动化装配:

*  组件扫描 (component scanning): Spring会自动发现应用上下文中所创建的bean。
 *  自动装配 (autowiring) : Spring自动满足bean之间的依赖。

组件扫描和自动装配组合在一起就能发挥出强大的威力，它们能够将你的显式配置降低到最少。为了阐述组件扫描和装配，我们需要创建几个bean,它们代表了一个音响系统中的组件。首先，要创建CompactDisc类，Spring会发现它并将其创建为一个bean。然后，会创建一个CDPlaver类，让Spring发现它，并将CompactDiscbean注入进来。

## 3、创建可被发现的bean ##

在这个MP3和流式媒体音乐的时代，CD compact disc)显得有点典雅甚至陈归。它不像卡带机、八轨磁带、塑胶唱片那么普遍，随着以物理载体进行音乐交付的方式越来越少，CD也变得越来越稀少了。

尽管如此，CD为我们阐述DI如何运行提供了一个很好的样例。如果你不将CD插入 (注入)到CD播放器中，那么CD播放器其实是  
没有太大用处的。所以，可以这样说，CD播放器依赖于CD才能完成它的使命。

为了在Spring中阐述这个例子，让我们首先在Java中建立CD的概念。它是定义CD的一个接口:

public interface CompactDisc {
        
    	void play();
    }

CompactDisc的具体内容开不重要，重要的是你将其定义为一个接口。作为接口，它定义了CD播放器对一盘CD所服进行的操作。它将CD播放器的任意实现与CD本身的耦合降低到了最小的程度。实际上，我们可以有CompactDisc接口的多个实现。在本例中，我们首先会创建其中的一个实现，如下：

@Component
    public class SgtPeppers implements CompactDisc {
        
    	
    	private String title = "Sgt.Pepper's Lonely Hearts Club Band";
    	private String artist = "The Beatles";
    	
    	public void play() [
    		System.out.println("Playing " + title + " by " + artist);
    	}
    }

和CompactDisc接口一样，SgtPeppers的具体内容并不重要。你需要注意的就是SgtPeppers 类上使用了@Component注解。这个简单的注解表明该类会作为组件类，并告知Spring要为这个类创建bean。没有必要显式配置SgtPeppers bean，因为这个类使用了@Component注解，所以Spring会为你把事情处理妥当。

不过，组件扫描默认是不启用的。我们还需要显式配置一下Sprng，从而命令它去寻找带有@Component注解的类，并为其创建bean。

**@ComponentScan注解启用了组件扫描**

@Configuration
    @ComponentScan
    public class CDPlayerConfig {
        
    }

类CDPlayerConfig通过Java代码定义了Spring的装配规则。我们还会更为详细地介绍基于Java的Sprino配置。不过，现在我只需观察一下CDPlayerConfig类并没有显式地声明任何bean，只不过它使用了@Component Scan注解，这个注解能够在Spring中启用组件扫描。

如果没有其他配置的话，@ComponentScan默认会扫描与配置类相同的包。因为CDPlayerConfig类位于soundsystem包中，因此Spring将会扫描这个包以及这个包下的所有子包，查找带有@Component注解的类。这样的话，就能发现CompactDisc，并且会在Sprina中自动为其创建一个bean。

如果你更倾向于使用XML来启用组件扫描的话，那么可以使用spring context名空间的元素。

**通过通 XML启用组件扫描**

<?xml version="1.0" encoding="uTF-8“?>
    <beans xmlns="http://www,springframework.org/schema/beans"
    	xmIns;xsi="http://www,w3org/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="soundsystem"/>
    
    </beans>

尽管我们可以通过XML的方案来启用组件扫描，但是在后面的讨论中，我更多的还是会使用基于Java的配置。如果你更喜欢XML的话，context:component-scan元素会有与ComponentScan注解相对应的属性和子元素。

可能有点让人难以置信，我们只创建了两个类，就能对功能进行一番尝试了。为了测试组件扫描的功能，我们创建一个简单的JUnit测试，创建Spring上下文，并判断CompactDisc是不是真的创建出来了。

@RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(classes=CDPlayerConfig.class)
    public class CDPlayerTest {
        
    
    	@Autowired
    	private CompactDisc cd;
    	
    	@Test
    	public void cdshouldNotBeNull() {
        
    		assertNotNull(cd) ;
    	}
    }

以便在测试开始的时候自动创建Spring的应用上下文。注CDPlayerTest使用了Spring的SpringJunit4ClassRunner，解@ContextConfiquration会告诉它需要在CDPlaverConfig中加载配置。因为CDPlaverConfig类中包含了@ComponentScan,因此最终的应用上下文中应该包含CompactDiscbean。

为了证明这一点，在测试代码中有一个CompactDisc类型的属性，并且这个属性带有@Autowired注解，以便于将CompactDiscbean注入到测试代码之中(稍后，我会讨论@Autowired)。最后，会有一简单的测试方法断言Cd属性不为nul。如果它不为nul的话，就意味着Spring能够发现CompactDisc类，自动在Spring上下文中将其创建为bean并将其注入到测试代码之中。

这个代码应该能够通过测试，并以测试成功的颜色显示(在你的测试运行器中，或许会希望出现绿色)。你第一个简单的组件扫描练习就成功了!尽管我们只用它创建了一个bean，但同样是这么少的配置能够用来发现和建任意数量的bean。在soundsystem包及其子包中，所有带有Component注解的类都会创建为bean。只添加一行@ComponentScan注解就能自动创建无数个bean，这种权衡还是很划算的。

现在，我们会更加深入地探讨@ComponentScan和@Component，看一下使用组件扫描还能做些什么。

## 4、为组件扫描的bean命名 ##

Spring应用上下文中所有的bean都会给定一个D。在前面的例子中，尽管我们没有明确地为Sgt eppersbean设置ID，但Spring会根据类名为其指定一个D。具体来讲，这个bean所给定的ID为sgtPeppers，也就是将类名的第一个字母变为小写。

如果想为这个bean设置不同的D，你所要做的就是将期望的ID作为值传递给@Component注解。比如说，如果想将这bean标识为lonelyHeartsclub，那么你需要将sgtPeppers类的@Component注解配置为如下所示:

@Component("lonelyHeartsClub")
    public class SgtPeppers implements CompactDisc {
        
    
    }

还有另外一种为bean命名的方式，这种方式不使用@Component 注解，而是使用Java依赖注入规范 (Java Dependency njection)中所提供的@Named注解来为bean设置ID:

package soundsystem;
    
    import javax.inject.Named;
    
    @Named("lonelyHeartsClub")
    public class SgtPeppers implements CompactDisc {
        
    
    }

Spring支持将@Named作为@Component注解的替代方案。两者之间有一些细微的差异，但是在大多数场景中，它们是可以互相替换的。

话虽如此，我更加强烈地喜欢@Component注解，而对于@Named…怎么说呢，我感觉它的名字起得很不好。它并没有像@Component那样清楚地表明它是做什么的。因此在本书及其示例代码中，我不会再使用@Named。

## 5、设置组件扫描的基础包 ##

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

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

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

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

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

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

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

@Configuration
    @ComponentScan(basePackages=("soundsystem","video"})
    public class cDPlayerConfig {
        
    
    }

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

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

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

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

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

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

## 6、通过为bean添加注解实现自动装配 ##

简单来说，自动装配就是让Spring自动满足bean依赖的一种方法，在满足依赖的过程中，会在Spring应用上下文中寻找匹配某bean需求的其他bean。为了声明要进行自动装配，我们可以借助Spring的@Autowired注解。比方说，它的构造器上添加了@Autowired注解，这表明当Spring创建CDPlayerbean的时候，会通过这个构造器来进行实例化并且会传入一个可设置给CompactDisc类型的bean。

package soundsystem;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    @Component
    public class CDPlayer implements MediaPlayer {
        
    
    	private CompactDisc cd;
    	
    	@Autowired
    	public CDPlayer (CompactDisc cd) {
        
    		this.cd = cd;
    	}
    
    	public void play() {
        
    		cd.play();
    	}
    }

@Autowired注解不仅能够用在构造器上，还能用在属性的Setter方法上。比如说，如果CDPlayer有一个setCompactDisc0方法，那么可以采用如下的注解形式进行自动装配：

@Autowired
    public void setCompactDisc(CompactDisc cd) {
        
    	this.cd = cd;
    }

在Spring初始化bean之后，它会尽可能得去满足bean的依赖，在本例中，依赖是通过带有@Autowired注解的方法进行声明的，也就是setCompactDisc()。

实际上，Seter方法并没有什么特殊之处。@Autowired注解可以用在类的任何方法上。假设CDPlayer类有一个insertDisc()方法，那么@Autowired能够像在setCompactDisc() 上那样，发挥完全相同的作用:

@Autowired
    public void insertDisc(CompactDisc cd) {
        
    	this.cd = cd;
    }

不管是构造器、Setter方法还是其他的方法，Spring都会尝试满足方法参数上所声明的依赖。假如有且只有一个bean匹配依赖需求的话，那么这个bean将会被装配进来。

如果没有匹配的bean，那么在应用上下文创建的时候，Spring会抛出一个异常。为了避免异常的出现，你可以将@Autowired的required属性设置为false:

@Autowired(required=false)
    public CDPlayer(CompactDisc cd) {
        
    	this.cd = cd;
    }

将required属性设置为false时，Spring会尝试执行自动装配，但是如果没有匹配的bean的话，Spring将会让这bean处于未装配的状态但是，把required属性设置为false时，你需要谨慎对待。如果在你的代码中没有进行nul检查的话，这个处于未装配状态的属性有可能会出现NullPointerException。

如果有多个bean都能满足依赖关系的话，Spring将会抛出一个异常，表明没有明确指定要选择哪个bean进行自动装配。在第3章中，我们会进步讨论自动装配中的歧义性。

@Autowired是Sprino特有的注解。如果你不愿意在代码中到处使用Sprina的特定注解来完成自动装配任务的话，那么你可以考虑将其替换为@Inject:

package soundsystem;
    
    import javax.inject.Inject;
    import javax.inject.Named;
    
    @Named
    public class CDPlayer {
        
    
    	@Inject
    	public cDPlayer(CompactDisc cd) {
        
    		this.cd = cd;
    	}
    }

@Inject注解来源于Java依赖注入规范，该规范同时还为我们定义了@Named注解。在自动装配中，Spring同时支持@Inject和eAutowired。尽管@Inject和eAutowired之间有着一些细微的差别，但是在大多数场景下，它们都是可以互相替换的.

在@Inject和eAutowired中，我没有特别强烈的偏向性。实际上，在有的项目中，我会发现我同时使用了这两个注解。不过在本书的样例中，我会一直使用@Autowired，而你可以根据自己的情况，选择其中的任意一个。

## 7、验证自动装配 ##

现在，我们已经在CDPlayer的构造器中添加了@Autowired注解，Spring将把一个可分配给CompactDis类型的bean自动注入进来。为了验证这一点，让我们修改一下CDPlayerTest，使其能够借助CDPlayer bean播放CD:

package soundsystem;
    
    import static org.junit.Assert.*;
    import org.junit.Rule;
    import org.junit.Test;
    import org.junit.contrib.java.lang.system.StandardOutputStreamLog;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.test.context.ContextConfiguration;
    import org,springframework.test.context.junit4.SpringJUnit4ClassRunner;
    
    @RunWith(SpringJUnit4classRunner.class)
    @ContextConfiguration(classes=CDPlayerConfig.class)
    public class CDPlayerTest {
        
    	@Rule
    	public final standardoutputStreamLog log =
    										new StandardoutputstreamLog() ;
    	@Autowired
    	private MediaPlayer player;
    	
    	@Autowired
    	private CompactDisc cd;
    	
    	@Test
    	public void cdshouldNotBeNull() {
        
    		assertNotNul1(cd);
    	}
    	
    	@Test
    	public void play() {
        
    		player.play();
    		assertEquals("Playing Sgt. Pepper's Lonely Hearts Club Band"+"by The Beatles\n",log.getLog());
    	}
    }

现在，除了注入CompactDisc，我们还将CDPlaverbean注入到测试代码的player成员变量之中(它是更为通用的Mediaplayer类型)。在play() 测试方法中，我们可以调用CDPlayer的play0方法，并断言它的行为与你的预期一致。

在测试代码中使用System.out,println()是稍微有点棘手的事情。因此，该样例中使用了standardOutputStreamLog,这是来源于Svstem Rules库 (hto:/stearbikner.ithub.iosvstem-rulesindexhm) 的一JU规则，该规则能够基于控制合的输出编写断言。在这里，  
我们断言sgtPeppers.play () 方法的输出被发送到了控制台上。

>  精彩专栏推荐订阅：在下方专栏??

>  ✅ [2023年华为OD机试真题（A卷&B卷）+ 面试指导 ][2023_OD_A_B_ _]  
>  ✅ [ 精选100套 Java 项目案例 ][_100_ Java _]  
>  ✅ [面试需要避开的坑（活动）][Link 3]  
>  ✅ [你找不到的核心代码][Link 4]  
>  ✅ [带你手撕 Spring][Spring]

> ?? 本文由激流原创，原创不易，希望大家关注、点赞、收藏，给博主一点鼓励，感谢！！！

![在这里插入图片描述][7b7478e55aa24a948b358051ef941b6a.webp_pic_center]

[3b7bd5fa1f104d42a7a1af7513dbc402.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/04/a6f39318488e48f9962a7e809781f696.png
[Link 1]: https://bbs.csdn.net/forums/45c04d3f41cc4dadaf312be1d1379b45?category=10003
[Link 2]: https://jiliu.blog.csdn.net/
[Spring]: https://blog.csdn.net/qq_37967783/category_12391987.html
[Java]: https://blog.csdn.net/qq_37967783/article/details/130940512
[2023_OD_A_B_ _]: https://blog.csdn.net/qq_37967783/category_12389634.html
[_100_ Java _]: https://blog.csdn.net/qq_37967783/category_12388267.html
[Link 3]: https://blog.csdn.net/qq_37967783/category_12380337.html
[Link 4]: https://blog.csdn.net/qq_37967783/category_12391346.html
[7b7478e55aa24a948b358051ef941b6a.webp_pic_center]: https://img-blog.csdnimg.cn/7b7478e55aa24a948b358051ef941b6a.webp#pic_center