查看: 2298|回复: 0

[ASP.NET教程] 使用C# (.NET Core) 实现迭代器设计模式 (Iterator Pattern)

发表于 2018-4-25 08:00:02

本文的概念来自深入浅出设计模式一书

项目需求

有两个饭店合并了, 它们各自有自己的菜单. 饭店合并之后要保留这两份菜单.

这两个菜单是这样的:

菜单项MenuItem的代码是这样的:

最初我们是这样设计的, 这是第一份菜单:

这是第2份菜单:

同时有两个菜单存在的问题

问题就是多个菜单把事情变复杂了. 例如: 如果一个服务员需要使用两份菜单的话, 那么她就无法很快的告诉客户有哪些菜是适合素食主义者的了.

服务员还有可能有这些需求:

打印菜单, 打印早餐菜单, 打印午餐菜单, 打印素食菜单, 判断某个菜是否是素食的.

首先我们尝试一下如何实现打印菜单:

1. 调用两个菜单上面的getMenuItem()方法来获取各自的菜单项, 由于它们的菜单不同, 所以需要写两段代码:

2. 打印两个菜单的菜单项, 同样也是两套代码:

3. 如果还有一份菜单, 那么就需要写三套代码....

现在就很麻烦了.

怎么解决这个问题

如果能找到一种方式让这两个菜单同时实现一个接口就好了. 我们已经知道, 要把变化的部分封装起来.

什么是变化的部分? 由于不同对象集合引起的遍历操作.

那我们试试;

1. 想要遍历早餐项, 我们使用ArrayList的size()和get()方法:

2. 想要遍历午餐项, 我们需要使用Array的length成员变量以及通过索引访问数组:

3. 如果我们创建一个对象, 把它叫做迭代器, 让它来封装我们遍历集合的方式怎么样?

这里, 我们需要早餐菜单创建一个迭代器, 如果还有剩余的菜单项没有遍历完, 就获取下一个菜单项.

4. 让我们在Array上试试:

初识迭代器模式

首先你需要知道这种模式依赖于一个迭代器接口. 例如这个:

hasNext()方法告诉我们集合中是否还有剩余的条目没有遍历到.

next()方法返回下一个条目.

有了这个接口, 我们可以在任何一种集合上实现该接口.:

修改代码

定义迭代器接口:

然后再DinerMenu上实现迭代器接口:

然后使用迭代器来修改DinerMenu菜单:

注意: 不要直接返回集合, 因为这样会暴露内部实现.

createIterator()方法返回的是迭代器的接口, 客户并不需要知道DinerMenu是如何维护菜单项的, 也不需要DinerMenu的迭代器是如何实现的. 它只是用迭代器来遍历菜单里面的条目.

最后服务员的代码如下:

测试代码:

我们做了哪些修改?

我们只是为菜单添加了createIterator()方法.

而现在, 菜单的实现被封装了, 服务员不知道菜单是如何保存菜单项的.

我们所需要的只是一个循环, 它可以多态的处理实现了迭代器接口的集合.

而服务员使用的是迭代器接口.

现在呢, 菜单还没有共同的接口, 这意味着服务员仍然被绑定在两个具体的菜单类上, 一会我们再说这个.

当前的设计图

目前就是两个菜单实现了同一套方法, 但是还没有实现同一个接口.

使用C#, .NET Core控制台项目进行实现

菜单项 MenuItem:

  1. namespace IteratorPattern.Menus
  2. {
  3. public class MenuItem
  4. {
  5. public string Name { get; }
  6. public string Description { get; }
  7. public bool Vegetarian { get; }
  8. public double Price { get; }
  9. public MenuItem(string name, string description, bool vegetarian, double price)
  10. {
  11. Name = name;
  12. Description = description;
  13. Vegetarian = vegetarian;
  14. Price = price;
  15. }
  16. }
  17. }
复制代码

迭代器接口 IMyIterator:

  1. namespace IteratorPattern.Abstractions
  2. {
  3. public interface IMyIterator
  4. {
  5. bool HasNext();
  6. object Next();
  7. }
  8. }
复制代码

