阿里巴巴Java开发手册(第2版)-第1章(6)

简介: 本章是传统意义上的代码规范,包括变量命名、代码风格、控制语句、代码注释、前后端规约等基本的编程习惯,以及从高并发场景中提炼出来的集合处理技巧与并发多线程的注意事项。

1.6 集合处理

1

【强制】关于hashCode 和equals 的处理,遵循如下规则。

1)只要覆写equals,就必须覆写hashCode。

2)因为Set 存储的是不重复的对象,所以依据hashCode 和equals 进行判断,Set 存储的对象必须覆写这两种方法。

3)如果自定义对象作为Map 的键,那么必须覆写hashCode和equals。

说明:String 因为覆写了hashCode 和equals 方法,所以可以愉快地将String 对象作为key 使用。

2

【强制】判断所有集合内部的元素是否为空,应使用isEmpty()方法,而不是使用size()==0 的方式。

说明:在某些集合中,前者的时间复杂度为O(1),而且可读性更好。

正例:

Map<String, Object> map = new HashMap<>(16);

if (map.isEmpty()) {

   System.out.println("no element in this map.");

}

3

【强制】在使用java.util.stream.Collectors 类的toMap()方法转为Map 集合时,一定要使用含有参数类型为BinaryOperator、参数名为mergeFunction 的方法,否则当出现相同key 值时,会抛出IllegalStateException异常。

说明:参数mergeFunction 的作用是当出现key 重复时,自定义对value 的处理策略。

正例:

List<Pair<String, Double>> pairArrayList

      = new ArrayList<>(3);

pairArrayList.add(new Pair<>("version", 6.19));

pairArrayList.add(new Pair<>("version", 10.24));

pairArrayList.add(new Pair<>("version", 13.14));

// 在生成的Map 集合中,只有一个键值对:{version=13.14}

Map<String, Double> map

      = pairArrayList.stream().collect(

Collectors.toMap(Pair::getKey, Pair::getValue,

      (v1, v2) -> v2));

反例:

String[] words = new String[] {"W", "W", "X"};

// 抛出IllegalStateException 异常

Map<Integer, String> map = Arrays.stream(words)

      .collect(Collectors.toMap(String::hashCode, v -> v));

4

【强制】在使用java.util.stream.Collectors 类的toMap()方法转为Map 集合时,一定要注意当value 为null时,会抛出NPE 异常。

说明:在java.util.HashMap 的merge 方法中,会进行如下判断:

if (value == null || remappingFunction == null)

throw new NullPointerException();

反例:

List<Pair<String, Double>> pairArrayList

      = new ArrayList<>(2);

pairArrayList.add(new Pair<>("version1", 4.22));

pairArrayList.add(new Pair<>("version2", null));

Map<String, Double> map

      = pairArrayList.stream().collect(

// 抛出NullPointerException 异常

Collectors.toMap(Pair::getKey, Pair::getValue,

      (v1, v2) -> v2));

5

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

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

6

【强制】使用Map 的方法keySet()/values()/entry Set()返回集合对象时, 不可以对其添加元素, 否则会抛出UnsupportedOperationException 异常。

7

【强制】Collections 类返回的对象,如:emptyList()/singletonList()等都是immutable list,不可对其添加或者删除元素。

反例:如果查询无结果,返回Collections.emptyList()空集合对象, 调用方一旦进行了添加元素的操作, 就会触发UnsupportedOperationException 异常。

8

【强制】在subList 场景中,高度注意对父集合元素的增加或删除, 它们均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常。

9

【强制】使用集合转数组的方法,必须使用集合的toArray (T[]array),传入的是类型完全一致、长度为0 的空数组。

反例:直接使用toArray 无参方法存在问题,此方法返回值只能是Object[] 类, 若强转成其他类型数组, 将出现ClassCastException 错误。

正例:

  List<String> list = new ArrayList<>(2);

  list.add("guan");

  list.add("bao");

  String[] array = list.toArray(new String[0]);

