一般情况下,工厂模式(Factory Design Pattern)分为三种类型:简单工厂、工厂方法和抽象工厂。

简单工厂

首先,我们来看,什么是简单工厂模式。我们通过一个例子来解释一下。

在下面这段代码中,本意是我们根据配置文件的后缀(json、xml、yaml、properties),选择不同的解析器(JsonRuleConfigParser、XmlRuleConfigParser……)将配置文件解析成 RuleConfig 对象。

  1. public class RuleConfigSource {
  2. public RuleConfig load(String ruleConfigFilePath) {
  3. // 获取文件后缀
  4. String ruleConfigFileExtension = getFileExtension(ruleConfigFilePath);
  5. // 选择不同的解析器
  6. IRuleConfigParser parser = null;
  7. if ("json".equalsIgnoreCase(ruleConfigFileExtension)) {
  8. parser = new JsonRuleConfigParser();
  9. } else if ("xml".equalsIgnoreCase(ruleConfigFileExtension)) {
  10. parser = new XmlRuleConfigParser();
  11. } else if ("yaml".equalsIgnoreCase(ruleConfigFileExtension)) {
  12. parser = new YamlRuleConfigParser();
  13. } else if ("properties".equalsIgnoreCase(ruleConfigFileExtension)) {
  14. parser = new PropertiesRuleConfigParser();
  15. } else {
  16. throw new InvalidRuleConfigException(
  17. "Rule config file format is not supported: " + ruleConfigFilePath);
  18. }
  19. // 解析配置
  20. return parser.parse(ruleConfigFilePath);
  21. }
  22. }

为了让代码逻辑更加清晰,可读性更好,我们要善于将功能独立的代码块封装成函数。按照这个设计思路,我们可以将代码中涉及 parser 创建的部分逻辑剥离出来,抽象成 createParser() 函数。同时,为了让类的职责更加单一、代码更加清晰,我们还可以进一步将 createParser() 函数剥离到一个独立的类中,让这个类只负责对象的创建。而这个类就是简单工厂模式类。具体的代码如下所示:

  1. public class RuleConfigSource {
  2. public RuleConfig load(String ruleConfigFilePath) {
  3. // 获取文件后缀
  4. String ruleConfigFileExtension = getFileExtension(ruleConfigFilePath);
  5. // 通过工厂类获取解析器对象
  6. IRuleConfigParser parser = RuleConfigParserFactory.createParser(ruleConfigFileExtension);
  7. if (parser == null) {
  8. throw new InvalidRuleConfigException(
  9. "Rule config file format is not supported: " + ruleConfigFilePath);
  10. }
  11. // 解析配置
  12. return parser.parse(ruleConfigFilePath);
  13. }
  14. }
  15. public class RuleConfigParserFactory {
  16. public static IRuleConfigParser createParser(String configFormat) {
  17. IRuleConfigParser parser = null;
  18. if ("json".equalsIgnoreCase(configFormat)) {
  19. parser = new JsonRuleConfigParser();
  20. } else if ("xml".equalsIgnoreCase(configFormat)) {
  21. parser = new XmlRuleConfigParser();
  22. } else if ("yaml".equalsIgnoreCase(configFormat)) {
  23. parser = new YamlRuleConfigParser();
  24. } else if ("properties".equalsIgnoreCase(configFormat)) {
  25. parser = new PropertiesRuleConfigParser();
  26. }
  27. return parser;
  28. }
  29. }

大部分工厂类都是以“Factory”单词结尾,但也有例外,比如 Java 中的 DateFormat、Calender。除此之外,工厂类中创建对象的方法一般都是 create 开头,比如代码中的 createParser(),但有的也命名为 getInstance()、createInstance()、newInstance(),有的甚至命名为 valueOf()(比如 Java String 类的 valueOf() 函数)等,这个根据具体的场景和习惯来命名就好。

在上面的代码实现中,我们每次调用 RuleConfigParserFactory 的 createParser() 的时候,都要创建一个新的 parser。实际上,如果 parser 可以复用,为了节省内存和对象创建的时间,我们可以将 parser 事先创建好缓存起来。当调用 createParser() 函数时,我们从缓存中取出 parser 对象直接使用。这有点类似单例模式和简单工厂模式的结合,具体的代码实现如下所示。

  1. public class RuleConfigParserFactory {
  2. private static final Map<String, RuleConfigParser> cachedParsers = new HashMap<>();
  3. static {
  4. cachedParsers.put("json", new JsonRuleConfigParser());
  5. cachedParsers.put("xml", new XmlRuleConfigParser());
  6. cachedParsers.put("yaml", new YamlRuleConfigParser());
  7. cachedParsers.put("properties", new PropertiesRuleConfigParser());
  8. }
  9. public static IRuleConfigParser createParser(String configFormat) {
  10. if (configFormat == null || configFormat.isEmpty()) {
  11. return null;
  12. }
  13. return cachedParsers.get(configFormat.toLowerCase());
  14. }
  15. }

