在Java的for-each循环中,有没有一种方法可以访问迭代计数器?

334

在Java的for-each循环中,是否有一种方法

for(String s : stringArray) {
  doSomethingWith(s);
}

如何确定循环已经被处理了多少次?

除了使用老旧而广为人知的for(int i=0; i < boundary; i++)循环外,还有一种构造方式:

int i = 0;
for(String s : stringArray) {
  doSomethingWith(s);
  i++;
}

如何在for-each循环中使用计数器?


2
另一个遗憾是,您无法在循环外部使用循环变量,Type var = null; for (var : set) dosomething; if (var != null) then ... - Val
@Val 除非引用是有效的最终值,否则请勿使用此引用。请参阅我的答案以了解如何使用此功能。 - rmuller
16个回答

247

不可以,但您可以提供自己的计数器。

原因是for-each循环内部实际上没有计数器;它基于Iterable接口,即使用Iterator来遍历“集合”——这个“集合”可能根本不是一个基于索引的集合(例如链表),也可能完全不基于索引。


8
Ruby有这个结构,Java也应该得到for(int idx=0, String s; s : stringArray; ++idx) doSomethingWith(s, idx); - Nicholas DiPiazza
2
FYI @NicholasDiPiazza,Ruby的Enumerable模块中有一个名为each_with_index的循环方法。请参阅apidock.com/ruby/Enumerable/each_with_index。 - saywhatnow
@saywhatnow 是的,那就是我想说的,抱歉 - 不确定我在之前发表评论时吸了什么。 - Nicholas DiPiazza
5
“这是因为for-each循环在内部没有计数器。”应该被理解为“Java开发人员没有考虑让程序员在'for'循环中指定带有初始值的索引变量”,类似于for (int i = 0; String s: stringArray; ++i) - izogfif
1
为什么我们不能为任何可迭代的东西维护一个索引/计数器?LinkedList不是基于索引的,但我们仍然有ListIterator,在迭代时内部维护一个计数器。如果我们正在迭代某些东西,那么意味着我们有n个项目,无论其格式/数据结构如何。有没有任何无法维护索引的示例将会很有帮助。谢谢。 - ankur_rajput

77

还有一种方法。

假设您编写自己的 Index 类和一个静态方法,该方法返回一个可迭代对象,其中包含该类的实例,您可以

for (Index<String> each: With.index(stringArray)) {
    each.value;
    each.index;
    ...
}

With.index的实现类似于以下内容:

class With {
    public static <T> Iterable<Index<T>> index(final T[] array) {
        return new Iterable<Index<T>>() {
            public Iterator<Index<T>> iterator() {
                return new Iterator<Index<T>>() {
                    index = 0;
                    public boolean hasNext() { return index < array.size }
                    public Index<T> next() { return new Index(array[index], index++); }
                    ...
                }
            }
        }
    }
}

8
好主意。如果Index类的对象创建不是短暂的,我会点赞的。 - mR_fr0g
6
@mR_fr0g 不用担心,我对此进行了基准测试,创建所有这些对象的速度并不比为每个迭代重复使用相同的对象慢。原因是所有这些对象都只分配在 eden 空间中,从未存活到足以达到堆的时间。因此,分配它们的速度与分配局部变量的速度一样快。 - akuhn
1
@Val 你真是太有毅力了 :) 每个线程都有一个本地的伊甸园空间。我们的 With 对象通过增加指针在伊甸园上分配。不需要初始化,因为构造函数设置了所有字段。虚拟机保留了逃逸伊甸园的指针列表(据我所知),而我们的情况下该列表为空,因此在伊甸园上进行垃圾回收只需重置该指针即可。在2000年,分配对象曾经是一项昂贵的操作,但今天它是JVM中最便宜的操作之一。例如,对象池曾经是一个好主意,但今天却是一个非常糟糕的主意。 - akuhn
9
如果您担心这样的短生对象的性能,那么您的方法可能存在问题。性能应该是最后需要担心的事情……可读性则应排在第一位。实际上,这是一个相当不错的构建方式。 - Bill K
5
我原本想说,我不太理解为什么需要辩论,因为Index实例可以创建一次并重复使用/更新,这样就可以平息争论并让每个人都满意。然而,在我的测试中,每次创建一个新的Index()实例的版本在我的机器上运行速度比重复使用相同实例的版本快了两倍以上,几乎与运行相同迭代的本地迭代器一样快。 - Eric Woodruff
显示剩余6条评论