说明:使用toArray 带参方法,数组空间大小的length:

1)等于0,动态创建与size 相同的数组,性能最好;

2)大于0 但小于size,重新创建大小等于size 的数组,增加GC 负担;

3)等于size,在高并发情况下,在数组创建完成之后,size 正在变大的情况下,负面影响与第2 条相同;

4)大于size,空间浪费,且在size 处插入null 值,存在NPE 隐患。

10

【强制】在使用Collection 接口任何实现类的addAll()方法时,都要对输入的集合参数进行NPE 判断。

说明:ArrayList#addAll 方法的第一行代码即Object[] a = c.toArray();,其中,c 为输入集合参数,如果为null,则直接抛出异常。

11

【强制】当使用工具类Arrays.asList()把数组转换成集合时,不能使用其修改集合相关的方法,它的add/remove/clear方法会抛出UnsupportedOperationException 异常。

说明:asList 的返回对象是一个Arrays 内部类,并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式,只是转换接口,后台的数据仍是数组。

String[] str = new String[] { "yang", "hao" };

List list = Arrays.asList(str);

第一种情况:list.add("yangguanbao"); 运行时异常。

第二种情况:str[0] = "changed"; 也会随之修改,反之亦然。

12

【强制】泛型通配符<? extends T>用来接收返回的数据,此写法的泛型集合不能使用add 方法,而<? super T>不能使用get 方法,因为两者在接口调用赋值的场景中容易出错。

说明:扩展介绍一下PECS(Producer Extends Consumer Super)原则:第一,频繁往外读取内容的,适合用<? extends T>;第二,经常往里插入的,适合用<? super T>。

13

【强制】在无泛型限制定义的集合赋值给泛型限制的集合中,当使用集合元素时,需要进行instanceof 判断,避免抛出ClassCastException 异常。

说明:毕竟泛型是在JDK 5 后才出现的,考虑到向前兼容,编译器允许非泛型集合与泛型集合互相赋值。

反例:

 List<String> generics = null;

 List notGenerics = new ArrayList(10);

 notGenerics.add(new Object());

 notGenerics.add(new Integer(1));

 generics = notGenerics;

 // 此处抛出ClassCastException 异常

 String string = generics.get(0);

14

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

正例:

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

 list.add("1");

 list.add("2");

 Iterator<String> iterator = list.iterator();

 while (iterator.hasNext()) {

      String item = iterator.next();

      if (删除元素的条件) {

      iterator.remove();

 }

}

反例:

 for (String item : list) {

      if ("1".equals(item)) {

          list.remove(item);

      }

 }

说明:执行结果肯定会出乎大家的意料,试一下把“1”换成“2”,会是同样的结果吗?

15

【强制】在JDK 7 及以上版本中,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 的比较结果相同。

反例:下例中没有处理相等的情况,交换两个对象判断结果并不互反,不符合第一个条件,在实际使用中可能会出现异常。

 new Comparator<Student>() {

        @Override

        public int compare(Student o1, Student o2) {

               return o1.getId() > o2.getId() ? 1 : -1;


               }

 };

16

【推荐】当使用泛型集合定义时,在JDK 7 及以上版本中,使用diamond 语法或全省略。

说明:菱形泛型即diamond,直接使用<>指代前边已经指定的类型。

正例:

 // diamond 方式,即<>

 Map<String, String> userCache = new HashMap<>(16);

 // 全省略方式

 List<User> users = new ArrayList(10);

17

【推荐】当集合初始化时,指定集合初始值大小。

说明:HashMap 使用HashMap(int initialCapacity)初始化,如果暂时无法确定集合大小,那么指定默认值(16)即可。

正例:initialCapacity = (需要存储的元素个数/负载因子) + 1。注意负载因子(即loader factor)默认为0.75,如果暂时无法确定初始值大小,则设置为16(即默认值)。