对于上面两种简单工厂的实现方法,如果我们要添加新的 parser,那势必要改动 RuleConfigParserFactory 的代码,那这是不是违反开闭原则呢?实际上,如果不是需要频繁地添加新的 parser,只是偶尔修改一下 RuleConfigParserFactory 代码,稍微不符合开闭原则,也是完全可以接受的。

除此之外,在 RuleConfigParserFactory 的第一种代码实现中,有一组 if 分支判断逻辑,是不是应该用多态或其他设计模式来替代呢?实际上,如果 if 分支并不是很多,代码中有 if 分支也是完全可以接受的。应用多态或设计模式来替代 if 分支判断逻辑,也并不是没有任何缺点的,它虽然提高了代码的扩展性,更加符合开闭原则,但也增加了类的个数,牺牲了代码的可读性。

工厂方法

如果我们非得要将 if 分支逻辑去掉,那该怎么办呢?比较经典的处理方法就是利用多态。按照多态的实现思路对上面的代码进行重构。重构后的代码如下所示:

  1. public interface IRuleConfigParserFactory {
  2. IRuleConfigParser createParser();
  3. }
  4. public class JsonRuleConfigParserFactory implements IRuleConfigParserFactory {
  5. @Override
  6. public IRuleConfigParser createParser() {
  7. return new JsonRuleConfigParser();
  8. }
  9. }
  10. public class XmlRuleConfigParserFactory implements IRuleConfigParserFactory {
  11. @Override
  12. public IRuleConfigParser createParser() {
  13. return new XmlRuleConfigParser();
  14. }
  15. }
  16. public class YamlRuleConfigParserFactory implements IRuleConfigParserFactory {
  17. @Override
  18. public IRuleConfigParser createParser() {
  19. return new YamlRuleConfigParser();
  20. }
  21. }
  22. public class PropertiesRuleConfigParserFactory implements IRuleConfigParserFactory {
  23. @Override
  24. public IRuleConfigParser createParser() {
  25. return new PropertiesRuleConfigParser();
  26. }
  27. }

实际上,这就是工厂方法模式的典型代码实现。这样当我们新增一种 parser 的时候,只需要新增一个实现了 IRuleConfigParserFactory 接口的子类即可。所以,工厂方法模式比起简单工厂模式更加符合开闭原则

从上面的工厂方法的实现来看,一切都很完美,但实际上存在挺大的问题。问题存在于这些工厂类的使用上。接下来,我们看一下,如何用这些工厂类来实现 RuleConfigSource 的 load() 函数。具体的代码如下:

  1. public class RuleConfigSource {
  2. public RuleConfig load(String ruleConfigFilePath) {
  3. // 获取扩展名
  4. String ruleConfigFileExtension = getFileExtension(ruleConfigFilePath);
  5. // 获取parse工厂对象
  6. IRuleConfigParserFactory parserFactory = null;
  7. if ("json".equalsIgnoreCase(ruleConfigFileExtension)) {
  8. parserFactory = new JsonRuleConfigParserFactory();
  9. } else if ("xml".equalsIgnoreCase(ruleConfigFileExtension)) {
  10. parserFactory = new XmlRuleConfigParserFactory();
  11. } else if ("yaml".equalsIgnoreCase(ruleConfigFileExtension)) {
  12. parserFactory = new YamlRuleConfigParserFactory();
  13. } else if ("properties".equalsIgnoreCase(ruleConfigFileExtension)) {
  14. parserFactory = new PropertiesRuleConfigParserFactory();
  15. } else {
  16. throw new InvalidRuleConfigException("Rule config file format is not supported: " + ruleConfigFilePath);
  17. }
  18. // 解析配置
  19. IRuleConfigParser parser = parserFactory.createParser();
  20. return parser.parse(ruleConfigFilePath);
  21. }
  22. }

从上面的代码实现来看,工厂类对象的创建逻辑又耦合进了 load() 函数中,跟最初的代码版本非常相似,引入工厂方法非但没有解决问题,反倒让设计变得更复杂了。那怎么来解决这个问题呢?