两个菜单迭代器:

  1. using IteratorPattern.Abstractions;
  2. using IteratorPattern.Menus;
  3. namespace IteratorPattern.MenuIterators
  4. {
  5. public class MyDinerMenuIterator: IMyIterator
  6. {
  7. private readonly MenuItem[] _menuItems;
  8. private int _position;
  9. public MyDinerMenuIterator(MenuItem[] menuItems)
  10. {
  11. _menuItems = menuItems;
  12. }
  13. public bool HasNext()
  14. {
  15. if (_position >= _menuItems.Length || _menuItems[_position] == null)
  16. {
  17. return false;
  18. }
  19. return true;
  20. }
  21. public object Next()
  22. {
  23. var menuItem = _menuItems[_position];
  24. _position++;
  25. return menuItem;
  26. }
  27. }
  28. }
  29. using System.Collections;
  30. using IteratorPattern.Abstractions;
  31. namespace IteratorPattern.MenuIterators
  32. {
  33. public class MyPancakeHouseMenuIterator:IMyIterator
  34. {
  35. private readonly ArrayList _menuItems;
  36. private int _position;
  37. public MyPancakeHouseMenuIterator(ArrayList menuItems)
  38. {
  39. _menuItems = menuItems;
  40. }
  41. public bool HasNext()
  42. {
  43. if (_position >= _menuItems.Count || _menuItems[_position] == null)
  44. {
  45. return false;
  46. }
  47. _position++;
  48. return true;
  49. }
  50. public object Next()
  51. {
  52. var menuItem = _menuItems[_position];
  53. _position++;
  54. return menuItem;
  55. }
  56. }
  57. }
复制代码

两个菜单:

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Text;
  4. using IteratorPattern.Abstractions;
  5. using IteratorPattern.MenuIterators;
  6. namespace IteratorPattern.Menus
  7. {
  8. public class MyDinerMenu
  9. {
  10. private const int MaxItems = 6;
  11. private int _numberOfItems = 0;
  12. private MenuItem[] MenuItems { get; }
  13. public MyDinerMenu()
  14. {
  15. MenuItems = new MenuItem[MaxItems];
  16. AddItem("Vegetarian BLT", "(Fakin’) Bacon with lettuce & tomato on whole wheat", true, 2.99);
  17. AddItem("BLT", "Bacon with lettuce & tomato on whole wheat", false, 2.99);
  18. AddItem("Soup of the day", "Soup of the day, with a side of potato salad", false, 3.29);
  19. AddItem("Hotdog", "A hot dog, with saurkraut, relish, onions, topped with cheese", false, 3.05);
  20. }
  21. public void AddItem(string name, string description, bool vegetarian, double price)
  22. {
  23. var menuItem = new MenuItem(name, description, vegetarian, price);
  24. if (_numberOfItems >= MaxItems)
  25. {
  26. Console.WriteLine("Sorry, menu is full! Can't add item to menu");
  27. }
  28. else
  29. {
  30. MenuItems[_numberOfItems] = menuItem;
  31. _numberOfItems++;
  32. }
  33. }
  34. public IMyIterator CreateIterator()
  35. {
  36. return new MyDinerMenuIterator(MenuItems);
  37. }
  38. }
  39. }
  40. using System.Collections;
  41. using IteratorPattern.Abstractions;
  42. using IteratorPattern.MenuIterators;
  43. namespace IteratorPattern.Menus
  44. {
  45. public class MyPancakeHouseMenu
  46. {
  47. public ArrayList MenuItems { get; }
  48. public MyPancakeHouseMenu()
  49. {
  50. MenuItems = new ArrayList();
  51. AddItem("K&B’s Pancake Breakfast", "Pancakes with scrambled eggs, and toast", true, 2.99);
  52. AddItem("Regular Pancake Breakfast", "Pancakes with fried eggs, sausage", false, 2.99);
  53. AddItem("Blueberry Pancakes", "Pancakes made with fresh blueberries", true, 3.49);
  54. AddItem("Waffles", "Waffles, with your choice of blueberries or strawberries", true, 3.59);
  55. }
  56. public void AddItem(string name, string description, bool vegetarian, double price)
  57. {
  58. var menuItem = new MenuItem(name, description, vegetarian, price);
  59. MenuItems.Add(menuItem);
  60. }
  61. public IMyIterator CreateIterator()
  62. {
  63. return new MyPancakeHouseMenuIterator(MenuItems);
  64. }
  65. }
  66. }
