05. 依赖注入优于硬连接资源(hardwiring resources)

  许多类依赖于一个或多个底层资源。例如,拼写检查器依赖于字典。将此类类实现为静态工具类并不少见 (详见第 4 条):

  1. // Inappropriate use of static utility - inflexible & untestable!
  2. public class SpellChecker {
  3. private static final Lexicon dictionary = ...;
  4. private SpellChecker() {} // Noninstantiable
  5. public static boolean isValid(String word) { ... }
  6. public static List<String> suggestions(String typo) { ... }
  7. }

  同样地,将它们实现为单例的做法也并不少见(详见第 3 条):

  1. // Inappropriate use of singleton - inflexible & untestable!
  2. public class SpellChecker {
  3. private final Lexicon dictionary = ...;
  4. private SpellChecker(...) {}
  5. public static INSTANCE = new SpellChecker(...);
  6. public boolean isValid(String word) { ... }
  7. public List<String> suggestions(String typo) { ... }
  8. }

  这两种方法都不令人满意,因为他们都是假设只有一本字典可用。实际上,每种语言都有自己的字典,特殊的字典被用于特殊的词汇表。另外,可能还需要用特殊的词典进行测试。想当然地认为一本字典就足够了,这是一厢情愿的想法。

  可以通过使 dictionary 属性设置为非 final,并添加一个方法来更改现有拼写检查器中的字典,从而让SpellChecker 支持多个字典,但是这样的设置显得非常笨拙、容易出错、并且无法并行工作。静态工具类和单例类不适合与需要引用底层资源的类。

  这里所需要的是能够支持类的多个实例 (在我们的示例中是指 SpellChecker),每个实例都使用客户端所期望的资源(在我们的例子中是 dictionary)。满足这一需求的简单模式是,在创建新实例时将资源传递到构造器中。 这是依赖项注入(dependency injection)的一种形式:字典是拼写检查器的一个依赖项,当它创建时被注入到拼写检查器中。

  1. // Dependency injection provides flexibility and testability
  2. public class SpellChecker {
  3. private final Lexicon dictionary;
  4. public SpellChecker(Lexicon dictionary) {
  5. this.dictionary = Objects.requireNonNull(dictionary);
  6. }
  7. public boolean isValid(String word) { ... }
  8. public List<String> suggestions(String typo) { ... }
  9. }

  依赖注入模式非常简单,许多程序员使用它多年而不知道它有一个名字。 虽然我们的拼写检查器的例子只有一个资源(字典),但是依赖项注入可以使用任意数量的资源和任意依赖图。 它保持了不变性(详见第 17 条),因此多个客户端可以共享依赖对象(假设客户需要相同的底层资源)。 依赖注入同样适用于构造器、静态工厂(详见第 1 条)和 builder 模式(详见第 2 条)。

  该模式的一个有用的变体是将资源工厂传递给构造器。 工厂是可以重复调用以创建类型实例的对象。 这种工厂体现了工厂方法模式(Factory Method pattern)[Gamma95]。 Java 8 中引入的 Supplier<T> 接口非常适合代表工厂。 在输入上采用 Supplier<T> 的方法通常应该使用有界的通配符类型(bounded wildcard type)(详见第 31 条)约束工厂的类型参数,以便客户端能够传入一个工厂,来创建指定类型的任意子类型。例如,下面是一个生产马赛克的方法,它利用客户端提供的工厂来生产每一片马赛克:

  1. Mosaic create(Supplier<? extends Tile> tileFactory) { ... }

  尽管依赖注入极大地提高了灵活性和可测试性,但它可能使大型项目变得混乱,这些项目通常包含数千个依赖项。使用依赖注入框架(如 Dagger [Dagger]、Guice [Guice] 或 Spring [Spring])可以消除这些混乱。这些框架的使用超出了本书的范围,但是请注意,为手动依赖注入而设计的 API 非常适合这些框架的使用。

  总而言之,不要用单例和静态工具类来实现依赖一个或多个底层资源的类,且该资源的行为会影响到该类的行为;也不要直接用这个类来创建这些资源。而应该将这些资源或者工厂传给构造器(或者静态工厂,或者构建器),通过它们来创建类。这个实践就被称作依赖注人,它极大地提升了类的灵活性、可重用性和可测试性。