第5条:优先使用依赖注入而不是硬连接资源
Many classes depend on one or more underlying resources. For example, a spell checker depends on a dictionary. It is not uncommon to see such classes implemented as static utility classes(Item 4):
很多类都依赖一个或多个底层资源。例如,拼写检查器依赖于字典。我们常常会见到这种类被做成了静态工具类(条目4):
// Inappropriate use of static utility - inflexible & untestable!
public class SpellChecker {
private static final Lexicon dictionary = ...;
private SpellChecker() {} // Noninstantiable
public static boolean isValid(String word) { ... }
public static List<String> suggestions(String typo) { ... }
}
Similarly, it’s not uncommon to see them implemented as singletons (Item 3):
类似的,我们也会常常见到这种类被做成了Singleton(条目3):
// Inappropriate use of singleton - inflexible & untestable!
public class SpellChecker {
private final Lexicon dictionary = ...;
private SpellChecker(...) {}
public static INSTANCE = new SpellChecker(...);
public boolean isValid(String word) { ... }
public List<String> suggestions(String typo) { ... }
}
Neither of these approaches is satisfactory, because they assume that there is only one dictionary worth using. In practice, each language has its own dictionary, and special dictionaries are used for special vocabularies. Also, it may be desirable to use a special dictionary for testing. It is wishful thinking to assume that a single dictionary will suffice for all time.
上述两种方法都不不是很令人满意,因为它们都假定了只有一部字典可用。但在实际当中,每一种语言都有它自己的字典,尤其是有些用于特殊词汇的字典。而且,我们也可能需要使用特殊字典来做测试工作。我们不能一厢情愿地想当然以为单单一部字典就能满足所有情景。
You could try to have SpellChecker support multiple dictionaries by making the dictionary field nonfinal and adding a method to change the dictionary in an existing spell checker, but this would be awkward, error-prone, and unworkable in a concurrent setting. Static utility classes and singletons are inappropriate for classes whose behavior is parameterized by an underlying resource.
你也可以尝试着将例子中的dictionary属性的final修饰符去掉,然后添加一个可以更改字典的方法,但这又显得笨拙,容易出错,而且在并发场景中变得不可用。静态工具类和Singleton对于类行为需要被底层资源参数化的场景是不适用的。
What is required is the ability to support multiple instances of the class (in our example, SpellChecker), each of which uses the resource desired by the client (in our example, the dictionary). A simple pattern that satisfies this requirement is to pass the resource into the constructor when creating a new instance. This is one form of dependency injection: the dictionary is a dependency of the spell checker and is injected into the spell checker when it is created.
我们需要的是能支持多个实例的类(例子中对应的是SpellChecker),每个实例使用对应客户端需要用到的资源(例子中对应的是dictionary)。有个简单的模式能满足这种需求,那就是在创建一个新的实例时将资源参数传入构造器。这是依赖注入(dependency injection)的一种形式:词典作为拼写检查器的依赖在检查器被创建时就被注入了。
// Dependency injection provides flexibility and testability
public class SpellChecker {
private final Lexicon dictionary;
public SpellChecker(Lexicon dictionary) {
this.dictionary = Objects.requireNonNull(dictionary);
}
public boolean isValid(String word) { ... }
public List<String> suggestions(String typo) { ... }
}
The dependency injection pattern is so simple that many programmers use it for years without knowing it has a name. While our spell checker example had only a single resource (the dictionary), dependency injection works with an arbitrary number of resources and arbitrary dependency graphs. It preserves immutability (Item 17), so multiple clients can share dependent objects (assuming the clients desire the same underlying resources). Dependency injection is equally applicable to constructors, static factories (Item 1), and builders (Item 2).
依赖注入模式是如此的简单,以至于很多程序员用了很多年都不知道它还有个名字。虽然在我们的例子中,拼写检查器只有单一的资源(字典),但依赖注入也能用于任意数量的资源依赖和任意依赖图。它保持了资源的不可变性(条目17),所以多个客户端之间可以共享相同的依赖对象(假设客户端需要用到相同的底层资源)。依赖注入不仅适用于构造器,也同样适用于静态工厂(条目1)和builder(条目2)。
A useful variant of the pattern is to pass a resource factory _to the constructor. A factory is an object that can be called repeatedly to create instances of a type. Such factories embody the _Factory Method pattern [Gamma95]. The Supplier<T> interface, introduced in Java 8, is perfect for representing factories. Methods that take a Supplier<T> on input should typically constrain the factory’s type parameter using a bounded wildcard type (Item 31) to allow the client to pass in a factory that creates any subtype of a specified type. For example, here is a method that makes a mosaic using a client-provided factory to produce each tile:
这种模式的一个有用的变体是,往构造器里传入一个资源工厂。这个工厂是一个能被重复调用并产生某个类型实例的对象。这些工厂是工厂方法模式(Factory Method pattern)[Gamma95]的体现。Java 8中引入的Supplier<T>接口就能很好地表示这些工厂。对于将Supplier<T>作为输入的方法,我们通常应该使用有界通配符类型(bounded wildcard type)来限制工厂的参数类型,以允许客户端能传入一个工厂,而这个工厂能创建指定类型任意子类型实例。例如,这里有个能利用客户端提供的工厂来创建一个马赛克的方法,这个工厂会产生各个打码块:
Mosaic create(Supplier<? extends Tile> tileFactory) { ... }
Although dependency injection greatly improves flexibility and testability, it can clutter up large projects, which typically contain thousands of dependencies. This clutter can be all but eliminated by using a dependency injection framework, such as Dagger [Dagger], Guice [Guice], or Spring [Spring]. The use of these frameworks is beyond the scope of this book, but note that APIs designed for manual dependency injection are trivially adapted for use by these frameworks.
尽管依赖注入提高了灵活性和可测试性,但它却会对大型项目产生混乱,这些大型项目往往包含了成千上万个依赖。我们可以通过使用依赖注入框架来减少这种混乱,比如Dagger,Guice,Spring。对于这些框架的使用超出了本书的讨论范围,但请注意,那些为手动依赖注入而设计的API非常适用于这些框架。
In summary, do not use a singleton or static utility class to implement a class that depends on one or more underlying resources whose behavior affects that of the class, and do not have the class create these resources directly. Instead, pass the resources, or factories to create them, into the constructor (or static factory or builder). This practice, known as dependency injection, will greatly enhance the flexibility, reusability, and testability of a class.
总的说来,对于需要依赖一个或多个底层资源的类,而且这些资源的行为还会影响到类时,我们不要用Singleton或者静态工具类类实现,也不要让类自己直接去创建这些资源,而是应该将这些资源或者创建资源的工厂传入构造器(或者静态工厂和builder)。这种依赖注入的实践能大幅增强类的灵活性,复用性和可测试性。