关于在Spring中通过注解形式的IoC容器 纯使用 @ComponentScan注解实现对包的自动扫描,实现非XML形式的 注解形式装配Bean类
参考书籍:Java EE互联网轻量级框架整合开发 杨开振 周吉文等著
1.1 实现目标
- 使用注解形式的IoC容器AnnotationConfigApplicationContext 来装配Bean类,同时实现包的自动扫描。
- 不使用<context:component-scan base-package="…"/>类似的XML中的标签 实现包的扫描(也可说根本不需要spring-config.xml 的xml文件, 单纯使用基于XML形式的IoC容器会使用到spring-config.xml文件)
- 完全依靠注解实现包扫描,不混用XML形式的Bean类
1.2 实现思路
- 首先定义好需要测试的JavaBean类,并以注解形式声明为IoC组件(@Component),并装配好参数(@Value)
- 然后通过一个辅助类,该辅助类借助@ComponentScan注解 告诉 以AnnotationConfigApplicationContext实现 的上下文类Spring IoC容器 所需Bean类的包扫描路径
- 编写测试代码让基于注解形式的Spring IoC容器 根据设定的默认Bean类包扫描路径 寻找到后并提供预设的Bean类实例,最终输出相关信息
2. 准备工作
2.0 预设已引入Spring所需相关依赖包
2.1 待装配的Bean类 User2.java(使用@Component和@Value注解实现实例参数的注入和装配)
注意! 该类所在的包路径 com.castle.beans
package com.castle.beans;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.io.Serializable;
@Component("user2")
public class User2 implements Serializable {
@Value("10")
private Long id;
@Value("Bob")
private String userName;
@Value("Hello, i am bob!")
private String note;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getNote() {
return note;
}
public void setNote(String note) {
this.note = note;
}
@Override
public String toString() {
return id + " " + userName + ": " + note;
}
}
2.2 辅助Spring容器类能自动扫描包的类 BeansConfig.java(借助@ComponentScan注解)
注意! 该类所在的包路径 也是 com.castle.beans,和待装配的Bean所在包路径一致!
package com.castle.beans;
import org.springframework.context.annotation.ComponentScan;
//不给ComponentScan注解赋初值,采用默认值,将会使该类所在包成为容器的默认扫描路径
// 即:com.castle.beans会成为Spring IoC容器的默认扫描包的路径
@ComponentScan
public class BeansConfig {
}
3.1 测试代码(基于AnnotationConfigApplicationContext上下文类)
/**
* 测试基于AnnotationConfigApplicationContext上下文容器类,借助注解的方式实现Beans类的装配
*/
public static void test2(){
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(BeansConfig.class);
User2 user2 = (User2) context.getBean(User2.class);
//此处使用自己外包的System.out.println()方法输出信息,与其效果一致,仅字母较少
println(user2);
context.close();
}
3.2 测试结果
4. 注意事项
- 测试代码使用的是ApplicationContext接口的实现类 AnnotationConfigApplicationContext
- AnnotationConfigApplicationContext 与 ClassPathXmlApplicationContext(也实现ApplicationContext接口) 在构建实例和使用getBean方法时有所区别。 AnnotationConfigApplicationContext构造器和getBean方法传入 class对象 。 即:
ApplicationContext context = new AnnotationConfigApplicationContext(BeansConfig.class);
User2 user2 = (User2) context.getBean(User2.class);
- 而 ClassPathXmlApplicationContext 构造器和getBean方法传入 字符串对象 。即:
ApplicationContext context = new ClassPathXmlApplicationContext("spring-config.xml");
User2 user2 = (User2) context.getBean("user2");
- 同时在使用 ClassPathXmlApplicationContext 做 ApplicationContext 接口的实现类时,使用了XML的方式装配Bean类,若出现 NoSuchBeanDefinitionException 异常时需要在XML文件中对扫描的包路径进行配置(该Bean类装配方式与单纯注解装配方式有根本区别:是否使用了XML文件配置),具体代码为:
该文件名(spring-config.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-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!--使用XML文件方式装配时指定扫描的包的路径-->
<context:component-scan base-package="com.castle.beans"/>
<bean>
<!--此处省略-->
</bean>
</beans>
5. 总结和延伸
5.1 装配Bean的IoC容器实现类常见有两种:
① 基于注解形式的IoC容器类:AnnotationConfigApplicationContext 类
② 基于XML形式的IoC容器类:ClassPathXmlApplicationContext 类
5.2 混用两种形式装配的Bean类 其包或Bean类扫描方法:
① 在注解形式的IoC容器中注入(添加)基于XML形式配置的Bean类 :
通过注解@ImportResource({“classpath:spring-config.xml”}) 。其中spring-config.xml为XML形式的Bean类配置文件
② 在XML形式的IoC容器中注入(添加)基于注解形式配置的Bean类:
通过在spring的Bean类配置的xml文件中 [如spring-config.xml] 中 使用标签<context:component-scan base-package="…"/>来添加基于注解形式的Bean类所在包,让基于XML形式的IoC容器对该包进行扫描。