From 78a5165346dfa80de29e7e30a1fdae04c5253eca Mon Sep 17 00:00:00 2001 From: dashan Date: Tue, 1 Nov 2022 22:25:35 +0800 Subject: [PATCH] up doc --- Untitled.md | 0 设计模式/创建型/工厂模式-工厂方法.md | 92 +++++++++++++++++++++++----- 设计模式/创建型/工厂模式-抽象工厂.md | 66 ++++++++++++++++++++ 设计模式/创建型/建造者模式.md | 37 +++++++++++ 4 files changed, 181 insertions(+), 14 deletions(-) delete mode 100644 Untitled.md diff --git a/Untitled.md b/Untitled.md deleted file mode 100644 index e69de29..0000000 diff --git a/设计模式/创建型/工厂模式-工厂方法.md b/设计模式/创建型/工厂模式-工厂方法.md index 6b87291..03d86e8 100644 --- a/设计模式/创建型/工厂模式-工厂方法.md +++ b/设计模式/创建型/工厂模式-工厂方法.md @@ -2,7 +2,7 @@ 工厂模式分为工厂方法和抽象工厂，工厂方法原理比较简单，在实际的项目中也比较常用。而抽象工厂的原理稍微复杂点，在实际的项目中相对也不常用；本章讲解工厂模式的用法和示例。工厂方法又分为简单工厂（Simple Factory）和工厂方法（Factory Method）两种，其中简单工厂还叫作静态工厂方法模式（Static Factory Method Pattern），之所以叫静态工厂方法模式，是因为其中创建对象的方法是静态的。 -### 实例① +### 示例① 在下面这段代码中，我们根据配置文件的后缀（json、xml、yaml、properties），选择不同的解析器（JsonRuleConfigParser、XmlRuleConfigParser……），将存储在文件中的配置解析成内存对象 RuleConfig。接下来我们分别用简单工厂和工厂方法来优化这段代码 @@ -39,10 +39,10 @@ public class RuleConfigSource { ### 简单工厂（Simple Factory） -使用简单工厂对实例①代码进行重构，我们可以将代码中涉及 parser 创建的部分逻辑剥离出来，抽象成 createParser() 函数；为了让类的职责更加单一、代码更加清晰，我们还可以进一步将 createParser() 函数剥离到一个独立的类中，让这个类只负责对象的创建。而这个类就是我们现在要讲的简单工厂模式类。具体的代码如下所示： - #### 方法一： +使用简单工厂对示例①代码进行重构，我们可以将代码中涉及 parser 创建的部分逻辑剥离出来，抽象成 createParser() 函数；为了让类的职责更加单一、代码更加清晰，我们还可以进一步将 createParser() 函数剥离到一个独立的类中，让这个类只负责对象的创建。而这个类就是我们现在要讲的简单工厂模式类。具体的代码如下所示： + ```java public class RuleConfigSource { @@ -119,7 +119,77 @@ public class RuleConfigParserFactory { ### 工厂方法（Factory Method） -对上面的代码进行重构 +使用工厂方法对示例①进行重构，下面就是工厂方法模式的典型代码实现。这样当我们新增一种 parser 的时候，只需要新增一个实现IRuleConfigParserFactory 接口的 Factory 类即可。所以，**工厂方法模式比起简单工厂模式更加符合开闭原则**。 + +```java + +public interface IRuleConfigParserFactory { + IRuleConfigParser createParser(); +} + +public class JsonRuleConfigParserFactory implements IRuleConfigParserFactory { + @Override + public IRuleConfigParser createParser() { + return new JsonRuleConfigParser(); + } +} + +public class XmlRuleConfigParserFactory implements IRuleConfigParserFactory { + @Override + public IRuleConfigParser createParser() { + return new XmlRuleConfigParser(); + } +} + +public class YamlRuleConfigParserFactory implements IRuleConfigParserFactory { + @Override + public IRuleConfigParser createParser() { + return new YamlRuleConfigParser(); + } +} + +public class PropertiesRuleConfigParserFactory implements IRuleConfigParserFactory { + @Override + public IRuleConfigParser createParser() { + return new PropertiesRuleConfigParser(); + } +} + + +public class RuleConfigSource { + public RuleConfig load(String ruleConfigFilePath) { + String ruleConfigFileExtension = getFileExtension(ruleConfigFilePath); + + IRuleConfigParserFactory parserFactory = null; + if ("json".equalsIgnoreCase(ruleConfigFileExtension)) { + parserFactory = new JsonRuleConfigParserFactory(); + } else if ("xml".equalsIgnoreCase(ruleConfigFileExtension)) { + parserFactory = new XmlRuleConfigParserFactory(); + } else if ("yaml".equalsIgnoreCase(ruleConfigFileExtension)) { + parserFactory = new YamlRuleConfigParserFactory(); + } else if ("properties".equalsIgnoreCase(ruleConfigFileExtension)) { + parserFactory = new PropertiesRuleConfigParserFactory(); + } else { + throw new InvalidRuleConfigException("Rule config file format is not supported: " + ruleConfigFilePath); + } + IRuleConfigParser parser = parserFactory.createParser(); + + String configText = ""; + //从ruleConfigFilePath文件中读取配置文本到configText中 + RuleConfig ruleConfig = parser.parse(configText); + return ruleConfig; + } + + private String getFileExtension(String filePath) { + //...解析文件名获取扩展名，比如rule.json，返回json + return "json"; + } +} +``` + +从上面的代码实现来看，工厂类对象的创建逻辑又耦合进了 load() 函数中，跟我们最初的代码版本非常相似，引入工厂方法非但没有解决问题，反倒让设计变得更加复杂了。 + +我们可以为工厂类再创建一个简单工厂，也就是工厂的工厂，用来创建工厂类对象。 ```java @@ -167,15 +237,7 @@ public class RuleConfigParserFactoryMap { //工厂的工厂 } ``` - - - - -### - -我们前面提到，之所以将某个代码块剥离出来，独立为函数或者类，原因是这个代码块的逻辑过于复杂，剥离之后能让代码更加清晰，更加可读、可维护。但是，如果代码块本身并不复杂，就几行代码而已，我们完全没必要将它拆分成单独的函数或者类。基于这个设计思想，当对象的创建逻辑比较复杂，不只是简单的 new 一下就可以，而是要组合其他类对象，做各种初始化操作的时候，我们推荐使用工厂方法模式，将复杂的创建逻辑拆分到多个工厂类中，让每个工厂类都不至于过于复杂。而使用简单工厂模式，将所有的创建逻辑都放到一个工厂类中，会导致这个工厂类变得很复杂。除此之外，在某些场景下，如果对象不可复用，那工厂类每次都要返回不同的对象。如果我们使用简单工厂模式来实现，就只能选择第一种包含 if 分支逻辑的实现方式。如果我们还想避免烦人的 if-else 分支逻辑，这个时候，我们就推荐使用工厂方法模式。 - - +> 之所以将某个代码块剥离出来，独立为函数或者类，原因是这个代码块的逻辑过于复杂，剥离之后能让代码更加清晰，更加可读、可维护。但是，如果代码块本身并不复杂，就几行代码而已，我们完全没必要将它拆分成单独的函数或者类。 ### 总结 @@ -184,7 +246,9 @@ public class RuleConfigParserFactoryMap { //工厂的工厂 + 第一种情况：类似规则配置解析的例子，代码中存在 if-else 分支判断，动态地根据不同的类型创建不同的对象。针对这种情况，我们就考虑使用工厂模式，将这一大坨 if-else 创建对象的代码抽离出来，放到工厂类中。 + 还有一种情况，尽管我们不需要根据不同的类型创建不同的对象，但是，单个对象本身的创建过程比较复杂，比如前面提到的要组合其他类对象，做各种初始化操作。在这种情况下，我们也可以考虑使用工厂模式，将对象的创建过程封装到工厂类中。 -对于第一种情况，当每个对象的创建逻辑都比较简单的时候，我推荐使用简单工厂模式，将多个对象的创建逻辑放到一个工厂类中。当每个对象的创建逻辑都比较复杂的时候，为了避免设计一个过于庞大的简单工厂类，我推荐使用工厂方法模式，将创建逻辑拆分得更细，每个对象的创建逻辑独立到各自的工厂类中。同理，对于第二种情况，因为单个对象本身的创建逻辑就比较复杂，所以，我建议使用工厂方法模式。除了刚刚提到的这几种情况之外，如果创建对象的逻辑并不复杂，那我们就直接通过 new 来创建对象就可以了，不需要使用工厂模式。 +对于第一种情况，当每个对象的创建逻辑都比较简单的时候，我推荐使用简单工厂模式，将多个对象的创建逻辑放到一个工厂类中。 + +对于第二种情况，因为单个对象本身的创建逻辑就比较复杂，所以，我建议使用工厂方法模式。 **使用工厂模式最本质的参考标准：** diff --git a/设计模式/创建型/工厂模式-抽象工厂.md b/设计模式/创建型/工厂模式-抽象工厂.md index 8c4b4b9..440d6e3 100644 --- a/设计模式/创建型/工厂模式-抽象工厂.md +++ b/设计模式/创建型/工厂模式-抽象工厂.md @@ -1,2 +1,68 @@ ### 简述 +抽象工厂模式的应用场景比较特殊，没有简单工厂和工厂方法常用。 + +### 示例① + +继续以规则配置解析作为例子进行解释 + +在工厂方法规则配置解析那个例子中，解析器类只会根据配置文件格式（Json、Xml、Yaml……）来分类。但是，如果类有两种分类方式，比如，我们既可以按照配置文件格式来分类，也可以按照解析的对象（Rule 规则配置还是 System 系统配置）来分类，那就会对应下面这 8 个 parser 类。 + +| 文件格式\配置方式 | IRuleConfigParser | ISystemConfigParser | +| ----------------- | -------------------------- | ---------------------------- | +| Json | JsonRuleConfigParser | JsonSystemConfigParser | +| Xml | XmlRuleConfigParser | XmlSystemConfigParser | +| Yaml | YamlRuleConfigParser | YamlSystemConfigParser | +| Properties | PropertiesRuleConfigParser | PropertiesSystemConfigParser | + +针对这种特殊的场景，如果还是继续用工厂方法来实现的话，我们要针对每个 parser 都编写一个工厂类，也就是要编写 8 个工厂类。如果我们未来还需要增加针对业务配置的解析器（比如 IBizConfigParser见下方表格），那就要再对应地增加 4 个工厂类。而这样过多的类只会让我们的系统越来越难维护。 + +| 文件类型 | IRuleConfigParser | ISystemConfigParser | IBizConfigParser | +| ---------- | -------------------------- | ---------------------------- | ------------------------- | +| Json | JsonRuleConfigParser | JsonSystemConfigParser | JsonBizConfigParser | +| Xml | XmlRuleConfigParser | XmlSystemConfigParser | XmlBizConfigParser | +| Yaml | YamlRuleConfigParser | YamlSystemConfigParser | YamlBizConfigParser | +| Properties | PropertiesRuleConfigParser | PropertiesSystemConfigParser | PropertiesBizConfigParser | + +### 抽象工厂（Abstract Factory） + +抽象工厂就是针对这种非常特殊的场景而诞生的。我们可以让一个工厂负责创建多个不同类型的对象（IRuleConfigParser、ISystemConfigParser 等）,这样就可以有效地减少工厂类的个数。具体的代码实现如下所示： + +```java + +public interface IConfigParserFactory { + IRuleConfigParser createRuleParser(); + ISystemConfigParser createSystemParser(); + //此处可以扩展新的parser类型，比如IBizConfigParser +} + +public class JsonConfigParserFactory implements IConfigParserFactory { + @Override + public IRuleConfigParser createRuleParser() { + return new JsonRuleConfigParser(); + } + + @Override + public ISystemConfigParser createSystemParser() { + return new JsonSystemConfigParser(); + } +} + +public class XmlConfigParserFactory implements IConfigParserFactory { + @Override + public IRuleConfigParser createRuleParser() { + return new XmlRuleConfigParser(); + } + + @Override + public ISystemConfigParser createSystemParser() { + return new XmlSystemConfigParser(); + } +} + +// 省略YamlConfigParserFactory和PropertiesConfigParserFactory代码 +``` + +### 总结 + +相比工厂方法抽象工厂可以让一个工厂生产不同类型的对象，抽象工厂更适合根据多种特征分类，不会因为多种特征去分别创建不同的抽象工厂 diff --git a/设计模式/创建型/建造者模式.md b/设计模式/创建型/建造者模式.md index e69de29..4b89d97 100644 --- a/设计模式/创建型/建造者模式.md +++ b/设计模式/创建型/建造者模式.md @@ -0,0 +1,37 @@ +### 简述 + +Builder 模式，中文翻译为建造者模式或者构建者模式，也有人叫它生成器模式。 + +### 示例 + +假设有这样一道设计面试题：我们需要定义一个资源池配置类 ResourcePoolConfig。这里的资源池，你可以简单理解为线程池、连接池、对象池等。在这个资源池配置类中，有以下几个成员变量，也就是可配置项。现在，请你编写代码实现这个 ResourcePoolConfig 类。 + +| 成员变量 | 解释 | 是否必填？ | 默认值 | +| -------- | ---------------- | ---------- | ------ | +| name | 资源名称 | 是 | 无 | +| maxTotal | 最大总资源数量 | 否 | 8 | +| maxIdle | 最大空闲资源数量 | 否 | 8 | +| minIdle | 最小空闲资源数量 | 否 | 0 | + + + +### 总结 + +工厂模式和建造者模式的区别：工厂模式是用来创建不同但是相关类型的对象（继承同一父类或者接口的一组子类），由给定的参数来决定创建哪种类型的对象。建造者模式是用来创建一种类型的复杂对象，通过设置不同的可选参数，“定制化”地创建不同的对象。 + +如果一个类中有很多属性，为了避免构造函数的参数列表过长，影响代码的可读性和易用性，我们可以通过构造函数配合 set() 方法来解决。但是，如果存在下面情况中的任意一种，我们就要考虑使用建造者模式了。 + +- **依赖关系（Dependencies）** + + 我们把类的必填属性放到构造函数中，强制创建对象的时候就设置。如果必填的属性有很多，把这些必填属性都放到构造函数中设置，那构造函数就又会出现参数列表很长的问题。如果我们把必填属性通过 set() 方法设置，那校验这些必填属性是否已经填写的逻辑就无处安放了。 + +- **合法校验（Preconditions）** + + 如果类的属性之间有一定的依赖关系或者约束条件，我们继续使用构造函数配合 set() 方法的设计思路，那这些依赖关系或约束条件的校验逻辑就无处安放了。 + +- **不可变（Immutable）** + + 如果我们希望创建不可变对象，也就是说，对象在创建好之后，就不能再修改内部的属性值，要实现这个功能，我们就不能在类中暴露 set() 方法。构造函数配合 set() 方法来设置属性值的方式就不适用了。 + +### +