使用C# (.NET Core) 实现简单工厂(Simple Factory) 和工厂方法设计模式 (Factory Method Patt...
本文源自深入浅出设计模式. 只不过我是使用C#/.NET Core实现的例子.
前言
当你看见new这个关键字的时候, 就应该想到它是具体的实现.
这就是一个具体的类, 为了更灵活, 我们应该使用的是接口(interface).
有时候, 你可能会写出这样的代码:
这里有多个具体的类被实例化了, 是根据不同情况在运行时被实例化的.
当你看到这样的代码, 你就会知道当有需求需要对其进行修改或者扩展的时候, 你就得把这个文件打开, 然后看看在这里应该添加或者删除点什么. 这类的代码经常会分散在程序的多个地方, 这维护和更新起来就很麻烦而且容易出错.
针对interface进行编程的时候, 你知道可以把自己独立于系统未来可能要发生的变化. 为什么呢? 因为如果你针对interface编程, 那么对于任何实现了该接口的具体类对你来说都可以用, 多态吗.
项目原始需求
有一个前沿的披萨店, 做披萨, 下面是订购披萨的类:
new一个披萨, 然后按照工序进行加工 最后返回披萨.
但是, 一个披萨店不可能只有一种披萨, 可能会有很多中披萨, 所以你可能会这样修改代码:
根据传入的类型, 创建不同的披萨, 然后加工返回.
然后问题来了, 随着时间的推移, 一个披萨店会淘汰不畅销的披萨并添加新品种披萨.
使用上面的代码就会出现这个问题, 针对需求变化, 我不得不把OrderPizza的部分代码改来改去:
从这里, 我们也可以看到, 上半部分是会变化的部分, 下半部分是不变的部分, 所以它们应该分开(把变化的部分和不变的部分分开, 然后进行封装).
结构应该是这样的:
右上角是变化的部分, 把这部分封装到一个对象里, 它就是用来创建披萨的对象, 我们把这个对象叫做: 工厂.
工厂负责创建对象的细节工作. 我们创建的这个工厂叫做SimplePizzaFactory, 而orderPizza()这个方法就是该工厂的一个客户(client).
任何时候客户需要披萨的时候, 披萨工厂就会给客户创建一个披萨.
接下来, 我们就建立这个简易的披萨工厂:
就是通过传入的类型参数, 建立并返回不同类型的披萨.
这样我们就把披萨创建的工作封装到了一个类里面, 发生变化的时候, 只需要修改这一个类即可.
注意: 有时候上面这种简单工厂可以使用静态方法, 但是这样也有缺点, 就是无法通过继承来扩展这个工厂了.
回来修改PizzaStore这个类:
工厂是从构造函数传入的, 并在PizzaStore里面保留一个引用.
在OrderPizza()方法里面, 我们使用工厂的创建方法代替了new关键字, 所以在这里没有具体的实例化.
简单工厂的定义
简单/简易工厂并不是一个设计模式, 更多是一个编程习惯. 但是使用的非常广泛.
简单工厂类图:
这个很简单, 就不解释了.
简单工厂就到这, 下面要讲两个重量级的工厂模式.
用C#/.NET Core实现简单工厂
Pizza父类:
using System; using System.Collections.Generic; namespace SimpleFactory.Pizzas { public abstract class Pizza { public string Name { get; protected set; } public string Dough { get; protected set; } public string Sauce { get; protected set; } protected List<string> Toppings = new List<string>(); public void Prepare() { Console.WriteLine($"Preparing: {Name}"); Console.WriteLine($"Tossing: {Dough}"); Console.WriteLine($"Adding sauce: {Sauce}"); Console.WriteLine("Adding toppings: "); Toppings.ForEach(x => Console.WriteLine($" {x}")); } public void Bake() { Console.WriteLine("Bake for 25 minutes"); } public void Cut() { Console.WriteLine("Cutting the pizza into diagnol slices"); } public void Box() { Console.WriteLine("Placing pizza in official PizzaStore box......"); } } }
各种Pizza:
namespace SimpleFactory.Pizzas { public class CheesePizza: Pizza { public CheesePizza() { Name = "Cheese Pizza"; Dough = "Think Dough"; Sauce = "Salad"; Toppings.Add("Grated Reggiano Cheese"); } } } namespace SimpleFactory.Pizzas { public class ClamPizza: Pizza { public ClamPizza() { Name = "Clam Pizza"; Sauce = "Tomato sauce"; Dough = "Soft dough"; Toppings.Add("Shrimp meat"); } } } namespace SimpleFactory.Pizzas { public class PepperoniPizza: Pizza { public PepperoniPizza() { Name = "Pepperoni Pizza"; Dough = "Thin dough"; Sauce = "Black pepper"; Toppings.Add("Beef Granules"); Toppings.Add("Niblet"); } } }
简单工厂:
using SimpleFactory.Pizzas; namespace SimpleFactory { public class SimplePizzaFactory { public Pizza CreatePizza(string type) { Pizza pizza = null; switch (type) { case "cheese": pizza = new CheesePizza(); break; case "pepperoni": pizza = new PepperoniPizza(); break; case "clam": pizza = new ClamPizza(); break; } return pizza; } } }
PizzaStore:
using SimpleFactory.Pizzas; namespace SimpleFactory { public class PizzaStore { private readonly SimplePizzaFactory _factory; public PizzaStore(SimplePizzaFactory factory) { _factory = factory; } public Pizza OrderPizza(string type) { var pizza = _factory.CreatePizza(type); pizza.Prepare(); pizza.Bake(); pizza.Cut(); pizza.Box(); return pizza; } } }
测试运行:
using System; namespace SimpleFactory { class Program { static void Main(string[] args) { var pizzaStore = new PizzaStore(new SimplePizzaFactory()); var cheesePizza = pizzaStore.OrderPizza("cheese"); Console.WriteLine(); var clamPizza = pizzaStore.OrderPizza("pepperoni"); Console.ReadKey(); } } }
需求变更 - 授权连锁披萨店
披萨店开的很好, 所以老板在全国各地开授权连锁分店了, 而每个地点的分店根据当地居民的口味, 它们所提供的披萨种类可能会不同.
例如纽约和芝加哥和加利福尼亚的就有可能不同.
针对这个需求, 我们可能会想到的第一种办法就是: 把SimplePizzaFactory抽取出来, 分别建立三个地点的工厂, 然后根据地点把相应的工厂组合到PizzaStore
代码是这样的:
纽约:
芝加哥:
因为个连锁店分布在各地, 老板想做质量管控: 做披萨的基本工序应该是一样的, 但是针对某种披萨各地可以有不同的风格做法.
所以我们把createPizza()方法放回到PizzaStore, 但这次它是抽象方法, 然后各地都会创建自己的PIzzaStore:
下面是纽约和芝加哥的披萨店:
针对每种披萨, 纽约和芝加哥可能会有自己风格具体实现的披萨.
orderPizza()方法是在父类/抽象类里面实现的, 这里的披萨还是抽象的, 所以它并不知道是PizzaStore的哪个子类来做的披萨.
代码运行的时候, orderPizza()会调用createPizza()方法, PizzaStore的某个子类肯定会对此负责.
所以你哪个地方的PizzaStore, 就会决定产出的是哪个地方特产的披萨.
下面就创建PizzaStore, 例如纽约的:
其他地点的都差不多, 就不贴图了.
如何声明一个工厂方法
还是看这张图:
抽象的PizzaStore把订购披萨的固定工序orderPizza()放在了抽象类里面.
创建披萨createPizza()方法是在各地的披萨店里做实现.
用一行代码来解释工厂方法就是:
工厂方法是让其子类具体来实现对象创建的工作. 这样就把父类中的客户代码和子类的创建对象部分的代码解耦了.
上面工作做的挺好, 但是还差一件事....披萨.
首先抽象父类:
里面定义了调味料和工序
然后具体的披萨:
纽约的奶酪披萨
芝加哥的奶酪披萨
最后运行一下:
工厂方法模式
所有的工厂模式都会封装对象的创建过程, 而工厂方法模式把对象创建的动作交给了子类, 并让它决定创建哪些对象.
创建者:
产品:
看看另外一种结构 -- 并行的类结构:
工厂方法模式的定义:
工厂方法模式定义了一个创建对象的接口, 但是让子类来决定具体创建的是哪一个对象. 工厂方法让一个类延迟实例化, 直到子类的出现.
左边是产品, 所有具体的产品都应该继承于同一个父类/接口.
右边的Creator类里面包含所有方法的实现除了抽象的工厂方法. 这个抽象的工厂方法在Creator的子类里面必须进行实现, 产品就是在子类具体实现的工厂方法里面创造出来的.
设计原则 -- 应该依赖于抽象, 而不依赖于具体的类
这就是著名的: DIP (Dependency Inversion Principle) 依赖反转原则.
进一步解释就是: 高级别的组件不应该依赖于低级别的组件, 它们都应该依赖于抽线.
高级别组件, 就是它有一组行为定义在另外一堆低级别的组件里面了.
例如PizzaStore就是高级别的, 具体的披萨就是低级别的.
应该该设计原则后:
这时它们都依赖于抽象的披萨父类了.
实现该原则的三点指导建议
- 没有变量引用具体的类(可已使用工厂代替创建这个具体的类)
- 没有类派生于具体的类(派生于它就依赖于它)
- 不去重写(override)其任一父类的已实现方法(如果重写了, 那么这个类并不适合作为起始的抽象类, 因为基类里面的方法本应该是共享与所有子类的)
和其它原则一样, 只是尽力去按照这三点建议去执行, 并不是必须一直要这么做.
C#/.NET Core的代码实现
各种pizza:
namespace FactoryMethodPattern.Pizzas { public class ChicagoCheesePizza : Pizza { public ChicagoCheesePizza() { Name = "Chicago Cheese Pizza"; Dough = "Think Dough 1"; Sauce = "Salad 1"; Toppings.Add("Grated Reggiano Cheese 1"); } } } namespace FactoryMethodPattern.Pizzas { public class ChicagoClamPizza : Pizza { public ChicagoClamPizza() { Name = "Chicago Clam Pizza"; Sauce = "Tomato sauce 1"; Dough = "Soft dough 1"; Toppings.Add("Shrimp meat 1"); } } } namespace FactoryMethodPattern.Pizzas { public class ChicagoPepperoniPizza : Pizza { public ChicagoPepperoniPizza() { Name = "Chicago Pepperoni Pizza"; Dough = "Thin dough 1"; Sauce = "Black pepper 1"; Toppings.Add("Beef Granules 1"); Toppings.Add("Niblet 1"); } } } namespace FactoryMethodPattern.Pizzas { public class NYCheesePizza: Pizza { public NYCheesePizza() { Name = "NY Cheese Pizza"; Dough = "Think Dough 2"; Sauce = "Salad 2"; Toppings.Add("Grated Reggiano Cheese 2"); } } } namespace FactoryMethodPattern.Pizzas { public class NYClamPizza: Pizza { public NYClamPizza() { Name = "NY Clam Pizza"; Sauce = "Tomato sauce 2"; Dough = "Soft dough 2"; Toppings.Add("Shrimp meat 2"); } } } namespace FactoryMethodPattern.Pizzas { public class NYPepperoniPizza: Pizza { public NYPepperoniPizza() { Name = "NY Pepperoni Pizza"; Dough = "Thin dough 2"; Sauce = "Black pepper 2"; Toppings.Add("Beef Granules 2"); Toppings.Add("Niblet 2"); } } }
披萨店抽象父类:
using FactoryMethodPattern.Pizzas; namespace FactoryMethodPattern { public abstract class PizzaStore { public Pizza OrderPizza(string type) { var pizza = CreatePizza(type); pizza.Prepare(); pizza.Bake(); pizza.Cut(); pizza.Box(); return pizza; } protected abstract Pizza CreatePizza(string type); } }
Chicago披萨店:
using FactoryMethodPattern.Pizzas; namespace FactoryMethodPattern { public class ChicagoPizzaStore: PizzaStore { protected override Pizza CreatePizza(string type) { Pizza pizza = null; switch (type) { case "cheese": pizza = new ChicagoCheesePizza(); break; case "pepperoni": pizza = new ChicagoPepperoniPizza(); break; case "clam": pizza = new ChicagoClamPizza(); break; } return pizza; } } }
纽约披萨店:
using FactoryMethodPattern.Pizzas; namespace FactoryMethodPattern { public class NYPizzaStore : PizzaStore { protected override Pizza CreatePizza(string type) { Pizza pizza = null; switch (type) { case "cheese": pizza = new NYCheesePizza(); break; case "pepperoni": pizza = new NYPepperoniPizza(); break; case "clam": pizza = new NYClamPizza(); break; } return pizza; } } }
测试运行:
using System; namespace FactoryMethodPattern { class Program { static void Main(string[] args) { var nyStore = new NYPizzaStore(); var chicagoStore = new ChicagoPizzaStore(); var pizza = nyStore.OrderPizza("cheese"); Console.WriteLine($"Ordered a {pizza.Name} in NY"); Console.WriteLine(); var pizza2 = chicagoStore.OrderPizza("cheese"); Console.WriteLine($"Ordered a {pizza2.Name} in Chicago"); Console.ReadKey(); } } }
下面是我的关于ASP.NET Core Web API相关技术的公众号--草根专栏:
