在第1章中,我们已经介绍了依赖注入的基本概念。Spring为开发人员提供了三种不同的依赖注入类型,分别是字段注入、构造器注入和Setter方法注入。现在,假设我们有一个HealthRecordService接口以及它的实现类,如代码清单2-1所示。
代码清单2-1 HealthRecordService接口及其实现类代码
public interface HealthRecordService { public void recordUserHealthData(); } public class HealthRecordServiceImpl implements HealthRecordService { @Override public void recordUserHealthData () { System.out.println("HealthRecordService has been called."); } }
基于上述HealthRecordServiceImpl实现类,下面我们来具体讨论如何在Spring中完成该类的注入,并分析各种注入类型的优缺点。
首先,我们来看字段注入。想要在一个类中通过字段的形式注入某个对象,就可以使用这个方式,示例代码如代码清单2-2所示。
代码清单2-2 字段注入示例代码
public class ClientService { @Autowired private HealthRecordService healthRecordService; public void recordUserHealthData() { healthRecordService.recordUserHealthData(); } }
可以看到,通过@Autowired注解,字段注入的实现方式非常简单而直接,代码的可读性也很高。事实上,字段注入是三种注入方式中最常用,也是最容易使用的一种,但它也是三种注入方式中最应该避免使用的。如果你使用过IDEA,可能会遇到“Field injection is not recommended”这个提示,告诉你不建议使用字段注入。针对这一点,你可能会觉得很诧异。我们来分析一下原因。
1)字段注入的最大问题是对象的外部可见性。正如在前面的ClientService类中,我们通过定义一个私有变量healthRecordService来注入该接口的实例。显然,这个实例只能在ClientService类中被访问,脱离了容器环境就无法进行访问,如代码清单2-3所示。
代码清单2-3 脱离容器使用ClientService示例代码
ClientService clientService = new ClientService(); clientService.recordUserHealthData();
执行这段代码的结果就是抛出一个NullPointerException空指针异常,原因是无法在ClientService的外部实例化HealthRecordService对象。采用字段注入,类与容器的耦合度过高,我们无法脱离容器来使用目标对象。如果我们编写测试用例来验证ClientService类的正确性,那么想要使用HealthRecordService对象,就只能通过反射的方式,这种做法实际上是不符合JavaBean开发规范的,而且可能导致一直无法发现空指针异常。
2)字段注入的第二个问题是可能导致潜在的循环依赖。所谓循环依赖,就是两个类之间互相进行注入,示例代码如代码清单2-4所示。
代码清单2-4 基于字段注入的循环依赖示例代码
public class ClassA { @Autowired private ClassB classB; } public class ClassB { @Autowired private ClassA classA; }
显然,这里的ClassA和ClassB发生了循环依赖。上述代码在Spring中是合法的,容器启动时并不会报任何错误,而只有在使用到具体某个ClassA或ClassB时才会报错。
3)字段注入的第三个问题是我们无法设置需要注入的对象为final,也无法注入那些不可变对象,这是因为字段必须在类实例化时进行实例化。
基于以上三点,IDEA以及Spring官方都不推荐开发人员使用字段注入这种方式。那么,我们推荐的注入方式是哪种呢?答案是构造器注入。
构造器注入的形式也很简单,就是通过类的构造函数来完成对象的注入,示例代码如代码清单2-5所示。
代码清单2-5 构造器注入示例代码
public class ClientService { private HealthRecordService healthRecordService; @Autowired public ClientService(HealthRecordService healthRecordService) { this.healthRecordService = healthRecordService; } public void recordUserHealthData() { healthRecordService.recordUserHealthData(); } }
可以看到构造器注入能解决对象外部可见性的问题,因为HealthRecordService是通过ClientService构造函数进行注入的,所以势必可以脱离ClientService而独立存在。
我们进一步引用Spring官方文档来解释构造器注入的特性:
The Spring team generally advocates constructor injection as it enables one to implement application components as immutable objects and to ensure that required dependencies are not null. Furthermore constructor-injected components are always returned to client (calling) code in a fully initialized state.
这段话的核心意思在于:构造器注入能够保证注入的组件不可变,并且确保需要的依赖不为空。这里的组件不可变就意味着我们可以使用final关键词来修饰所依赖的对象,而依赖不为空是指所传入的依赖对象肯定是一个实例对象,从而避免出现空指针异常。
同时,基于构造器注入,我们也来讨论前面介绍的ClassA和ClassB之间的循环依赖关系,实现方式如代码清单2-6所示。
代码清单2-6 基于构造器注入的循环依赖示例代码
public class ClassA { private ClassB classB; @Autowired public ClassA(ClassB classB) { this.classB = classB; } } public class ClassB { private ClassA classA; @Autowired public ClassB(ClassA classA) { this.classA = classA; } }
一旦采用构造器注入,在Spring项目启动的时候,就会抛出一个循环依赖异常,从而提醒你避免使用循环依赖。
通过上述分析,我们可以看到字段注入的三大问题都可以通过使用构造器注入的方式来解决。但是,构造器注入的显著问题就是当构造函数中存在较多依赖对象时,大量的构造器参数会让代码冗长。这时候就可以引入Setter方法注入。
先来看一下Setter方法注入的实现代码,如代码清单2-7所示。
代码清单2-7 Setter方法注入示例代码
public class ClientService { private HealthRecordService healthRecordService; @Autowired public void setHealthRecordService(HealthRecordService healthRecordService) { this.healthRecordService = healthRecordService; } public void recordUserHealthData() { healthRecordService.recordUserHealthData(); } }
Setter方法注入和构造器注入看上去有点类似,但它比构造函数更具可读性,因为我们可以把多个依赖对象分别通过Setter方法逐一进行注入。而且,Setter方法注入对于非强制依赖项注入很有用,我们可以有选择地注入一部分依赖对象。换句话说,该方法可以实现按需注入,帮助我们只在需要时注入依赖关系。
另外,Setter方法可以很好地解决应用程序中的循环依赖问题,如代码清单2-8所示的代码是可以正确执行的。
代码清单2-8 基于Setter方法注入的循环依赖示例代码
public class ClassA { private ClassB classB; @Autowired public void setClassB(ClassB classB) { this.classB = classB; } } public class ClassB { private ClassA classA; @Autowired public void setClassA(ClassA classA) { this.classA = classA; } }
请注意,上述代码能够正确执行的前提是ClassA和ClassB的作用域都是Singleton。关于Spring中的对象作用域,我们在本章后续会具体讨论。
最后,通过Setter注入可以对依赖对象进行多次重复注入,这在构造器注入中是无法实现的。
作为总结,我们用一句话来概括Spring所提供的三种依赖注入类型:构造器注入适合于强制对象注入;Setter注入适合于可选对象注入;而字段注入是应该被避免使用的,因为对象无法脱离容器而独立运行。