复制代码

服务员 Waitress:

  1. using System;
  2. using IteratorPattern.Abstractions;
  3. using IteratorPattern.Menus;
  4. namespace IteratorPattern.Waitresses
  5. {
  6. public class MyWaitress
  7. {
  8. private readonly MyPancakeHouseMenu _pancakeHouseMenu;
  9. private readonly MyDinerMenu _dinerMenu;
  10. public MyWaitress(MyPancakeHouseMenu pancakeHouseMenu, MyDinerMenu dinerMenu)
  11. {
  12. _pancakeHouseMenu = pancakeHouseMenu;
  13. _dinerMenu = dinerMenu;
  14. }
  15. public void PrintMenu()
  16. {
  17. var pancakeIterator = _pancakeHouseMenu.CreateIterator();
  18. var dinerIterator = _dinerMenu.CreateIterator();
  19. Console.WriteLine("MENU\n--------------\nBREAKFIRST");
  20. PrintMenu(pancakeIterator);
  21. Console.WriteLine("\nLUNCH");
  22. PrintMenu(dinerIterator);
  23. }
  24. private void PrintMenu(IMyIterator iterator)
  25. {
  26. while (iterator.HasNext())
  27. {
  28. var menuItem = iterator.Next() as MenuItem;
  29. Console.Write($"{menuItem?.Name}, ");
  30. Console.Write($"{menuItem?.Price} -- ");
  31. Console.WriteLine($"{menuItem?.Description}");
  32. }
  33. }
  34. }
  35. }
复制代码

测试:

  1. static void MenuTestDriveUsingMyIterator()
  2. {
  3. var pancakeHouseMenu = new MyPancakeHouseMenu();
  4. var dinerMenu = new MyDinerMenu();
  5. var waitress = new MyWaitress(pancakeHouseMenu, dinerMenu);
  6. waitress.PrintMenu();
  7. }
复制代码

做一些改进

Java里面内置了Iterator接口, 我们刚才是手写了一个Iterator迭代器接口. Java内置的定义如下:

注意里面这个remove()方法, 我们可能不需要它.

