Spring（四）自动装配及其注解

Spring 自动装配与注解详解

最新推荐文章于 2024-04-15 17:29:15 发布

原创最新推荐文章于 2024-04-15 17:29:15 发布 · 203 阅读

2 ·

CC 4.0 BY-SA版权

Spring 专栏收录该内容

28 篇文章

订阅专栏

本文详细介绍了Spring框架中的自动装配特性，包括byName和byType两种方式，以及全局autowire的配置。同时，讲解了属性注解的使用，如@Autowired、@Qualifier和@Resource，它们的区别和应用场景。此外，还提到了类自动装配的@Controller、@Service、@Repository和@Component注解，以及自定义bean ID的方法。最后，文章还提及了@Value、@Scope、@Lazy、@PostConstruct和@PreDestroy等其他重要注解的用法。

（1）属性自动装配
准备三个类：

public class User {
    private Cat cat;
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    public void setCat(Cat cat) {
        this.cat = cat;
    }
    public Dog getDog() {
        return dog;
    }
    public void setDog(Dog dog) {
        this.dog = dog;
    }
    public String getStr() {
        return str;
    }
    public void setStr(String str) {
        this.str = str;
    }
}

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

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

public class TestIOCDI {
    @Test
    public void testMethodAutowire() {
        ApplicationContext context = new ClassPathXmlApplicationContext("resources/spring_autowire.xml");
        com.hdu.autowire.User user = context.getBean("user", com.hdu.autowire.User.class);
        user.getCat().shout();
        user.getDog().shout();
    }
}

1、xml配置文件

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
          class="com.hdu.autowire.User">
    <property name="cat" ref="cat"></property>
    <property name="dog" ref="dog"></property>
    <property name="str" value="haha"></property>
</bean>

2、autowire byName (按名称自动装配)
由于在手动配置xml过程中，常常发生字母缺漏和大小写等错误，而无法对其进行检查，使得开发效率降低。采用自动装配将避免这些错误，并且使配置简单化。
当一个bean节点带有 autowire byName的属性时。
①将查找其类中所有的set方法名，例如setCat，获得将set去掉并且首字母小写的字符串，即cat。
②去spring容器中寻找是否有此字符串名称id的对象。
③如果有，就取出注入；如果没有，就报空指针异常。
xml配置文件：

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
      class="com.hdu.autowire.User"
      autowire="byName">
</bean>

如果将改成：，执行时报空指针java.lang.NullPointerException。因为按byName规则找不对应set方法，真正的setCat就没执行，对象就没有初始化，所以调用时就会报空指针错误。
3、autowire byType (按类型自动装配)
使用autowire byType首先需要保证：同一类型的对象，在spring容器中唯一。如果不唯一，会报不唯一的异常。

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
      class="com.hdu.autowire.User"
      autowire="byType">
</bean>

将改成：因为是按类型装配，所以并不会报异常，也不影响最后的结果。甚至将id属性去掉，也不影响结果。
4、全局autowire

<?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:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:util="http://www.springframework.org/schema/util" 
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop 
        http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx 
        http://www.springframework.org/schema/tx/spring-tx.xsd
        http://www.springframework.org/schema/util 
        http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd"  default-autowire="byName">
        
    <bean id="cat" class="com.hdu.autowire.Cat"></bean>
    <bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
    <bean id="user" class="com.hdu.autowire.User" autowire="default"/>
    <bean id="user2" class="com.hdu.autowire.User" autowire="default"/>
    <bean id="user3" class="com.hdu.autowire.User" autowire="default"/>

</beans>

（2）属性注解
jdk1.5开始支持注解，spring2.5开始全面支持注解。
利用注解的方式注入属性。
①spring引入context文件头
②开启属性注解

<?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:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:util="http://www.springframework.org/schema/util"  xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop 
        http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx 
        http://www.springframework.org/schema/tx/spring-tx.xsd
        http://www.springframework.org/schema/util 
        http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">
        
    <context:annotation-config/>
</beans>

1、@Autowired
@Autowired是按类型自动转配的，不支持id匹配。
将User中的set方法去掉，加入@Autowired注解。
其中这里依赖一个的spring-aop-release-jar包。

public class User {
    @Autowired
    private Cat cat;
    @Autowired
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    
    public Dog getDog() {
        return dog;
    }
    
    public String getStr() {
        return str;
    }
}

xml配置文件

<context:annotation-config/>
    
<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" class="com.hdu.autowire.User"></bean>

@Autowired(required=false)
false，对象可以为null；true，对象必须存对象，不能为null。
2、@Qualifier
@Autowired是根据类型自动装配的，加上@Qualifier则可以根据byName的方式自动装配，其中@Qualifier不能单独使用。

public class User {
    @Autowired
    @Qualifier(value="carXXX")
    private Cat cat;
    @Autowired
    @Qualifier(value="dogXXX")
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    
    public Dog getDog() {
        return dog;
    }
    
    public String getStr() {
        return str;
    }
}

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

public class User {
    @Resource
    private Cat cat;
    @Resource(name="dogXXX")
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    
    public Dog getDog() {
        return dog;
    }
    
    public String getStr() {
        return str;
    }
}

xml1配置文件：

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" class="com.hdu.autowire.User"></bean>

先进行byName查找，成功。
xml2配置文件：

<context:annotation-config/> 
    
<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" class="com.hdu.autowire.User"></bean>

