Spring-依赖注入IOC
Spring-依赖注入IOC
SerMsIoC 概念简介
IoC 是什么
IoC,是 Inversion of Control 的缩写,即控制反转。
- 上层模块不应该依赖于下层模块,它们共同依赖于一个抽象
- 抽象不能依赖于具体实现,具体实现依赖于抽象
注:又称为依赖倒置原则。这是设计模式六大原则之一。
IoC 不是什么技术,而是一种设计思想。在 Java 开发中,IoC 意味着将你设计好的对象交给容器控制,而不是传统的在你的对象内部直接控制。如何理解 Ioc 呢?理解 Ioc 的关键是要明确“谁控制谁,控制什么,为何是反转(有反转就应该有正转了),哪些方面反转了”,那我们来深入分析一下:
- 谁控制谁,控制什么:传统 JavaSE 程序设计,我们直接在对象内部通过 new 进行创建对象,是程序主动去创建依赖对象;而 IoC 是有专门一个容器来创建这些对象,即由 IoC 容器来控制对象的创建;谁控制谁?当然是 IoC 容器控制了对象;控制什么?那就是主要控制了外部资源获取(不只是对象包括比如文件等)。
- 为何是反转,哪些方面反转了:有反转就有正转,传统应用程序是由我们自己在对象中主动控制去直接获取依赖对象,也就是正转;而反转则是由容器来帮忙创建及注入依赖对象;为何是反转?因为由容器帮我们查找及注入依赖对象,对象只是被动的接受依赖对象,所以是反转;哪些方面反转了?依赖对象的获取被反转了。
IoC 能做什么
IoC 不是一种技术,只是一种思想,一个重要的面向对象编程的法则,它能指导我们如何设计出松耦合、更优良的程序。传统应用程序都是由我们在类内部主动创建依赖对象,从而导致类与类之间高耦合,难于测试;有了 IoC 容器后,把创建和查找依赖对象的控制权交给了容器,由容器进行注入组合对象,所以对象与对象之间是松散耦合,这样也方便测试,利于功能复用,更重要的是使得程序的整个体系结构变得非常灵活。
其实 IoC 对编程带来的最大改变不是从代码上,而是从思想上,发生了“主从换位”的变化。应用程序原本是老大,要获取什么资源都是主动出击,但是在 IoC/DI 思想中,应用程序就变成被动的了,被动的等待 IoC 容器来创建并注入它所需要的资源了。
IoC 很好的体现了面向对象设计法则之一—— 好莱坞法则:“别找我们,我们找你”;即由 IoC 容器帮对象找相应的依赖对象并注入,而不是由对象主动去找。
IoC 和 DI
其实它们是同一个概念的不同角度描述,由于控制反转概念比较含糊(可能只是理解为容器控制对象这一个层面,很难让人想到谁来维护对象关系),所以 2004 年大师级人物 Martin Fowler 又给出了一个新的名字:“依赖注入”,相对 IoC 而言,“依赖注入”明确描述了“被注入对象依赖 IoC 容器配置依赖对象”。
注:如果想要更加深入的了解 IoC 和 DI,请参考大师级人物 Martin Fowler 的一篇经典文章 Inversion of Control Containers and the Dependency Injection pattern (opens new window)。
IoC 容器
IoC 容器就是具有依赖注入功能的容器。IoC 容器负责实例化、定位、配置应用程序中的对象及建立这些对象间的依赖。应用程序无需直接在代码中 new 相关的对象,应用程序由 IoC 容器进行组装。在 Spring 中 BeanFactory 是 IoC 容器的实际代表者。
Spring IoC 容器如何知道哪些是它管理的对象呢?这就需要配置文件,Spring IoC 容器通过读取配置文件中的配置元数据,通过元数据对应用中的各个对象进行实例化及装配。一般使用基于 xml 配置文件进行配置元数据,而且 Spring 与配置文件完全解耦的,可以使用其他任何可能的方式进行配置元数据,比如注解、基于 java 文件的、基于属性文件的配置都可以。
那 Spring IoC 容器管理的对象叫什么呢?
Bean
JavaBean 是一种 JAVA 语言写成的可重用组件。为写成 JavaBean,类必须是具体的和公共的,并且具有无参数的构造器。JavaBean 对外部通过提供 getter / setter 方法来访问其成员。
由 IoC 容器管理的那些组成你应用程序的对象我们就叫它 Bean。Bean 就是由 Spring 容器初始化、装配及管理的对象,除此之外,bean 就与应用程序中的其他对象没有什么区别了。那 IoC 怎样确定如何实例化 Bean、管理 Bean 之间的依赖关系以及管理 Bean 呢?这就需要配置元数据,在 Spring 中由 BeanDefinition 代表,后边会详细介绍,配置元数据指定如何实例化 Bean、如何组装 Bean 等。
Spring IoC
核心接口
org.springframework.beans
和 org.springframework.context
是 IoC 容器的基础。
在 Spring 中,有两种 IoC 容器:BeanFactory
和 ApplicationContext
。
BeanFactory
:BeanFactory 提供了 Spring 容器的配置框架和基本功能。ApplicationContext
:BeanFactory 的子接口。它还扩展了其他一些接口,以支持更丰富的功能,如:国际化、访问资源、事件机制、更方便的支持 AOP、在 web 应用中指定应用层上下文等。
实际开发中,更推荐使用 ApplicationContext
作为 IoC 容器,因为它的功能远多于 FactoryBean
。
常见 ApplicationContext
实现:
- ClassPathXmlApplicationContext:
ApplicationContext
的实现,从 classpath 获取配置文件;
1 | BeanFactory beanFactory = new ClassPathXmlApplicationContext("classpath.xml"); |
- FileSystemXmlApplicationContext:
ApplicationContext
的实现,从文件系统获取配置文件。
1 | BeanFactory beanFactory = new FileSystemXmlApplicationContext("fileSystemConfig.xml"); |
IoC 容器工作步骤
使用 IoC 容器可分为三步骤:
- 配置元数据:需要配置一些元数据来告诉 Spring,你希望容器如何工作,具体来说,就是如何去初始化、配置、管理 JavaBean 对象。
- 实例化容器:由 IoC 容器解析配置的元数据。IoC 容器的 Bean Reader 读取并解析配置文件,根据定义生成 BeanDefinition 配置元数据对象,IoC 容器根据
BeanDefinition
进行实例化、配置及组装 Bean。 - 使用容器:由客户端实例化容器,获取需要的 Bean
配置元数据
元数据(Metadata)又称中介数据、中继数据,为描述数据的数据(data about data),主要是描述数据属性(property)的信息。
配置元数据的方式:
基于 xml 配置:Spring 的传统配置方式。在
<beans>
标签中配置元数据内容。缺点是当 JavaBean 过多时,产生的配置文件足以让你眼花缭乱。
基于注解配置:Spring2.5 引入。可以大大简化你的配置。
基于 Java 配置:可以使用 Java 类来定义 JavaBean 。
为了使用这个新特性,需要用到
@Configuration
、@Bean
、@Import
和@DependsOn
注解
Spring Bean 概述
一个 Spring 容器管理一个或多个 bean。这些 bean 根据你配置的元数据(比如 xml 形式)来创建。
Spring IoC 容器本身,并不能识别你配置的元数据。为此,要将这些配置信息转为 Spring 能识别的格式——BeanDefinition
对象。
命名 Bean
- 指定 id 和 name 属性不是必须的。Spring 中,并非一定要指定 id 和 name 属性。实际上,Spring 会自动为其分配一个特殊名。如果你需要引用声明的 bean,这时你才需要一个标识。官方推荐驼峰命名法来命名。
支持别名
可能存在这样的场景,不同系统中对于同一 bean 的命名方式不一样。 为了适配,Spring 支持
<alias>
为 bean 添加别名的功能。```xml
1
2
3
4
5
6
7
- **实例化 Bean**
- 构造器方式
- ```xml
<bean id="exampleBean" class="examples.ExampleBean"/>
依赖注入模式
依赖注入模式可以分为手动模式和自动模式。
手动注入
配置或者编程的方式,提前安排注入规则
- XML 资源配置元信息
- Java 注解配置元信息
- API 配置元信息
自动注入
实现方提供依赖自动关联的方式,按照內建的注入规则(官方不推荐)
- Autowiring(自动绑定)
模式 | 说明 |
---|---|
no | 默认值,未激活 Autowiring,需要手动指定依赖注入对象。 |
byName | 根据被注入属性的名称作为 Bean 名称进行依赖查找,并将对象设置到该属性。 |
byType | 根据被注入属性的类型作为依赖类型进行查找,并将对象设置到该属性。 |
constructor | 特殊 byType 类型,用于构造器参数。 |
限制和不足参考:Limitations and Disadvantages of Autowiring 小节(opens new window)
依赖注入类型
依赖注入类型 | 配置元数据举例 |
---|---|
Setter 方法 | <proeprty name="user" ref="userBean"/> |
构造器 | <constructor-arg name="user" ref="userBean" /> |
字段 | @Autowired User user; |
方法 | @Autowired public void user(User user) { ... } |
接口回调 | class MyBean implements BeanFactoryAware { ... } |
Setter 方法注入
手动模式
- XML 资源配置元信息
- Java 注解配置元信息
- API 配置元信息
自动模式
- byName
- byType
构造器注入
手动模式
- XML 资源配置元信息
- Java 注解配置元信息
- API 配置元信息
自动模式
- constructor
字段注入
手动模式(Java 注解配置元信息)
@Autowired
@Resource
@Inject
(可选)
方法注入
手动模式(Java 注解配置元信息)
@Autowired
@Resource
@Inject
(可选)@Bean
接口回调注入
Aware 系列接口回调
內建接口 | 说明 |
---|---|
BeanFactoryAware | 获取 IoC 容器- BeanFactory |
ApplicationContextAware | 获取 Spring 应用上下文- ApplicationContext 对象 |
EnvironmentAware | 获取 Environment 对象 |
ResourceLoaderAware | 获取资源加载器对象- ResourceLoader |
BeanClassLoaderAware | 获取加载当前 Bean Class 的 ClassLoader |
BeanNameAware | 获取当前 Bean 的名称 |
MessageSourceAware | 获取 MessageSource 对象,用于 Spring 国际化 |
ApplicationEventPublisherAware | 获取 ApplicationEventPublishAware 对象,用于 Spring 事件 |
EmbeddedValueResolverAware | 获取 StringValueResolver 对象,用于占位符处理 |
依赖注入类型选择
- 低依赖:构造器注入
- 多依赖:Setter 方法注入
- 便利性:字段注入
- 声明类:方法注入
被注入的数据类型
基础类型
- 原生类型(Primitive):boolean、byte、char、short、int、float、long、double
- 标量类型(Scalar):Number、Character、Boolean、Enum、Locale、Charset、Currency、Properties、UUID
- 常规类型(General):Object、String、TimeZone、Calendar、Optional 等
- Spring 类型:Resource、InputSource、Formatter 等
集合类型
- 数组类型(Array):原生类型、标量类型、常规类型、Spring 类型
- 集合类型(Collection)
- Collection:List、Set(SortedSet、NavigableSet、EnumSet)
- Map:Properties
IoC 依赖查找
依赖查找是主动或手动的依赖查找方式,通常需要依赖容器或标准 API 实现。
- 根据 Bean 名称查找
- 实时查找
- 延迟查找
- 根据 Bean 类型查找
- 根据 Bean 名称 + 类型查找
- 根据 Java 注解查找
【示例】Spring IoC 依赖查找
xml 元信息配置
1 |
|
依赖查找示例代码:
1 | public class BeanFactoryDemo { |
IoC 依赖注入
DI,是 Dependency Injection 的缩写,即依赖注入。依赖注入是 IoC 的最常见形式。依赖注入是手动或自动绑定的方式,无需依赖特定的容器或 API。
容器全权负责组件的装配,它会把符合依赖关系的对象通过 JavaBean 属性或者构造函数传递给需要的对象。
DI 是组件之间依赖关系由容器在运行期决定,形象的说,即由容器动态的将某个依赖关系注入到组件之中。依赖注入的目的并非为软件系统带来更多功能,而是为了提升组件重用的频率,并为系统搭建一个灵活、可扩展的平台。通过依赖注入机制,我们只需要通过简单的配置,而无需任何代码就可指定目标需要的资源,完成自身的业务逻辑,而不需要关心具体的资源来自何处,由谁实现。
理解 DI 的关键是:“谁依赖谁,为什么需要依赖,谁注入谁,注入了什么”,那我们来深入分析一下:
- 谁依赖于谁:当然是应用程序依赖于 IoC 容器;
- 为什么需要依赖:应用程序需要 IoC 容器来提供对象需要的外部资源;
- 谁注入谁:很明显是 IoC 容器注入应用程序某个对象,应用程序依赖的对象;
- 注入了什么:就是注入某个对象所需要的外部资源(包括对象、资源、常量数据)。
IoC 依赖注入 API
- 根据 Bean 名称注入
- 根据 Bean 类型注入
- 注入容器内建 Bean 对象
- 注入非 Bean 对象
- 注入类型
- 实时注入
- 延迟注入
IoC 容器配置
IoC 容器的配置有三种方式:
- 基于 xml 配置
- 基于注解配置
- 基于 Java 配置
作为 Spring 传统的配置方式,xml 配置方式一般为大家所熟知。
如果厌倦了 xml 配置,Spring 也提供了注解配置方式或 Java 配置方式来简化配置。
本文,将对 Java 配置 IoC 容器做详细的介绍。
#5.1. Xml 配置
1 |
|
标签说明:
<beans>
是 Spring 配置文件的根节点。<bean>
用来定义一个 JavaBean。id
属性是它的标识,在文件中必须唯一;class
属性是它关联的类。<alias>
用来定义 Bean 的别名。<import>
用来导入其他配置文件的 Bean 定义。这是为了加载多个配置文件,当然也可以把这些配置文件构造为一个数组(new String[] {“config1.xml”, config2.xml})传给ApplicationContext
实现类进行加载多个配置文件,那一个更适合由用户决定;这两种方式都是通过调用 Bean Definition Reader 读取 Bean 定义,内部实现没有任何区别。<import>
标签可以放在<beans>
下的任何位置,没有顺序关系。
#实例化容器
实例化容器的过程: 定位资源(XML 配置文件) 读取配置信息(Resource) 转化为 Spring 可识别的数据形式(BeanDefinition)
1 | ApplicationContext context = |
组合 xml 配置文件 配置的 Bean 功能各不相同,都放在一个 xml 文件中,不便管理。 Java 设计模式讲究职责单一原则。配置其实也是如此,功能不同的 JavaBean 应该被组织在不同的 xml 文件中。然后使用 import 标签把它们统一导入。
1 | <import resource="classpath:spring/applicationContext.xml"/> |
#使用容器
使用容器的方式就是通过getBean
获取 IoC 容器中的 JavaBean。 Spring 也有其他方法去获得 JavaBean,但是 Spring 并不推荐其他方式。
1 | // create and configure beans |
注解配置
Spring2.5 引入了注解。 于是,一个问题产生了:使用注解方式注入 JavaBean 是不是一定完爆 xml 方式? 未必。正所谓,仁者见仁智者见智。任何事物都有其优缺点,看你如何取舍。来看看注解的优缺点: 优点:大大减少了配置,并且可以使配置更加精细——类,方法,字段都可以用注解去标记。 缺点:使用注解,不可避免产生了侵入式编程,也产生了一些问题。
- 你需要将注解加入你的源码并编译它;
- 注解往往比较分散,不易管控。
注:spring 中,先进行注解注入,然后才是 xml 注入,因此如果注入的目标相同,后者会覆盖前者。
启动注解
Spring 默认是不启用注解的。如果想使用注解,需要先在 xml 中启动注解。 启动方式:在 xml 中加入一个标签,很简单吧。
1 | <context:annotation-config/> |
注:
<context:annotation-config/>
只会检索定义它的上下文。什么意思呢?就是说,如果你 为 DispatcherServlet 指定了一个WebApplicationContext
,那么它只在 controller 中查找@Autowired
注解,而不会检查其它的路径。
@Required
@Required
注解只能用于修饰 bean 属性的 setter 方法。受影响的 bean 属性必须在配置时被填充在 xml 配置文件中,否则容器将抛出BeanInitializationException
。
1 | public class AnnotationRequired { |
@Autowired
@Autowired
注解可用于修饰属性、setter 方法、构造方法。
@Autowired 注入过程
- 元信息解析
- 依赖查找
- 依赖注入(字段、方法)
注:
@Autowired
注解也可用于修饰构造方法,但如果类中只有默认构造方法,则没有必要。如果有多个构造器,至少应该修饰一个,来告诉容器哪一个必须使用。
可以使用 JSR330 的注解@Inject
来替代@Autowired
。
*范例*
1 | public class AnnotationAutowired { |
xml 中的配置
1 | <!-- 测试@Autowired --> |
@Qualifier
在@Autowired
注解中,提到了如果发现有多个候选的 bean 都符合修饰类型,Spring 就会抓瞎了。
那么,如何解决这个问题。
可以通过@Qualifier
指定 bean 名称来锁定真正需要的那个 bean。
*范例*
1 | public class AnnotationQualifier { |
xml 中的配置
1 | <!-- 测试@Qualifier --> |
@Resource
Spring 支持 JSP250 规定的注解@Resource
。这个注解根据指定的名称来注入 bean。
如果没有为@Resource
指定名称,它会像@Autowired
一样按照类型去寻找匹配。
在 Spring 中,由CommonAnnotationBeanPostProcessor
来处理@Resource
注解。
*范例*
1 | public class AnnotationResource { |
xml 的配置
1 | <!-- 测试@Resource --> |
@PostConstruct
和 @PreDestroy
@PostConstruct
和 @PreDestroy
是 JSR 250 规定的用于生命周期的注解。
从其名号就可以看出,一个是在构造之后调用的方法,一个是销毁之前调用的方法。
1 | public class AnnotationPostConstructAndPreDestroy { |
@Inject
从 Spring3.0 开始,Spring 支持 JSR 330 标准注解(依赖注入)。
注:如果要使用 JSR 330 注解,需要使用外部 jar 包。
若你使用 maven 管理 jar 包,只需要添加依赖到 pom.xml 即可:
1 | <dependency> |
@Inject
和 @Autowired
一样,可以修饰属性、setter 方法、构造方法。
*范例*
1 | public class AnnotationInject { |
Java 配置
基于 Java 配置 Spring IoC 容器,实际上是Spring 允许用户定义一个类,在这个类中去管理 IoC 容器的配置。
为了让 Spring 识别这个定义类为一个 Spring 配置类,需要用到两个注解:@Configuration
和@Bean
。
如果你熟悉 Spring 的 xml 配置方式,你可以将@Configuration
等价于<beans>
标签;将@Bean
等价于<bean>
标签。
@Bean
@Bean 的修饰目标只能是方法或注解。
@Bean 只能定义在 @Configuration
或 @Component
注解修饰的类中。
声明一个 bean
此外,@Configuration 类允许在同一个类中通过@Bean 定义内部 bean 依赖。
声明一个 bean,只需要在 bean 属性的 set 方法上标注@Bean 即可。
1 |
|
这等价于配置
1 | <beans> |
@Bean 注解用来表明一个方法实例化、配置合初始化一个被 Spring IoC 容器管理的新对象。
如果你熟悉 Spring 的 xml 配置,你可以将@Bean 视为等价于<beans>
标签。
@Bean 注解可以用于任何的 Spring @Component
bean,然而,通常被用于@Configuration
bean。
@Configuration
@Configuration
是一个类级别的注解,用来标记被修饰类的对象是一个BeanDefinition
。
@Configuration
声明 bean 是通过被 @Bean
修饰的公共方法。此外,@Configuration
允许在同一个类中通过 @Bean
定义内部 bean 依赖。
1 |
|
这等价于配置
1 | <beans> |
用 AnnotationConfigApplicationContext
实例化 IoC 容器。
最佳实践
singleton 的 Bean 如何注入 prototype 的 Bean
Spring 创建的 Bean 默认是单例的,但当 Bean 遇到继承的时候,可能会忽略这一点。
假设有一个 SayService 抽象类,其中维护了一个类型是 ArrayList 的字段 data,用于保存方法处理的中间数据。每次调用 say 方法都会往 data 加入新数据,可以认为 SayService 是有状态,如果 SayService 是单例的话必然会 OOM。
1 | /** |
但实际开发的时候,开发同学没有过多思考就把 SayHello 和 SayBye 类加上了 @Service 注解,让它们成为了 Bean,也没有考虑到父类是有状态的。
1 |
|
在为类标记上 @Service 注解把类型交由容器管理前,首先评估一下类是否有状态,然后为 Bean 设置合适的 Scope。
调用代码:
1 |
|
可能有人认为,为 SayHello 和 SayBye 两个类都标记了 @Scope 注解,设置了 PROTOTYPE 的生命周期就可以解决上面的问题。
1 |
但实际上还是有问题。因为@RestController 注解 =@Controller 注解 +@ResponseBody 注解,又因为 @Controller 标记了 @Component 元注解,所以 @RestController 注解其实也是一个 Spring Bean。
Bean 默认是单例的,所以单例的 Controller 注入的 Service 也是一次性创建的,即使 Service 本身标识了 prototype 的范围也没用。
修复方式是,让 Service 以代理方式注入。这样虽然 Controller 本身是单例的,但每次都能从代理获取 Service。这样一来,prototype 范围的配置才能真正生效。
1 |