反例:HashMap 需要放置1024 个元素,由于没有设置容量初始大小,则随着元素的增加而被迫不断扩容,resize()方法一共会调用8次,反复重建哈希表和数据迁移。当放置的集合元素规模达千万级时,会影响程序性能。

18

【推荐】使用entrySet 遍历Map 类集合K/V,而不是用keySet方式遍历。

说明:keySet 方式其实遍历了两次,一次是转为Iterator 对象,另一次是从hashMap 中取出Key 所对应的Value。而entrySet 只遍历了一次就把Key 和Value 都放到了entry 中,效率更高。如果是JDK 8,则使用Map.forEach 方法。

正例:values()返回的是V 值集合,是一个list 集合对象;keySet()返回的是K 值集合,是一个Set 集合对象;entrySet()返回的是K-V 值组合集合。

19

【推荐】高度注意Map 类集合K/V 能否存储null 值,如表1-1所示。


表1-1 Map 类集合K/V 存储

1.jpg

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

20

【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明:有序性指遍历的结果按某种比较规则依次排列。稳定性指集合每次遍历的元素次序是一定的。如:ArrayList 是order/unsort;HashMap 是unorder/unsort;TreeSet 是order/sort。

21

【参考】利用Set 元素唯一的特性,可以快速对一个集合进行去重操作,避免使用List 的contains()进行遍历、去重或者判断包含操作。

相关文章
|
1天前
|
SQL JavaScript 前端开发
用Java来开发Hive应用
用Java来开发Hive应用
14 7
|
1天前
|
SQL JavaScript 前端开发
用Java、Python来开发Hive应用
用Java、Python来开发Hive应用
11 6
|
5天前
|
安全 Java 关系型数据库
代码规范Java阿里巴巴
本文介绍了阿里巴巴的《Java开发手册》,这是一份业界公认的代码规范手册,涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度。手册通过强制、推荐、参考三大类规约,详细指导开发者编写高质量的Java代码。文中还提供了常见问题的正反例对比,如方法参数类型一致性、SimpleDateFormat线程安全等问题的解决方案。此外,还介绍了如何安装和使用阿里规范插件来提高编码效率。
45 9
消息中间件 缓存 监控
12 0
|
1天前
|
Java 数据库连接 数据格式
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
IOC/DI配置管理DruidDataSource和properties、核心容器的创建、获取bean的方式、spring注解开发、注解开发管理第三方bean、Spring整合Mybatis和Junit
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
|
5天前
|
算法 Oracle Java
Java字符串拼接技术演进及阿里巴巴的贡献
本文主要讲述了Java字符串拼接技术的演进历程,以及阿里巴巴贡献的最新实现 PR 20273。
|
10天前
|
数据采集 Java 数据挖掘
Java IO异常处理:在Web爬虫开发中的实践
Java IO异常处理:在Web爬虫开发中的实践
|
10天前
|
算法 Oracle Java
Java字符串拼接技术演进及阿里巴巴的贡献
本文主要讲述了Java字符串拼接技术的演进历程,以及阿里巴巴贡献的最新实现 PR 20273。
|
12天前
|
数据采集 存储 前端开发
Java爬虫开发:Jsoup库在图片URL提取中的实战应用
Java爬虫开发:Jsoup库在图片URL提取中的实战应用
|
16天前
|
存储 搜索推荐 Java
探索安卓开发中的自定义视图:打造个性化UI组件Java中的异常处理:从基础到高级
【8月更文挑战第29天】在安卓应用的海洋中,一个独特的用户界面(UI)能让应用脱颖而出。自定义视图是实现这一目标的强大工具。本文将通过一个简单的自定义计数器视图示例,展示如何从零开始创建一个具有独特风格和功能的安卓UI组件,并讨论在此过程中涉及的设计原则、性能优化和兼容性问题。准备好让你的应用与众不同了吗?让我们开始吧!