我们可以为工厂类再创建一个简单工厂,也就是工厂的工厂,用来创建工厂类对象。其中,RuleConfigParserFactoryMap 类是创建工厂对象的工厂类,getParserFactory() 返回的是缓存好的单例工厂对象。当我们需要添加新的规则配置解析器时,我们只需要创建新的 parser 类和 parser factory 类,并且在 RuleConfigParserFactoryMap 类中,将新的 parser factory 对象添加到 cachedFactories 中即可。代码的改动非常少,基本上符合开闭原则。

  1. public class RuleConfigSource {
  2. public RuleConfig load(String ruleConfigFilePath) {
  3. // 获取扩展名
  4. String ruleConfigFileExtension = getFileExtension(ruleConfigFilePath);
  5. // 获取parse工厂对象
  6. IRuleConfigParserFactory parserFactory = RuleConfigParserFactoryMap.getParserFactory(ruleConfigFileExtension);
  7. if (parserFactory == null) {
  8. throw new InvalidRuleConfigException("Rule config file format is not supported: " + ruleConfigFilePath);
  9. }
  10. IRuleConfigParser parser = parserFactory.createParser();
  11. return parser.parse(ruleConfigFilePath);
  12. }
  13. }
  14. public class RuleConfigParserFactoryMap {
  15. private static final Map<String, IRuleConfigParserFactory> cachedFactories = new HashMap<>();
  16. static {
  17. cachedFactories.put("json", new JsonRuleConfigParserFactory());
  18. cachedFactories.put("xml", new XmlRuleConfigParserFactory());
  19. cachedFactories.put("yaml", new YamlRuleConfigParserFactory());
  20. cachedFactories.put("properties", new PropertiesRuleConfigParserFactory());
  21. }
  22. public static IRuleConfigParserFactory getParserFactory(String type) {
  23. if (type == null || type.isEmpty()) {
  24. return null;
  25. }
  26. return cachedFactories.get(type.toLowerCase());
  27. }
  28. }

实际上,对于规则配置文件解析这个应用场景来说,工厂模式需要额外创建诸多 Factory 类,也会增加代码的复杂性,而且,每个 Factory 类只是做简单的 new 操作,功能非常简单,也没必要设计成独立的类。所以,在这个应用场景下,简单工厂模式简单好用,比工厂方法模式更加合适。

那什么时候该用工厂方法模式,而非简单工厂模式呢?

前面提到,之所以将某个代码块剥离出来,独立为函数或类,原因是这个代码块的逻辑过于复杂,剥离后能让代码更加清晰、可读。但是,如果代码块本身并不复杂,就几行代码而已,我们完全没必要将它拆分成单独的函数或者类。基于这个设计思想,当对象的创建逻辑比较复杂,比如要组合其他类对象,做各种初始化操作的时候,我们推荐使用工厂方法模式,将复杂的创建逻辑拆分到多个工厂类中,让每个工厂类都不至于过于复杂。而使用简单工厂模式,将所有的创建逻辑都放到一个工厂类中,会导致这个工厂类变得很复杂。

抽象工厂

未命名文件 (2).jpg
在简单工厂和工厂方法中,类只有一种分类方式。比如,在规则配置解析那个例子中,解析器类只会根据配置文件格式(Json、Xml、Yaml……)来分类。但是,如果类有两种分类方式,比如,我们既可以按照配置文件格式来分类,也可以按照解析的对象(Rule 规则配置还是 System 系统配置)来分类,那就会对应下面这 8 个 parser 的实现类。

  1. 针对规则配置的解析器:基于接口IRuleConfigParser
  2. JsonRuleConfigParser
  3. XmlRuleConfigParser
  4. YamlRuleConfigParser
  5. PropertiesRuleConfigParser
  6. 针对系统配置的解析器:基于接口ISystemConfigParser
  7. JsonSystemConfigParser
  8. XmlSystemConfigParser
  9. YamlSystemConfigParser
  10. PropertiesSystemConfigParser

针对这种特殊的场景,如果还是继续用工厂方法来实现的话,我们要针对每个 parser 都编写一个工厂类,也就是要编写 8 个工厂类。如果我们未来还需要增加针对业务配置的解析器(比如 IBizConfigParser),那就要再对应地增加 4 个工厂类。而我们知道,过多的类也会让系统难维护。这个问题该怎么解决呢?

