Spring修炼之旅（3）自动装配与注解开发

你的名字 2024-04-17 13:32 43阅读 0赞

## 一、自动装配说明 ##

### 1.1概述 ###

*  自动装配是使用spring满足bean依赖的一种方法
 *  spring会在应用上下文中为某个bean寻找其依赖的bean。

### 1.2装配机制 ###

Spring中bean有三种装配机制，分别是：

> 1.  在xml中显式配置；
> 2.  在java中显式配置；
> 3.  隐式的bean发现机制和自动装配。

这里我们主要讲第三种：自动化的装配bean。

Spring的自动装配需要从两个角度来实现，或者说是两个操作：

> 1.  组件扫描(component scanning)：spring会自动发现应用上下文中所创建的bean；
> 2.  自动装配(autowiring)：spring自动满足bean之间的依赖，也就是我们说的IoC/DI；
> 
> 组件扫描和自动装配组合发挥巨大威力，使得显示的配置降低到最少。

### 1.3测试环境搭建 ###

新建实体类

package com.yanyu.pojo;
    
    public class Cat {
        public void shout() {
            System.out.println("miao~");
        }
    }

package com.yanyu.pojo;
    
    public class Dog {
        public void shout() {
            System.out.println("wang~");
        }
    }

package com.yanyu.pojo;
    
    import lombok.Data;
    
    @Data
    public class User {
        private Cat cat;
        private Dog dog;
        private String str;
    }

编写Spring配置文件

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">
    
        <bean id="dog" class="com.yanyu.pojo.Dog"/>
        <bean id="cat" class="com.yanyu.pojo.Cat"/>
    
        <bean id="user" class="com.yanyu.pojo.User">
            <property name="cat" ref="cat"/>
            <property name="dog" ref="dog"/>
            <property name="str" value="yanyu"/>
        </bean>
    </beans>

测试

import com.yanyu.pojo.User;
    import org.junit.Test;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    public class MyTest {
        @Test
        public void testMethodAutowire() {
            ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
            User user = (User) context.getBean("user");
            user.getCat().shout();
            user.getDog().shout();
        }
    }

## 二、自动装配 ##

### 2.1byName ###

**autowire byName (按名称自动装配)**

由于在手动配置xml过程中，常常发生字母缺漏和大小写等错误，而无法对其进行检查，使得开发效率降低。

采用自动装配将避免这些错误，并且使配置简单化。

1.  修改bean配置，增加一个属性 autowire="byName"
    
        <bean id="user" class="com.yanyu.pojo.User" autowire="byName">
                <property name="str" value="yabyu"/>
            </bean>
2.  再次测试，结果依旧成功输出！
3.  我们将 cat 的bean id修改为 catXXX
4.  再次测试， 执行时报空指针java.lang.NullPointerException。因为按byName规则找不对应set方法，真正的setCat就没执行，对象就没有初始化，所以调用时就会报空指针错误。

> 当一个bean节点带有 autowire byName的属性时。
> 
> 1.  将查找其类中所有的set方法名，例如setCat，获得将set去掉并且首字母小写的字符串，即cat。
> 2.  去spring容器中寻找是否有此字符串名称id的对象。
> 3.  如果有，就取出注入；如果没有，就报空指针异常。

### 2.2byType ###

**autowire byType (按类型自动装配)**

使用autowire byType首先需要保证：同一类型的对象，在spring容器中唯一。如果不唯一，会报不唯一的异常。

> NoUniqueBeanDefinitionException

测试：

1、将user的bean配置修改一下 ： autowire="byType"

2、测试，正常输出

3、在注册一个cat 的bean对象！

4、测试，报错：NoUniqueBeanDefinitionException

5、删掉cat2，将cat的bean名称改掉！测试！因为是按类型装配，所以并不会报异常，也不影响最后的结果。甚至将id属性去掉，也不影响结果。

这就是按照类型自动装配！

### 2.3使用注解 ###

配置文件

<?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"
           xmlns:aop="http://www.springframework.org/schema/aop"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
            https://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            https://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/aop
            https://www.springframework.org/schema/aop/spring-aop.xsd">
    
        <bean id="dog" class="com.yanyu.pojo.Dog"/>
        <bean id="cat" class="com.yanyu.pojo.Cat"/>
    
        <bean id="user" class="com.yanyu.pojo.User" autowire="byType">
            <property name="str" value="yabyu"/>
        </bean>
    </beans>

2、开启属性注解支持！

<context:annotation-config/>

#### @Autowired ####

*  @Autowired是按类型自动转配的，不支持id匹配。
 *  需要导入 spring-aop的包！

> 直接在属性上使用也可以在set方式上使用!  
> 使用Autowired我们可以不用编写Set方法了，前提是你这个自动装配的属性在I0C (Spring) 容器中存在，且符合名字byname!

测试：

1、将User类中的set方法去掉，使用@Autowired注解

package com.yanyu.pojo;
    
    import lombok.Data;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    @Data
    @Component
    public class User {
        @Autowired
        private Cat cat;
        @Autowired
        private Dog dog;
        private String str;
    }

2、此时配置文件内容

<context:annotation-config/>
    
    <bean id="dog" class="com.yanyu.pojo.Dog"/>
    <bean id="cat" class="com.yanyu.pojo.Cat"/>
    <bean id="user" class="com.yanyu.pojo.User"/>

3、测试，成功输出结果！

> @Autowired(required=false) 说明：false，对象可以为null；true，对象必须存对象，不能为null。
> 
>     //如果允许对象为null，设置required = false,默认为true
>     @Autowired(required = false)
>     private Cat cat;

#### @Qualifier ####