先进行byName查找，失败；再进行byType查找，成功。
5、小结
@Autowired与@Resource异同：
1° @Autowired与@Resource都可以用来装配bean。都可以写在字段上，或写在setter方法上。
2° @Autowired默认按类型装配（属于spring规范），默认情况下必须要求依赖对象必须存在，如果要允许null 值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用。
3° @Resource（属于J2EE复返），默认按照名称进行装配，名称可以通过name属性进行指定。如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。
它们的作用相同都是用注解方式注入对象，但执行顺序不同。@Autowired先byType，@Resource先byName。

（3）类自动装配
1、包扫描
注解替换bean节点
@Controller注解只能用控制器类上
@Service注解只能用在业务类上
@Repository注解只能用在dao类上
@Component注解无法按照上面三个注解分类,就用此注解

@Component
public class Cat {
    public void shout() {
        System.out.println("miao~");
    }
}

@Component
public class Dog {
    public void shout() {
        System.out.println("wang~");
    }
}

@Component
public class User {
    @Resource
    private Cat cat;
    @Resource
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    
    public Dog getDog() {
        return dog;
    }
    
    public String getStr() {
        return str;
    }
}

xml配置文件：

<!-- 解析注解
     @Controller
     @Service
     @Repository
     @Component
     component-scan:组件扫描
     base-package:基本包,指定包名,多个包名可以用逗号间隔
     也可以写多个<context:component-scan
     如果用了组件扫描后<context:annotation-config></context:annotation-config>就不用写了，组件扫描已经包含了 <context:annotation-config>
-->
<context:component-scan base-package="com.hdu.autowire"/>

测试类：

public class TestIOCDI {
    @Test
    public void testMethodAutowire() {
        ApplicationContext context = new ClassPathXmlApplicationContext("resources/spring_autowire.xml");
        User user = context.getBean("user", User.class);
        user.getCat().shout();
        user.getDog().shout();
    }
}

2、类目和ID对应表：
类名： CAT cAT CaT caT
ID: CAT cAT caT caT
分析：类名的关键在于第二个字母，第二个字母大写，首字母大写小写无所谓。如果第二个字母小写，那第一个必须小写。第二个字母之后大小写没关系。如果没有指定value，spring容器中id规则，是类名的首字母小写。
3、自定义bean的id
@Component(value=“cat”)

（4）其他注解
1、@Value
preperties配置文件：
jdbc_driverClass=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/tmpdb
jdbc_userName=root
jdbc_userPassword=root
1.1${}表达式
xml配置文件：

<context:component-scan base-package="com.hdu.util"></context:component-scan>
<!-- 用$表达式方式 -->
<context:property-placeholder location="classpath:/resources/mysql.properties"/>

demo类：

@Component("jdbcUtil")
public class JDBCUtil {
    @Value("${jdbc_driverClass}")
    private String driverClass;
    @Value("${jdbc_url}")
    private String url;
    @Value("${jdbc_userName}")
    private String userName;
    @Value("${jdbc_userPassword}")
    private String password;
    public String getDriverClass() {
        return driverClass;
    }
    
    public String getUrl() {
        return url;
    }
    
    public String getUserName() {
        return userName;
    }
    
    public String getPassword() {
        return password;
    }
    
    @Override
    public String toString() {
        return "JDBCUtil [driverClass=" + driverClass + ", url=" + url + ", userName=" + userName + ", password="
                + password + "]";
    }
    
    
    
}

测试：

public class TestSpringIOCDI_Annoation {
    @Test
    public void testMethod() {
        ApplicationContext context = new ClassPathXmlApplicationContext("resources/spring_annotation.xml");
        JDBCUtil jdbcUtil = context.getBean("jdbcUtil", JDBCUtil.class);
        System.out.println(jdbcUtil);
    }
}

1.2#{}表达式
xml配置文件：

<context:component-scan base-package="com.hdu.util"></context:component-scan>
<!-- 用#表达式方式 -->
<util:properties id="manyProperty" location="classpath:/resources/mysql.properties"></util:properties>

demo类：

@Component("jdbcUtil1")
public class JDBCUtil1 {//@Value("#{manyProperty['jdbc_url']}")
    @Value("#{manyProperty.jdbc_driverClass}")
    private String driverClass;
    @Value("#{manyProperty.jdbc_url}")
    private String url;
    @Value("#{manyProperty.jdbc_userName}")
    private String userName;
    @Value("#{manyProperty.jdbc_userPassword}")
    private String password;
    public String getDriverClass() {
        return driverClass;
    }
    
    public String getUrl() {
        return url;
    }
    
    public String getUserName() {
        return userName;
    }
    
    public String getPassword() {
        return password;
    }
    
    @Override
    public String toString() {
        return "JDBCUtil [driverClass=" + driverClass + ", url=" + url + ", userName=" + userName + ", password="
                + password + "]";
    }

}

测试：

public class TestSpringIOCDI_Annoation {
    @Test
    public void testMethod() {
        //加载spring容器
        ApplicationContext context = new ClassPathXmlApplicationContext("resources/spring_annotation.xml");
        //从spring容器中取出对象
        JDBCUtil1 jdbcUtil = context.getBean("jdbcUtil1", JDBCUtil1.class);
        System.out.println(jdbcUtil);
    }
}

2、 @Scope(value=“prototype”)// 单例和多例修饰在类上
3、 @Lazy //代表懒加载修饰在类上
4、 @PostConstruct //表示初始化操作修饰在方法上
5、 @PreDestroy //表示销毁修饰在方法上