编程规约之集合处理

ArrayList的subList函数

【强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常，即java.util.RandomAccessSubList cannot be cast to java.util.ArrayList.

说明: subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。

subList函数如下代码所示：

public List<E> subList(int fromIndex, int toIndex) {
    subListRangeCheck(fromIndex, toIndex, size);
    // 返回的子集的长度是 toIndex - fromIndex
    return new SubList(this, 0, fromIndex, toIndex);
}

内部类SubList部分代码如下所示：

private class SubList extends AbstractList<E> implements RandomAccess {
    private final AbstractList<E> parent;
    private final int parentOffset;
    private final int offset;
    int size;

    SubList(AbstractList<E> parent，int offset, int fromIndex, int toIndex) {
        this.parent = parent;
        this.parentOffset = fromIndex;
        this.offset = offset + fromIndex;
        this.size = toIndex - fromIndex;
        // 注意！！！
        this.modCount = ArrayList.this.modCount; 
    }

    public void add(int index, E e) {
        rangeCheckForAdd(index);
        // ConcurrentModificationException
        checkForComodification(); 
        // 对子集的操作会反映到原集合上
        parent.add(parentOffset + index, e); 
        this.modCount = parent.modCount;
        this.size++;
    }
    ...
}

【强制】在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、 删除均会产生ConcurrentModificationException 异常。

如果达到的效果是：要对子集进行操作，原始list不改变。建议以下方式：

List<String> tempList = new ArrayList<String>(list.subList(2, lists.size()));
tempList.add("xxxxx");

---

集合转数组

【强制】使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。
说明:使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配 内存空间，并返回新数组地址;如果数组元素大于实际所需，下标为[ list.size() ]的数组 元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素 个数一致。
反例:直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

正例:
List<String> list = new ArrayList<String>(2); 
list.add("guan");
list.add("bao");
String[] array = new String[list.size()]; 
array = list.toArray(array);

ArrayList中toArray函数代码如下所示：

public <T> T[] toArray(T[] a) {
    if (a.length < size)
        // Make a new array of a's runtime type, but my contents:
        return (T[]) Arrays.copyOf(elementData, size, a.getClass());
    System.arraycopy(elementData, 0, a, 0, size);
    if (a.length > size)
        a[size] = null;
    return a;
}

---

数组转集合

【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
说明:asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str); 
第一种情况:list.add("yangguanbao"); 运行时异常。 
第二种情况:str[0] = "gujin"; 那么list.get(0)也会随之修改。

如下代码是asList函数和Arrays中的内部类ArrayList：

    public static <T> List<T> asList(T... a) {
        return new ArrayList<>(a);
    }

    private static class ArrayList<E> extends AbstractList<E>
        implements RandomAccess, java.io.Serializable
    {
        private static final long serialVersionUID = -2764017481108945198L;
        private final E[] a;

        ArrayList(E[] array) {
            a = Objects.requireNonNull(array);
        }

        @Override
        public int size() {
            return a.length;
        }

        @Override
        public Object[] toArray() {
            return a.clone();
        }

        @Override
        public E get(int index) {
            return a[index];
        }

        @Override
        public E set(int index, E element) {
            E oldValue = a[index];
            a[index] = element;
            return oldValue;
        }

        @Override
        public int indexOf(Object o) {
            E[] a = this.a;
            if (o == null) {
                for (int i = 0; i < a.length; i++)
                    if (a[i] == null)
                        return i;
            } else {
                for (int i = 0; i < a.length; i++)
                    if (o.equals(a[i]))
                        return i;
            }
            return -1;
        }

        @Override
        public boolean contains(Object o) {
            return indexOf(o) != -1;
        }

        @Override
        public void sort(Comparator<? super E> c) {
            Arrays.sort(a, c);
        }
        ...
    }

---

hashCode 和 equals 的处理规则

【强制】关于 hashCode 和 equals 的处理，遵循如下规则:
1) 只要重写 equals，就必须重写 hashCode。
2) 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的 对象必须重写这两个方法。
3) 如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals。
其实规则2和规则3等价。
说明:String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象 作为 key 来使用。

---

不要在 foreach 循环里进行元素的 remove/add 操作。

【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。

正例:
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) {
    String item = iterator.next(); 
    if (删除元素的条件) {
        iterator.remove();
    }
}

反例:
List<String> list = new ArrayList<String>(); 
list.add("1");
list.add("2");
for (String item : list) {
    if ("1".equals(item)) { 
        list.remove(item);
    } 
}

---

HashMap初始化大小及遍历方式

【推荐】集合初始化时，指定集合初始值大小。
说明:HashMap使用HashMap(int initialCapacity) 初始化
正例:initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子(即 loader factor)默认为 0.75，如果暂时无法确定初始值大小，请设置为 16(即默认值)。
反例:HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容 量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

---

【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。
说明:keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效 率更高。如果是 JDK8，使用 Map.foreach 方法。
正例:values()返回的是 V 值集合，是一个 list 集合对象;keySet()返回的是 K 值集合，是 一个 Set 集合对象;entrySet()返回的是 K-V 值组合集合。

Map< String, String> map = new HashMap<>();
map.put("aa", "@sohu.com");
map.put("bb","@163.com");
map.put("cc", "@sina.com");

System.out.println("普通的遍历方法，通过Map.keySet遍历key和value");
// 二次取值
for (String key : map.keySet()) {
    System.out.println("key= "+key+" and value= "+map.get(key));
}

System.out.println("通过Map.entrySet使用iterator遍历key和value：");
Iterator<Map.Entry<String, String>> it = map.entrySet().iterator();
while(it.hasNext()){
    Map.Entry<String, String> entry = it.next();
    System.out.println("key= "+entry.getKey()+" and value= "+entry.getValue());
}

System.out.println("通过Map.entrySet遍历key和value");    
// 推荐这种，特别是容量大的时候
for(Map.Entry<String, String> entry : map.entrySet()){
    System.out.println("key= "+entry.getKey()+" and value= "+entry.getValue());
}

System.out.println(“通过Map.values()遍历所有的value，但不能遍历key”);
for(String v : map.values()){
    System.out.println("value = "+v);
}

---

Map存储null值的情况

【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格:

集合类	Key	Value	Super	说明
Hashtable	不允许为 null	不允许为 null	Dictionary	线程安全
ConcurrentHashMap	不允许为 null	不允许为 null	AbstractMap	锁分段技术(JDK8:CAS)
TreeMap	不允许为 null	允许为 null	AbstractMap	线程不安全
HashMap	允许为 null	允许为 null	AbstractMap	线程不安全

反例: 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上， 存储 null 值时会抛出 NPE 异常。

---

泛型的使用

【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法，而<? super T>不能使用get方法，做为接口调用赋值时易出错。
说明:扩展说一下PECS(Producer Extends Consumer Super)原则: 第一、频繁往外读取内容的，适合用<? extends T>。第二、经常往里插入的，适合用<? super T>。

---

Comparator

【强制】 在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort， Collections.sort 会报 IllegalArgumentException 异常。
说明:三个条件如下
1) x，y的比较结果和y，x的比较结果相反。
2) x>y，y>z，则x>z。
3) x=y，则x，z比较结果和y，z比较结果相同。

Arrays.sort(T[],Comparator<? super T> c);
Collections.sort(List<T> list,Comparator<? super T> c);

反例:下例中没有处理相等的情况，实际使用中可能会出现异常:
new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }
};

Comparable 和Comparator