*  @Autowired是根据类型自动装配的，加上@Qualifier则可以根据byName的方式自动装配
 *  @Qualifier不能单独使用

测试实验步骤：

1、配置文件修改内容，保证类型存在对象。且名字不为类的默认名字！

2、没有加Qualifier测试，直接报错

3、在属性上添加Qualifier注解

@Autowired
    @Qualifier(value = "cat2")
    private Cat cat;
    @Autowired
    @Qualifier(value = "dog2")
    private Dog dog;

测试，成功输出！

#### @Resource(jdk8取消注解) ####

*  @Resource如有指定的name属性，先按该属性进行byName方式查找装配；
 *  其次再进行默认的byName方式进行装配；
 *  如果以上都不成功，则按byType的方式自动装配。
 *  都不成功，则报异常。

## 三、Spring注解开发 ##

### 3.1环境配置 ###

### 3.2Bean的实现 ###

我们之前都是使用 bean 的标签进行bean注入，但是实际开发中，我们一般都会使用注解！

1、配置扫描哪些包下的注解

<context:component-scan base-package="com.yanyu.pojo"/>

2、在指定包下编写类，增加注解

@Component("user")
    // 相当于配置文件中 <bean id="user" class="当前注解的类"/>
    public class User {
       public String name = "烟雨";
    }

3、测试

@Test
    public void test(){
       ApplicationContext applicationContext =
           new ClassPathXmlApplicationContext("beans.xml");
       User user = (User) applicationContext.getBean("user");
       System.out.println(user.name);
    }

### 3.3属性注入 ###

使用注解注入属性

1、可以不用提供set方法，直接在直接名上添加@value("值")

@Component("user")
    // 相当于配置文件中 <bean id="user" class="当前注解的类"/>
    public class User {
       @Value("烟雨")
       // 相当于配置文件中 <property name="name" value="烟雨"/>
       public String name;
    }

2、如果提供了set方法，在set方法上添加@value("值");

@Component("user")
    public class User {
    
       public String name;
    
       @Value("烟雨")
       public void setName(String name) {
           this.name = name;
      }
    }

### 3.4衍生注解 ###

我们这些注解，就是替代了在配置文件当中配置步骤而已！更加的方便快捷！

**@Component三个衍生注解**

为了更好的进行分层，Spring可以使用其它三个注解，功能一样，目前使用哪一个功能都一样。

*  @Controller：web层
 *  @Service：service层
 *  @Repository：dao层

写上这些注解，就相当于将这个类交给Spring管理装配了！

### 3.5自动装配注解 ###

在Bean的自动装配已经讲过了，可以回顾！

> 作用域

@scope

*  singleton：默认的，Spring会采用单例模式创建这个对象。关闭工厂 ，所有的对象都会销毁。
 *  prototype：多例模式。关闭工厂 ，所有的对象不会销毁。内部的垃圾回收机制会回收

@Controller("user")
    @Scope("prototype")
    public class User {
       @Value("yanyu")
       public String name;
    }

### 3.6小结 ###

> **XML与注解比较**
> 
>  *  XML可以适用任何场景 ，结构清晰，维护方便
>  *  注解不是自己提供的类使用不了，开发简单方便
> 
> **xml与注解整合开发** ：推荐最佳实践
> 
>  *  xml管理Bean
>  *  注解完成属性注入
>  *  使用过程中， 可以不用扫描，扫描是为了类上的注解
> 
>     <context:annotation-config/>  
> 
> 作用：
> 
>  *  进行注解驱动注册，从而使注解生效
>  *  用于激活那些已经在spring容器里注册过的bean上面的注解，也就是显示的向Spring注册
>  *  如果不扫描包，就需要手动配置bean
>  *  如果不加注解驱动，则注入的值为null！

### 3.7基于Java类进行配置 ###

JavaConfig 原来是 Spring 的一个子项目，它通过 Java 类的方式提供 Bean 的定义信息，在 Spring4 的版本， JavaConfig 已正式成为 Spring4 的核心功能 。

测试：

1、编写一个实体类，Dog

package com.yanyu.pojo;
    
    import org.springframework.stereotype.Component;
    
    @Component  //将这个类标注为Spring的一个组件，放到容器中！
    public class Dog {
        public String name = "dog";
    }

2、新建一个config配置包，编写一个MyConfig配置类

package com.yanyu.config;
    
    import com.yanyu.pojo.Dog;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration  //代表这是一个配置类
    public class MyConfig {
    
        @Bean //通过方法注册一个bean，这里的返回值就Bean的类型，方法名就是bean的id！
        public Dog dog(){
            return new Dog();
        }
    
    }

3、测试

import com.yanyu.config.MyConfig;
    import com.yanyu.pojo.Dog;
    
    import org.junit.Test;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.annotation.AnnotationConfigApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    public class MyTest {
        @Test
        public void test2(){
            ApplicationContext applicationContext =
                    new AnnotationConfigApplicationContext(MyConfig.class);
            Dog dog = (Dog) applicationContext.getBean("dog");
            System.out.println(dog.name);
        }
    }

**导入其他配置如何做呢？**

1、我们再编写一个配置类！

@Configuration  //代表这是一个配置类
    public class MyConfig2 {
    }

2、在之前的配置类中我们来选择导入这个配置类

@Configuration
    @Import(MyConfig2.class)  //导入合并其他配置类，类似于配置文件中的 inculde 标签
    public class MyConfig {
    
       @Bean
       public Dog dog(){
           return new Dog();
      }
    
    }

关于这种Java类的配置方式，我们在之后的SpringBoot 和 SpringCloud中还会大量看到，我们需要知道这些注解的作用即可！