如何實現java Iterator迭代器功能

阿新 • • 發佈：2020-01-07

這篇文章主要介紹瞭如何實現java Iterator迭代器功能,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

今天躺在床上忽然想到一個問題，迭代器的程式碼是如何實現的？
於是乎不由自主的爬起來敲兩行程式碼。

List<String> list=new ArrayList<>(2);
    list.add("java");
    list.add("C#");
    Iterator<String> iterator=list.iterator();
    while (iterator.hasNext()){
      System.out.println(iterator.next());
    }

上面的程式碼是java中很常見的一個迭代的功能。

於是自己也想要寫一個泛型類，然後支援這種迭代的功能。

於是乎寫了一個類似ArrayList的動態陣列功能。

package a;

import javax.swing.text.html.HTMLDocument;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;

public class Gys<T>{
  private final static int default_capacity =10;
  private int endIndex =0;
  private Object[] elemts;

  public Gys() {
    this.elemts = new Object[default_capacity];
  }

  public T[] add(T t){
    if(elemts.length-1< endIndex){
      int newCapcti= default_capacity *2;
      elemts= Arrays.copyOf(elemts,newCapcti);
    }
    elemts[endIndex++]=t;
    return (T[])elemts;
  }

  public int size(){
    return endIndex;
  }

  public T get(int i){
    if(i< endIndex){
      return (T) elemts[i];
    }
    throw new RuntimeException("索引超出界限");
  }


  public static void main(String[] args) {
    Gys<Integer> gys=new Gys<>();
    gys.add(5);
    gys.add(45);
    System.out.println(gys.get(0));
    System.out.println(gys.get(1));    
  }
}

上面的程式碼怎麼都沒辦法實現Iterator的功能，在idea下怎麼都點不出來Iterator的提示；
於是只能去翻閱jdk原碼。在ArrayList中看到如下的程式碼。

在ArrayList中申明一個內部類Itr，並且繼承Iterator<E>這個介面，然後實現hasNext()和next()方法。
在定義一個方法專門獲取迭代器例項。

public Iterator<E> iterator() { return new Itr(); }

這才明白如何實現迭代器功能;

所以對上面的泛型程式碼進行改造。

package a;

import java.util.Arrays;
import java.util.Iterator;

public class Gys<T>{
  private final static int default_capacity =10;
  private int endIndex =0;
  private Object[] elemts;

  public Gys() {
    this.elemts = new Object[default_capacity];
  }

  public T[] add(T t){
    if(elemts.length-1< endIndex){
      int newCapcti= default_capacity *2;
      elemts= Arrays.copyOf(elemts,newCapcti);
    }
    elemts[endIndex++]=t;
    return (T[])elemts;
  }

  public int size(){
    return endIndex;
  }

  class Itr implements Iterator<T>{

    private int point;
    private int len;

    public Itr() {
      this.point=0;
      this.len=endIndex;
    }

    @Override
    public boolean hasNext() {
      return point<endIndex?true:false;
    }

    @Override
    public T next() {
      return (T) elemts[point++];
    }
  }

  public Iterator<T> iterator(){
    return new Itr();
  } 

  public T get(int i){
    if(i< endIndex){
      return (T) elemts[i];
    }
    throw new RuntimeException("索引超出界限");
  }


  public static void main(String[] args) {
    Gys<Integer> gys=new Gys<>();
    gys.add(5);
    gys.add(45);
    /*System.out.println(gys.get(0));
    System.out.println(gys.get(1));*/
    Iterator iterator= gys.iterator();
    while (iterator.hasNext()){
      System.out.println(iterator.next());
    }
  }
}

怎麼樣、這個時候就可以對自己的泛型類Gys實現迭代的功能了。

同時另一個疑問也來了，和Iterator長得異常相似的介面Iterable是幹什麼的？他和Iterator又是什麼關係？

既然實現了迭代的功能，那麼為什麼foreach的語法無法實現了。

翻開原始碼看看。

原始碼中可以看出Iterable介面提供了一個獲取迭代器的介面方法。那麼又有哪些類實現了介面呢？
使用idea的ctrl+h快捷鍵調出檢視類的全部繼承關係。

我們看到熟悉的Collection介面。

看到Colllection介面中並沒有實現這個介面，依然是一個介面方法。繼續向下追蹤

看到我們熟悉的ArrayList這個型別實現了iterator方法。

從這個角度來看ArrayList中的iterator()方法不是空穴來風的，他是通過繼承collection和Iterable這些介面而來的。
雖然我們上面的泛型類實現了迭代的功能，但是學習了新知識後總要練練手，於是這個時候畫蛇添足的對上面的程式碼繼續改造。

package a;

import java.util.Arrays;
import java.util.Iterator;

public class Gys<T> implements Iterable<T>{
  private final static int default_capacity =10;
  private int endIndex =0;
  private Object[] elemts;

  public Gys() {
    this.elemts = new Object[default_capacity];
  }

  public T[] add(T t){
    if(elemts.length-1< endIndex){
      int newCapcti= default_capacity *2;
      elemts= Arrays.copyOf(elemts,newCapcti);
    }
    elemts[endIndex++]=t;
    return (T[])elemts;
  }

  public int size(){
    return endIndex;
  }

  class Itr implements Iterator<T>{

    private int point;
    private int len;

    public Itr() {
      this.point=0;
      this.len=endIndex;
    }

    @Override
    public boolean hasNext() {
      return point<endIndex?true:false;
    }

    @Override
    public T next() {
      return (T) elemts[point++];
    }
  }  
  @Override
  public Iterator<T> iterator(){
    return new Itr();
  }


  public T get(int i){
    if(i< endIndex){
      return (T) elemts[i];
    }
    throw new RuntimeException("索引超出界限");
  }


  public static void main(String[] args) {
    Gys<Integer> gys=new Gys<>();
    gys.add(5);
    gys.add(45);
    /*System.out.println(gys.get(0));
    System.out.println(gys.get(1));*/
    Iterator iterator= gys.iterator();
    while (iterator.hasNext()){
      System.out.println(iterator.next());
    }
  }
}

實現了Iterable介面的類，都可以實現forEach功能。

其實forEache的寫法最終還是會編譯成成迭代器的寫法。

寫到這想起來之前<<java程式設計的邏輯>>這本書上說的對於介面的描述：

介面是用於給實現類提供某種能力。

從這個例子中可以很清晰的理解這結論的準確性：