测试工具中的设计模式实例谈 - 迭代器模式(Iterator)

摘要：

本文将以OPENCSV为案例，介绍迭代器模式(Iterator)的实现CSVIterator，并以Iterable接口的实现CSVReader为例，简要讨论了Iterator和Iterable这两个接口的差异。

1. 迭代器模式简介

Opencsv提供了非常方便的CSV文件解析方法。在此基础上加以简单的封装，就可以实现一个较为通用的CSV文件转换为Java对象的方法。

迭代器模式是提供了对于一个数据集合进行遍历访问的机制，通过提供最简单的几种方法，如hasnext(),next()等，就可以遍历整个数据集。由于这个模式过于简单，可能有些读者会认为这都不应该算个模式，因为迭代器已经被纳入了编程语言中，如在Java语言中提供了一个Iterator接口，

070a82ea6f5df369df32a5aba2d57830.png

其中remove和forEachRemaining这两个方法提供了默认实现。

2. OPENCSV简介

从面向对象的角度，如果将一个CSV文件的记录结构类比成一个JAVA类，那么该CSV文件中的每一条记录，就可以理解为同一个类的不同实例。OpenCSV就是一个在CSV数据文件和java 对象集合之间互相转换的第三方工具包。对OpenCSV感兴趣的读者可以访问其官方网站http://opencsv.sourceforge.net。

在OpenCSV中也使用了迭代器模式进行数据集的遍历。

3. CSVIterator迭代器

在OpenCsv中，需要在解析CSV数据文件的过程中，完成对于数据文件中的内容进行逐行的遍历。 因此，OpenCsv提供了 CSVIterator这个迭代器，

fc77c614cbb11fd36c30dafbe06d5e86.png

这个类实现了Iterator这个接口，提供了hasNext()和next()两个方法，并且将remove()这个方法实现为调用即抛出异常，表示在Opencsv中不适用。

我们再来看一下 next()方法的具体实现，

  @Override

  **public** String[] next() {

 String[] temp = nextLine;

  **try** {

  nextLine = reader.readNext();

 } **catch** (IOException e) {

  **throw**  **new** NoSuchElementException();

 }

  **return**  temp;

 }

这个方法的代码就寥寥几行，但是功能强大，通过在构造方法中传入的CSVReader的实例reader和其提供的readNext()方法，将CSV文件中的内容按行读入一个String数组temp,并返回该数组。

我们再来看以下Opencsv提供的单元测试用例，了解这个CSVIterator的用法。

**public**  **class** CSVIteratorTest {

  **private**  **static**  **final** String[] ***STRINGS*** = {"test1", "test2"};

  **private** CSVIterator iterator;

  **private** CSVReader mockReader;

  @Before

  **public**  **void** setUp() **throws** IOException {

 Locale.*setDefault*(Locale.***US***);

  mockReader = mock(CSVReader.**class**); //mock CSVReader 这个类

 when(mockReader.readNext()).thenReturn(***STRINGS***);

//当调用readNext()方法时，返回STRINGS数组

  iterator = **new** CSVIterator(mockReader);

 }

  @Test

  **public**  **void** initialReadReturnsStrings() {

 *assertArrayEquals*(***STRINGS***, iterator.next());

 }

}

通过Mockito提供的mock方法，这个用例模拟了当CSVIterator调用readNext方法时的行为，即返回提供的默认String数组。

这样，我们就可以无需关心具体的CSV文件读取过程，只要借助于CSVIterator和给定的CSVReader，就可以完成文件内容的遍历了，是不是很方便呢？

4. Iterable与CSVReader

前面提到CSVIterator使用了CSVReader提供的readNext()方法进行工作。而CSVReader也可以在其内部完成CSV文件内容的解析和结果的遍历，当然这需要在其内部提供一个迭代器。

因此，CSVIterator实现了Iterable接口，

7ea071a87ce4e870a5c52912e6044429.png

这个接口的核心，是需要在其内部包含一个Iterator，用以迭代访问实现该接口的类所包含数据集。在CSVReader中，这个Iterator的实现是这样的，

  @Override

  **public** Iterator iterator() {

  **try** {

 CSVIterator it = **new** CSVIterator(**this**);

  it.setErrorLocale(errorLocale);

  **return**  it;

 } **catch** (IOException e) {

  **throw**  **new** RuntimeException(e);

 }

 }

即，每次调用iterator()方法时，都会返回一个新的CSVIterator实例，并将CSVReader作为默认的Reader。这样，就可以以Iterator方式对解析结果进行遍历了。由于每次调用时都会返回一个从头开始计数的迭代器实例，因此多个迭代器CSVIterator之间是互不干扰的。这也是Iterator和Iterable之间的最大区别。