Spring In Action（一）：基于注解装配bean

程序员文章站 2022-03-31 21:38:18

...

使用到的注解

（1）@Component注解，将一个类作为组件

（2）@ComponentScan注解，将会扫描包下的所有类，找出带有@Component注解的类，并实例化bean

（3）@Autowired注解，自动装配，默认使用byType进行装配，完成bean的实例化，@Autowired注解不仅适用于属性，也适用于setter方法和构造器，一般来说，只能有一个bean适合装配到@Autowried注解所标注的属性或参数中，如果没有合适的bean或者有多个，将会抛出异常。

（a）解决没有合适的bean用于装配的办法是，设置@Autowired(required=false)来配置自动装配是可选的，当没有合适的bean时，将会注入null。

（b）解决有多个bean，不确定使用哪个bean来装配的办法是使用@Qualifier注解，指定所需要的bean

1.创建一个Spring项目，修改pom文件，添加Spring单元测试所需依赖

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.study</groupId>
  <artifactId>spring-study</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>spring-study Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <!--使用单元测试所需jar包-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>4.3.8.RELEASE</version>
    </dependency>

    <!--spring相关包-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>4.3.8.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>4.3.8.RELEASE</version>
    </dependency>

    <!--其他-->
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.4</version>
    </dependency>
  </dependencies>
  <build>
    <finalName>spring-study</finalName>
  </build>
</project>

2.在src/main/java目录下新建一个包com.study.autoconfig(包名任意)，在此包下创建一个Music接口，Music接口有一个简单的play方法

public interface Music {
    void play();
}

创建一个PopMusic类，实现Music接口，重写play方法，同时添加@Component注解

//使用component注解将此类作为组件类，Spring会为此组件实例化bean
@Component
public class PopMusic implements Music {
    public void play() {
        System.out.println("play pop music");
    }
}

3.为了让Spring自动为带有@Componet注解的类实例化，还需要一些其他的配置

方法一：使用@ComponetScan注解，启动组件扫描

（1）在包com.study.autoconfig下创建MusicConfig配置类，添加@ComponetScan注解

（a）@ComponentScan注解会扫描这个包及它的子包，查找带有@Component注解的类，并为其创建一个bean，MusicConfig和PopMusic在同一个包下，因此Spring会为PopMusic实例化

（b）也可以使用设置basePackages或basePackClasses的方式，指定需要扫描的包或类

////ComponentScan启用组件扫描
@Configuration
@ComponentScan
//@ComponentScan(basePackages = {"com.study.autoconfig"}) //使用给定包名的方式，扫描组件
//@ComponentScan(basePackageClasses = {PopMusic.class,Music.class})//使用给定类名的方式，扫描组件
public class MusicConfig {


}

（2）单元测试

在test目录下创建对应的包，并创建MusicTest类

（a）@RunWith指定单元测试的执行类，使用SpringJUnit4ClassRunner类，自动创建spring的应用上下文

（b）@ContextConfiguration指定从哪里加载配置

（c）@Autowired注解，为Music自动注入，由于PopMusic是Music接口的实现类，当Spring为PopMusic实例化后，会自动将bean为Muisc注入

package com.study.autoconfig;

import org.junit.Test;
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)//自动创建Spring的应用上下文
@ContextConfiguration(classes=MusicConfig.class)//由于@ComponentScan注解在MusicConfig中，因此需要从MusicConfig中加载配置
public class MusicTest {

    //自动注入
    @Autowired
    private Music music;

    @Test
    public void playTest(){
        music.play();
    }
}

（3）执行单元测试，可以看到，测试通过，控制台打印 play pop music

Spring In Action（一）：基于注解装配bean

方法二：使用<context:component-scan>，直接在配置文件中开启注解扫描配置

（1）修改资源文件中的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="com.study.autoconfig"></context:component-scan>

</beans>

（2）更改单元测试中ContextConfiguration,改为从applicationContext.xml配置文件中加载

package com.study.autoconfig;

import org.junit.Test;
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)//自动创建Spring的应用上下文
//@ContextConfiguration(classes=MusicConfig.class)//由于@ComponentScan注解在MusicConfig中，因此需要从MusicConfig中加载配置
@ContextConfiguration(locations = { "classpath*:/spring/applicationContext.xml" })//指定配置文件
public class MusicTest {

    //自动注入
    @Autowired
    private Music music;

    @Test
    public void playTest(){
        music.play();
    }
}

3.运行结果，可以看到测试通过

Spring In Action（一）：基于注解装配bean