66

最简单的解决方案只需运行自己的计数器,如下所示:

int i = 0;
for (String s : stringArray) {
    doSomethingWith(s, i);
    i++;
}
这是因为在集合中(该 for 循环变体迭代的集合),并没有确切的保证每个项都有索引,甚至可能没有定义的顺序(添加或删除元素时某些集合可能会更改顺序)。
例如,请参见以下代码:
import java.util.*;

public class TestApp {
  public static void AddAndDump(AbstractSet<String> set, String str) {
    System.out.println("Adding [" + str + "]");
    set.add(str);
    int i = 0;
    for(String s : set) {
        System.out.println("   " + i + ": " + s);
        i++;
    }
  }

  public static void main(String[] args) {
    AbstractSet<String> coll = new HashSet<String>();
    AddAndDump(coll, "Hello");
    AddAndDump(coll, "My");
    AddAndDump(coll, "Name");
    AddAndDump(coll, "Is");
    AddAndDump(coll, "Pax");
  }
}
当你运行它时,你会看到类似这样的东西:
Adding [Hello]
   0: Hello
Adding [My]
   0: Hello
   1: My
Adding [Name]
   0: Hello
   1: My
   2: Name
Adding [Is]
   0: Hello
   1: Is
   2: My
   3: Name
Adding [Pax]
   0: Hello
   1: Pax
   2: Is
   3: My
   4: Name

这表明,有理之处在于,顺序不被认为是集合的显著特征。

还有其他方法可以完成此操作,而无需手动计数,但这需要很多工作,收益却不确定。


3
即使考虑到 List 和 Iterable 接口,这仍然似乎是最清晰的解决方案。 - Joshua Pinter
1
似乎在Java8之后,每当我在PR中放置一个for循环时,每个人都想提醒我有无数的替代方案。但这是可读性强、规范化的,并且本身不容易出现问题。 - Adam Hughes

31

在Java 8中使用lambda表达式函数接口可以创建新的循环抽象。我可以通过索引和集合大小遍历集合:

List<String> strings = Arrays.asList("one", "two","three","four");
forEach(strings, (x, i, n) -> System.out.println("" + (i+1) + "/"+n+": " + x));

这将输出:

1/4: one
2/4: two
3/4: three
4/4: four

我实现的代码如下:

   @FunctionalInterface
   public interface LoopWithIndexAndSizeConsumer<T> {
       void accept(T t, int i, int n);
   }
   public static <T> void forEach(Collection<T> collection,
                                  LoopWithIndexAndSizeConsumer<T> consumer) {
      int index = 0;
      for (T object : collection){
         consumer.accept(object, index++, collection.size());
      }
   }

可能性是无限的。例如,我创建一个抽象,只为第一个元素使用特殊函数:

forEachHeadTail(strings, 
                (head) -> System.out.print(head), 
                (tail) -> System.out.print(","+tail));

如何正确打印逗号分隔的列表:

one,two,three,four

我实现的方式是:

public static <T> void forEachHeadTail(Collection<T> collection, 
                                       Consumer<T> headFunc, 
                                       Consumer<T> tailFunc) {
   int index = 0;
   for (T object : collection){
      if (index++ == 0){
         headFunc.accept(object);
      }
      else{
         tailFunc.accept(object);
      }
   }
}

会出现一些库来完成这些事情,或者你可以自己开发。