remove()方法是可选实现的, 如果你不想让集合有此功能的话, 就应该抛出NotSupportedException(C#的).

使用java内置的Iterator来实现

由于PancakeHouseMenu使用的是ArrayList, 而ArrayList已经实现了该接口, 那么:这样简单改一下就可以:

针对DinerMe菜单, 还是需要手动实现的:

最后别忘了给菜单规定一个统一的接口:

服务员Waitress类里面也使用Menu来代替具体的菜单, 这样也减少了服务员对具体类的依赖(针对接口编程, 而不是具体的实现):

最后看下改进后的设计类图:

迭代器模式定义

迭代器模式提供了一种访问聚合对象(例如集合)元素的方式, 而且又不暴露该对象的内部表示.

迭代器模式负责遍历该对象的元素, 该项工作由迭代器负责而不是由聚合对象(集合)负责.

类图:

其它问题
  • 迭代器分内部迭代器和外部迭代器, 我们上面实现的是外部迭代器. 也就是说客户控制着迭代, 它通过调用next()方法来获取下个元素. 而内部迭代器由迭代器本身自己控制迭代, 这种情况下, 你需要告诉迭代器遍历的时候需要做哪些动作, 所以你得找到一种方式把操作传递进去. 内部迭代器还是不如外部的灵活, 但是也许使用起来会简单一些?
  • 迭代器意味着无序. 它所遍历的集合的顺序是根据集合来定的, 也有可能会遍历出来的元素值会重复.
单一职责设计原则

一个类应该只有一个变化发生的原因.

写代码的时候这个原则很容易被忽略掉, 只能通过多检查设计来避免违反原则.

所谓的高内聚, 就是只这个类是围绕一套关连的函数而设计的.

而低内聚就是只这个类是围绕一些不相关的函数而设计的.

遵循该原则的类通常是高内聚的, 并且可维护性要比那些多重职责或低内聚的类好.

需求变更

还需要添加另一份菜单:

这个菜单使用的是HashTable.

首先修改该菜单, 让它实现Menu接口:

注意看HashTable的不同之处:

首先通过values()方法获取HashTable的集合对象, 这个对象正好实现了Iterator接口, 直接调用iterator()方法即可.

最后修改服务员类:

测试:

到目前我们做了什么

我们给了服务员一种简单的方式来遍历菜单项, 不同的菜单实现了同一个迭代器接口, 服务员不需要知道菜单项的实现方法.

我们把服务员和菜单的实现解耦了

而且使服务员可以扩展:

还有个问题

现在有三个菜单, 每次再添加一个菜单的时候, 你都得相应的添加一套代码, 这违反了"对修改关闭, 对扩展开放原则".

那我们把这些菜单放到可迭代的集合即可:

C#, .NET Core控制带项目实现

菜单接口:

  1. using System.Collections;
  2. namespace IteratorPattern.Abstractions
  3. {
  4. public interface IMenu
  5. {
  6. IEnumerator CreateIEnumerator();
  7. }
  8. }
复制代码

三个菜单:

  1. using System;
  2. using System.Collections;
  3. using IteratorPattern.Abstractions;
  4. using IteratorPattern.MenuIterators;
  5. namespace IteratorPattern.Menus
  6. {
  7. public class DinerMenu: IMenu
  8. {
  9. private const int MaxItems = 6;
  10. private int _numberOfItems = 0;
  11. private MenuItem[] MenuItems { get; }
  12. public DinerMenu()
  13. {
  14. MenuItems = new MenuItem[MaxItems];
  15. AddItem("Vegetarian BLT", "(Fakin’) Bacon with lettuce & tomato on whole wheat", true, 2.99);
  16. AddItem("BLT", "Bacon with lettuce & tomato on whole wheat", false, 2.99);
  17. AddItem("Soup of the day", "Soup of the day, with a side of potato salad", false, 3.29);
  18. AddItem("Hotdog", "A hot dog, with saurkraut, relish, onions, topped with cheese", false, 3.05);
  19. }
  20. public void AddItem(string name, string description, bool vegetarian, double price)
  21. {
  22. var menuItem = new MenuItem(name, description, vegetarian, price);
  23. if (_numberOfItems >= MaxItems)
  24. {
  25. Console.WriteLine("Sorry, menu is full! Can't add item to menu");
  26. }
  27. else
  28. {
  29. MenuItems[_numberOfItems] = menuItem;
  30. _numberOfItems++;
  31. }
  32. }
  33. public IEnumerator CreateIEnumerator()
  34. {
  35. return new DinerMenuIterator(MenuItems);
  36. }
  37. }
  38. }
  39. using System.Collections;
  40. using IteratorPattern.Abstractions;
  41. using IteratorPattern.MenuIterators;
  42. namespace IteratorPattern.Menus
  43. {
  44. public class PancakeHouseMenu: IMenu
  45. {
  46. public ArrayList MenuItems { get; }
  47. public PancakeHouseMenu()
  48. {
  49. MenuItems = new ArrayList();
  50. AddItem("K&B’s Pancake Breakfast", "Pancakes with scrambled eggs, and toast", true, 2.99);
  51. AddItem("Regular Pancake Breakfast", "Pancakes with fried eggs, sausage", false, 2.99);
  52. AddItem("Blueberry Pancakes", "Pancakes made with fresh blueberries", true, 3.49);
  53. AddItem("Waffles", "Waffles, with your choice of blueberries or strawberries", true, 3.59);
  54. }
  55. public void AddItem(string name, string description, bool vegetarian, double price)
  56. {
  57. var menuItem = new MenuItem(name, description, vegetarian, price);
  58. MenuItems.Add(menuItem);
  59. }
  60. public IEnumerator CreateIEnumerator()
  61. {
  62. return new PancakeHouseMenuIterator(MenuItems);
  63. }
  64. }
  65. }
  66. using System.Collections;
  67. using IteratorPattern.Abstractions;
  68. namespace IteratorPattern.Menus
  69. {
  70. public class CafeMenu : IMenu
  71. {
  72. public Hashtable MenuItems { get; } = new Hashtable();
  73. public CafeMenu()
  74. {
  75. AddItem("Veggie Burger and Air Fries", "Veggie burger on a whole wheat bun, lettuce, tomato, and fries", true, 3.99);
  76. AddItem("Soup of the day", "A cup of the soup of the day, with a side salad", false, 3.69);
  77. AddItem("Burrito", "A large burrito, with whole pinto beans, salsa, guacamole", true, 4.29);
  78. }
  79. public IEnumerator CreateIEnumerator()
  80. {
  81. return MenuItems.GetEnumerator();
  82. }
  83. public void AddItem(string name, string description, bool vegetarian, double price)
  84. {
  85. var menuItem = new MenuItem(name, description, vegetarian, price);
  86. MenuItems.Add(menuItem.Name, menuItem);
  87. }
  88. }
  89. }
复制代码

菜单的迭代器:

  1. using System;
  2. using System.Collections;
  3. using IteratorPattern.Menus;
  4. namespace IteratorPattern.MenuIterators
  5. {
  6. public class DinerMenuIterator: IEnumerator
  7. {
  8. private readonly MenuItem[] _menuItems;
  9. private int _position = -1;
  10. public DinerMenuIterator(MenuItem[] menuItems)
  11. {
  12. _menuItems = menuItems;
  13. }
  14. public bool MoveNext()
  15. {
  16. _position++;
  17. if (_position >= _menuItems.Length || _menuItems[_position] == null)
  18. {
  19. return false;
  20. }
  21. return true;
  22. }
  23. public void Reset()
  24. {
  25. _position = -1;
  26. }
  27. public object Current => _menuItems[_position];
  28. }
  29. }
复制代码
  1. using System.Collections;
  2. using System.Collections.Generic;
  3. namespace IteratorPattern.MenuIterators
  4. {
  5. public class PancakeHouseMenuIterator : IEnumerator
  6. {
  7. private readonly ArrayList _menuItems;
  8. private int _position = -1;
  9. public PancakeHouseMenuIterator(ArrayList menuItems)
  10. {
  11. _menuItems = menuItems;
  12. }
  13. public bool MoveNext()
  14. {
  15. _position++;
  16. if (_position >= _menuItems.Count || _menuItems[_position] == null)
  17. {
  18. return false;
  19. }
  20. return true;
  21. }
  22. public void Reset()
  23. {
  24. _position = -1;
  25. }
  26. public object Current => _menuItems[_position];
  27. }
  28. }
复制代码

服务员:

  1. using System;
  2. using System.Collections;
  3. using IteratorPattern.Abstractions;
  4. using IteratorPattern.Menus;
  5. namespace IteratorPattern.Waitresses
  6. {
  7. public class Waitress
  8. {
  9. private readonly ArrayList _menus;
  10. public Waitress(ArrayList menus)
  11. {
  12. _menus = menus;
  13. }
  14. public void PrintMenu()
  15. {
  16. var menuIterator = _menus.GetEnumerator();
  17. while (menuIterator.MoveNext())
  18. {
  19. var menu = menuIterator.Current as IMenu;
  20. PrintMenu(menu?.CreateIEnumerator());
  21. }
  22. }
  23. private void PrintMenu(IEnumerator iterator)
  24. {
  25. while (iterator.MoveNext())
  26. {
  27. if (iterator.Current != null)
  28. {
  29. MenuItem menuItem;
  30. if (iterator.Current is MenuItem item)
  31. {
  32. menuItem = item;
  33. }
  34. else
  35. {
  36. menuItem = ((DictionaryEntry)iterator.Current).Value as MenuItem;
  37. }
  38. Console.Write($"{menuItem?.Name}, ");
  39. Console.Write($"{menuItem?.Price} -- ");
  40. Console.WriteLine($"{menuItem?.Description}");
  41. }
  42. }
  43. Console.WriteLine();
  44. }
  45. }
  46. }
复制代码

测试:

  1. static void MenuTestDriveUsingIEnumerator()
  2. {
  3. var pancakeHouseMenu = new PancakeHouseMenu();
  4. var dinerMenu = new DinerMenu();
  5. var cafeMenu = new CafeMenu();
  6. var waitress = new Waitress(new ArrayList(3)
  7. {
  8. pancakeHouseMenu, dinerMenu, cafeMenu
  9. });
  10. waitress.PrintMenu();
  11. }
复制代码

深入浅出设计模式的C#实现的代码: https://github.com/solenovex/Head-First-Design-Patterns-in-CSharp

这篇先到这, 本章涉及到组合模式, 下篇文章再写.



回复

使用道具 举报