list.remove(index)存在的坑

公司的测试人员之前在禅道上提交了一个bug，说商户管理平台要求显示优惠券列表的时候，不要显示已经过期的优惠券。但是后台页面总是有几个已经过期的优惠券。我看了下后台的代码逻辑，发现是从数据库中查询出来之后，遍历筛选列表，然后发现jdk8中的这个问题所在

代码如下：

package com.dushan.test;

public class CategoryDo {
    /**
     * category.id
     * 形式主键
     */
    private Integer id;

    /**
     * category.online
     * 上下线情况，默认0 未上线 1未开始 2活动中 3已结束 4已上架 5删除
     */
    private String online;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getOnline() {
        return online;
    }

    public void setOnline(String online) {
        this.online = online;
    }
}

package com.dushan.test;

import java.util.ArrayList;
import java.util.List;

public class TestListRemove {

    public static void main(String[] args) {
        List<CategoryDo> list = getData();

        System.out.println("listSize = {} " + list.size());

        for (int i = 0; i < list.size(); i++) {
            System.out
                    .println("第" + i + "个元素的Id = {}" + list.get(i).getId() + ",online = {}" + list.get(i).getOnline());
            if ("b".equals(list.get(i).getOnline())) {
                CategoryDo delObject = list.remove(i);
                System.out.println(
                        "删除第" + i + "个元素的Id = {}" + delObject.getId() + ",online = {}" + delObject.getOnline());
            }
        }

        System.out.println("listSize = {} " + list.size());

        for (int i = 0; i < list.size(); i++) {
            System.out
                    .println("最终结果第" + i + "个元素的ID是 {} " + list.get(i).getId() + ",online是: {} " + list.get(i)
                            .getOnline());
        }
    }

    private static List<CategoryDo> getData() {
        List<CategoryDo> list = new ArrayList<>();
        CategoryDo categoryDo1 = new CategoryDo();
        CategoryDo categoryDo2 = new CategoryDo();
        CategoryDo categoryDo3 = new CategoryDo();
        CategoryDo categoryDo4 = new CategoryDo();
        CategoryDo categoryDo5 = new CategoryDo();

        categoryDo1.setId(1);
        categoryDo1.setOnline("a");
        categoryDo2.setId(2);
        categoryDo2.setOnline("b");
        categoryDo3.setId(3);
        categoryDo3.setOnline("b");
        categoryDo4.setId(4);
        categoryDo4.setOnline("c");
        categoryDo5.setId(5);
        categoryDo5.setOnline("d");
        list.add(categoryDo1);
        list.add(categoryDo2);
        list.add(categoryDo3);
        list.add(categoryDo4);
        list.add(categoryDo5);
        return list;

    }

}

运行结果是：

listSize = {} 5
第0个元素的Id = {}1,online = {}a
第1个元素的Id = {}2,online = {}b
删除第1个元素的Id = {}2,online = {}b
第2个元素的Id = {}4,online = {}c
第3个元素的Id = {}5,online = {}d
listSize = {} 4
最终结果第0个元素的ID是 {} 1,online是: {} a
最终结果第1个元素的ID是 {} 3,online是: {} b
最终结果第2个元素的ID是 {} 4,online是: {} c
最终结果第3个元素的ID是 {} 5,online是: {} d

有一个online= "d"的对象未能删除，看了下源码。

list.remove(index)的源码如下所示

/**
* Removes the element at the specified position in this list.
* Shifts any subsequent elements to the left (subtracts one from their
* indices).
*
* @param index the index of the element to be removed
* @return the element that was removed from the list
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
public E remove(int index) {
        rangeCheck(index);

        modCount++;
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

其中：
rangeCheck(index)方法是用来判断index这个值是否数组越界
modCount这个变量是用来统计这个list被修改的次数
方法的返回值是本次被移除的元素。
关键在于源码中的这个方法：

System.arraycopy(elementData, index+1, elementData, index, numMoved);
此方法是将index之后的所有元素向左移动一位，所以上面代码中i = 2的元素未能删除

解决方法两种：

1.既然list.remove(index)方法删除元素后，剩下的元素会左移，那么就在删除后 i-1即可。代码如下：
public static void main(String[] args) {
        List<CategoryDo> list = getData();

        System.out.println("listSize = {} " + list.size());

        for (int i = 0; i < list.size(); i++) {
            System.out
                    .println("第" + i + "个元素的Id = {}" + list.get(i).getId() + ",online = {}" + list.get(i).getOnline());
            if ("b".equals(list.get(i).getOnline())) {
                CategoryDo delObject = list.remove(i);
                System.out.println(
                        "删除第" + i + "个元素的Id = {}" + delObject.getId() + ",online = {}" + delObject.getOnline());
                i--;
            }
        }

        System.out.println("listSize = {} " + list.size());

        for (int i = 0; i < list.size(); i++) {
            System.out
                    .println("最终结果第" + i + "个元素的ID是 {} " + list.get(i).getId() + ",online是: {} " + list.get(i)
                            .getOnline());
        }
    }

结果如下：

listSize = {} 5
第0个元素的Id = {}1,online = {}a
第1个元素的Id = {}2,online = {}b
删除第1个元素的Id = {}2,online = {}b
第1个元素的Id = {}3,online = {}b
删除第1个元素的Id = {}3,online = {}b
第1个元素的Id = {}4,online = {}c
第2个元素的Id = {}5,online = {}d
listSize = {} 3
最终结果第0个元素的ID是 {} 1,online是: {} a
最终结果第1个元素的ID是 {} 4,online是: {} c
最终结果第2个元素的ID是 {} 5,online是: {} d

2.用jdk8的stream().filter()来改写

public static void main(String[] args) {
        List<CategoryDo> list = getData();

        System.out.println("listSize = {} " + list.size());

        List<CategoryDo> result = new ArrayList<>(list.size());
        if (list.size() > 0) {
            result = list.stream().filter(categoryDo -> !"b".equals(categoryDo.getOnline()))
                    .collect(Collectors.toList());
        }

        System.out.println("listSize = {} " + result.size());

        for (int i = 0; i < result.size(); i++) {
            System.out.println(
                    "第" + i + "个元素的ID是 {} " + result.get(i).getId() + ",online是: {} " + result.get(i).getOnline());
        }
    }

结果如下图所示：

listSize = {} 5
listSize = {} 3
第0个元素的ID是 {} 1,online是: {} a
第1个元素的ID是 {} 4,online是: {} c
第2个元素的ID是 {} 5,online是: {} d