10
并非对这篇文章提出批评(我猜这是现今“酷炫的做法”),但我很难看出这种方式比一个简单的老式for循环更容易/更好: for (int i = 0; i < list.size(); i++) { }就算是老奶奶也能理解它,而且它可能比使用Lambda表达式更容易打出来,因为Lambda表达式使用了语法和不常用的字符。别误会,我喜欢在某些情况下使用Lambda表达式(回调/事件处理程序类型的模式),但我就是无法理解在像这样的情况下使用它的用途。它是个好工具,但总是使用它,我做不到。 - Manius
1
我想,应该避免对列表本身进行一次性索引上/下溢。但是上面发布了一个选项:int i = 0; for (String s : stringArray) { doSomethingWith(s, i); i++; } - Manius

30

Java 8引入了Iterable#forEach() / Map#forEach() 方法,在许多Collection / Map 实现中与“传统”的for-each循环相比更加高效。然而,即使在这种情况下也不提供索引。这里的诀窍是在lambda表达式外部使用AtomicInteger。注意:lambda表达式中使用的变量必须是有效final的,这就是为什么我们不能使用普通的int

final AtomicInteger indexHolder = new AtomicInteger();
map.forEach((k, v) -> {
    final int index = indexHolder.getAndIncrement();
    // use the index
});

17

很遗憾,使用foreach是不可能实现这个功能的。但我可以建议您使用简单的传统for循环

    List<String> l = new ArrayList<String>();

    l.add("a");
    l.add("b");
    l.add("c");
    l.add("d");

    // the array
    String[] array = new String[l.size()];

    for(ListIterator<String> it =l.listIterator(); it.hasNext() ;)
    {
        array[it.nextIndex()] = it.next();
    }

注意,List接口允许您访问it.nextIndex()

(编辑)

针对您更改的示例:

    for(ListIterator<String> it =l.listIterator(); it.hasNext() ;)
    {
        int i = it.nextIndex();
        doSomethingWith(it.next(), i);
    }

14

惯用解决方案:

final Set<Double> doubles; // boilerplate
final Iterator<Double> iterator = doubles.iterator();
for (int ordinal = 0; iterator.hasNext(); ordinal++)
{
    System.out.printf("%d:%f",ordinal,iterator.next());
    System.out.println();
}

这实际上是谷歌在Guava讨论中建议的解决方案,解释了为什么他们没有提供CountingIterator

13
尽管还有许多其他方式可以实现相同的功能,但我将分享我的方法来满足一些不满意的用户。我正在使用Java 8的IntStream功能。 1. 数组
Object[] obj = {1,2,3,4,5,6,7};
IntStream.range(0, obj.length).forEach(index-> {
    System.out.println("index: " + index);
    System.out.println("value: " + obj[index]);
});

2. 列表

List<String> strings = new ArrayList<String>();
Collections.addAll(strings,"A","B","C","D");

IntStream.range(0, strings.size()).forEach(index-> {
    System.out.println("index: " + index);
    System.out.println("value: " + strings.get(index));
});

这可能是最接近解决方案的内容,Scala、Ruby、Python、JavaScript和其他用户都可以欣赏(作为使用这5种语言之一的人说)。 - WestCoastProjects

11

Sun 正在考虑为 Java7 提供访问 foreach 循环中内部 Iterator 的功能。如果此功能被接受,语法将类似于:

for (String str : list : it) {
  if (str.length() > 100) {
    it.remove();
  }
}

这是语法糖,但显然有很多人要求这个功能。但在它获得批准之前,您将不得不自己计算迭代次数,或者使用带有Iterator的常规for循环。


3

对于只需要偶尔使用索引的情况,比如在catch子句中,我有时会使用indexOf。

for(String s : stringArray) {
  try {
    doSomethingWith(s);
  } catch (Exception e) {
    LOGGER.warn("Had some kind of problem with string " +
      stringArray.indexOf(s) + ": " + s, e);
  }
}

3
请注意,这需要一个 .equals() 实现来识别数组对象中的某个对象。对于字符串并非如此,如果某个字符串在数组中出现多次,即使您已经迭代到具有相同字符串的后续项,您仍将只获取第一次出现的索引。请小心处理。 - Kosi2801

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接