抽象工厂就是针对这种非常特殊的场景而诞生的。我们可以让一个工厂负责创建多个不同类型的对象(IRuleConfigParser、ISystemConfigParser 等),而不是只创建一种 parser 对象。这样就可以有效地减少工厂类的个数。具体的代码实现如下所示:

  1. public interface IConfigParserFactory {
  2. // 针对规则配置的解析器
  3. IRuleConfigParser createRuleParser();
  4. // 针对系统配置的解析器
  5. ISystemConfigParser createSystemParser();
  6. // ...
  7. }
  8. public class JsonConfigParserFactory implements IConfigParserFactory {
  9. @Override
  10. public IRuleConfigParser createRuleParser() {
  11. return new JsonRuleConfigParser();
  12. }
  13. @Override
  14. public ISystemConfigParser createSystemParser() {
  15. return new JsonSystemConfigParser();
  16. }
  17. }
  18. public class XmlConfigParserFactory implements IConfigParserFactory {
  19. @Override
  20. public IRuleConfigParser createRuleParser() {
  21. return new XmlRuleConfigParser();
  22. }
  23. @Override
  24. public ISystemConfigParser createSystemParser() {
  25. return new XmlSystemConfigParser();
  26. }
  27. }
  28. ......

实际上,抽象工厂的任务就是定义一个负责创建一组产品的接口,接口内的每个方法都负责创建一个具体产品,相当于抽象工厂中的每个方法都是一个工厂方法。

工厂模式使用案例

1. Java Calendar 类

在前面讲到工厂模式的时候,大部分工厂类都是以 Factory 作为后缀来命名,并且工厂类主要负责创建对象这样一件事情。但在实际的项目开发中,工厂类的设计更加灵活。那我们就来看下,工厂模式在 Java JDK 中的一个应用:java.util.Calendar。从命名上,我们无法看出它是一个工厂类。

Calendar 类提供了大量跟日期相关的功能代码,同时,又提供了一个 getInstance() 工厂方法,用来根据不同的 TimeZone 和 Locale 创建不同的 Calendar 子类对象。也就是说,功能代码和工厂方法代码耦合在了一个类中。所以,即便我们去查看它的源码,如果不细心的话,也很难发现它用到了工厂模式。同时,因为它不单单只是一个工厂类,所以,它并没有以 Factory 作为后缀来命名。

Calendar 类的 getInstance() 工厂方法的相关核心代码如下。从代码中,我们可以看出,getInstance() 方法可以根据不同 TimeZone 和 Locale,创建不同的 Calendar 子类对象,比如 BuddhistCalendar、JapaneseImperialCalendar、GregorianCalendar,这些细节完全封装在工厂方法中,使用者只需要传递当前的时区和地址,就能够获得一个 Calendar 类对象来使用,而获得的对象具体是哪个 Calendar 子类的对象,使用者在使用的时候并不关心。

  1. public abstract class Calendar implements Serializable, Cloneable, Comparable<Calendar> {
  2. public static Calendar getInstance(TimeZone zone, Locale aLocale){
  3. return createCalendar(zone, aLocale);
  4. }
  5. private static Calendar createCalendar(TimeZone zone, Locale aLocale) {
  6. CalendarProvider provider = LocaleProviderAdapter.getAdapter(CalendarProvider.class, aLocale).getCalendarProvider();
  7. if (provider != null) {
  8. try {
  9. return provider.getInstance(zone, aLocale);
  10. } catch (IllegalArgumentException iae) {
  11. // fall back to the default instantiation
  12. }
  13. }
  14. Calendar cal = null;
  15. if (aLocale.hasExtensions()) {
  16. String caltype = aLocale.getUnicodeLocaleType("ca");
  17. if (caltype != null) {
  18. switch (caltype) {
  19. case "buddhist":
  20. cal = new BuddhistCalendar(zone, aLocale);
  21. break;
  22. case "japanese":
  23. cal = new JapaneseImperialCalendar(zone, aLocale);
  24. break;
  25. case "gregory":
  26. cal = new GregorianCalendar(zone, aLocale);
  27. break;
  28. }
  29. }
  30. }
  31. if (cal == null) {
  32. if (aLocale.getLanguage() == "th" && aLocale.getCountry() == "TH") {
  33. cal = new BuddhistCalendar(zone, aLocale);
  34. } else if (aLocale.getVariant() == "JP" && aLocale.getLanguage() == "ja" && aLocale.getCountry() == "JP") {
  35. cal = new JapaneseImperialCalendar(zone, aLocale);
  36. } else {
  37. cal = new GregorianCalendar(zone, aLocale);
  38. }
  39. }
  40. return cal;
  41. }
  42. }

2. Spring Bean 工厂

在 Spring 中,工厂模式最经典的应用莫过于实现 IOC 容器,对应的 Spring 源码主要是 BeanFactory 类和 ApplicationContext 相关类(AbstractApplicationContext、ClassPathXmlApplicationContext、FileSystemXmlApplicationContext…)。