## 04 Arrays、Collections、Objects 常用方法源码解析
### 引导语
我们在工作中都会写工具类，但如何才能使写出来的工具类更好用，也是有一些技巧的。本章内容以三种平时工作中经常使用的工具类为例，从使用案例出发，再看看底层源码的实现，看看能否学习到一些工具类的技巧，以及三种工具类的实际使用场景。
下方是本专栏 GitHub 地址： 源码解析：https://github.com/luanqiu/java8
文章 demo：https://github.com/luanqiu/java8_demo
### 1 工具类通用的特征
再看细节之前，我们先总结一下好的工具类都有哪些通用的特征写法：
1. 构造器必须是私有的。这样的话，工具类就无法被 new 出来，因为工具类在使用的时候，无需初始化，直接使用即可，所以不会开放出构造器出来。
2. 工具类的工具方法必须被 static、final 关键字修饰。这样的话就可以保证方法不可变，并且可以直接使用，非常方便。
我们需要注意的是，尽量不在工具方法中，对共享变量有做修改的操作访问（如果必须要做的话，必须加锁），因为会有线程安全的问题。除此之外，工具类方法本身是没有线程安全问题的，可以放心使用。
### 2 Arrays
Arrays 主要对数组提供了一些高效的操作，比如说排序、查找、填充、拷贝、相等判断等等。我们选择其中两三看下，对其余操作感兴趣的同学可以到 GitHub 上查看源码解析。
#### 2.1 排序
Arrays.sort 方法主要用于排序，入参支持 int、long、double 等各种基本类型的数组，也支持自定义类的数组，下面我们写个 demo 来演示一下自定义类数组的排序：
**ArraysDemo.java**
```
package demo.two;
import com.alibaba.fastjson.JSON;
import com.google.common.collect.ImmutableList;
import org.junit.Test;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
/**
* ArraysDemo
*author wenhe
*date 2019/8/3
*/
@Slf4j
public class ArraysDemo {
@Test
public void testSort(){
List<SortDTO> list = ImmutableList.of(
new SortDTO("300"),
new SortDTO("50"),
new SortDTO("200"),
new SortDTO("220")
);
// 我们先把数组的大小初始化成 list 的大小
SortDTO[] array = new SortDTO[list.size()];
list.toArray(array);
log.info("排序之前：{}", JSON.toJSONString(array));
Arrays.sort(array, Comparator.comparing(SortDTO::getSortTarget));
log.info("排序之后：{}", JSON.toJSONString(array));
}
@Test
public void testBinarySearch(){
List<SortDTO> list = ImmutableList.of(
new SortDTO("300"),
new SortDTO("50"),
new SortDTO("200"),
new SortDTO("220")
);
SortDTO[] array = new SortDTO[list.size()];
list.toArray(array);
log.info("搜索之前：{}", JSON.toJSONString(array));
Arrays.sort(array, Comparator.comparing(SortDTO::getSortTarget));
log.info("先排序，结果为：{}", JSON.toJSONString(array));
int index = Arrays.binarySearch(array, new SortDTO("200"),
Comparator.comparing(SortDTO::getSortTarget));
if(index<0){
throw new RuntimeException("没有找到 200");
}
log.info("搜索结果：{}", JSON.toJSONString(array[index]));
}
@Data
class SortDTO {
private String sortTarget;
public SortDTO(String sortTarget) {
this.sortTarget = sortTarget;
}
}
class SortDTO1 implements Comparable<SortDTO1> {
private String sortTarget;
public SortDTO1(String sortTarget) {
this.sortTarget = sortTarget;
}
@Override
public int compareTo(SortDTO1 o) {
return o.sortTarget.compareTo(sortTarget);
}
}
@Test
public void testMax() {
Collection<SortDTO1> list = ImmutableList.of(
new SortDTO1("300"),
new SortDTO1("50"),
new SortDTO1("200"),
new SortDTO1("220")
);
Collections.max(list);
}
@Test
public void testSearch(){
//0~10
System.out.println("(0 + 10-1) >>> 1:"+((0 + 10-1) >>> 1));
System.out.println("(0 + 11-1) >>> 1:"+((0 + 11-1) >>> 1));
System.out.println("(1 + 11-1) >>> 1:"+((1 + 11-1) >>> 1));
System.out.println("(1 + 10-1) >>> 1:"+((1 + 10-1) >>> 1));
}
}
```
```
@Data//自定义类
class SortDTO {
private String sortTarget;
public SortDTO(String sortTarget) {
this.sortTarget = sortTarget;
}
}
@Test
public void testSort(){
List<SortDTO> list = ImmutableList.of(
new SortDTO("300"),
new SortDTO("50"),
new SortDTO("200"),
new SortDTO("220")
);
// 我们先把数组的大小初始化成 list 的大小
SortDTO[] array = new SortDTO[list.size()];
list.toArray(array);
log.info("排序之前：{}", JSON.toJSONString(array));
Arrays.sort(array, Comparator.comparing(SortDTO::getSortTarget));
log.info("排序之后：{}", JSON.toJSONString(array));
}
```
输出结果为： 排序之前：
```
[{"sortTarget":"300"},{"sortTarget":"50"},{"sortTarget":"200"},{"sortTarget":"220"}]
```
排序之后：
```
[{"sortTarget":"200"},{"sortTarget":"220"},{"sortTarget":"300"},{"sortTarget":"50"}]
```
从输出的结果中可以看到，排序之后的数组已经是有顺序的了，也可以看到 sort 方法支持两个入参：要排序的数组和外部排序器。
大家都说 sort 方法排序的性能较高，主要原因是 sort 使用了双轴快速排序算法，具体算法就不细说了。
#### 2.1 二分查找法
Arrays.binarySearch 方法主要用于快速从数组中查找出对应的值。其支持的入参类型非常多，如 byte、int、long 各种类型的数组。返回参数是查找到的对应数组下标的值，如果查询不到，则返回负数。
我们写了一个 demo 如下：
```
@Test
public void testBinarySearch(){
List<SortDTO> list = ImmutableList.of(
new SortDTO("300"),
new SortDTO("50"),
new SortDTO("200"),
new SortDTO("220")
);
SortDTO[] array = new SortDTO[list.size()];
list.toArray(array);
log.info("搜索之前：{}", JSON.toJSONString(array));
Arrays.sort(array, Comparator.comparing(SortDTO::getSortTarget));
log.info("先排序，结果为：{}", JSON.toJSONString(array));
int index = Arrays.binarySearch(array, new SortDTO("200"),
Comparator.comparing(SortDTO::getSortTarget));
if(index<0){
throw new RuntimeException("没有找到 200");
}
log.info("搜索结果：{}", JSON.toJSONString(array[index]));
}
```
输出的结果为：
搜索之前：
```
[{"sortTarget":"300"},{"sortTarget":"50"},{"sortTarget":"200"},{"sortTarget":"220"}]
```
先排序，结果为：
```
[{"sortTarget":"200"},{"sortTarget":"220"},{"sortTarget":"300"},{"sortTarget":"50"}]
```
搜索结果：
```
{"sortTarget":"200"}
```
从上述代码中我们需要注意两点：
1. 如果被搜索的数组是无序的，一定要先排序，否则二分搜索很有可能搜索不到，我们 demo 里面也先对数组进行了排序；
2. 搜索方法返回的是数组的下标值。如果搜索不到，返回的下标值就会是负数，这时我们需要判断一下正负。如果是负数，还从数组中获取数据的话，会报数组越界的错误。demo 中对这种情况进行了判断，如果是负数，会提前抛出明确的异常。
接下来，我们来看下二分法底层代码的实现：
```
// a：我们要搜索的数组，fromIndex：从那里开始搜索，默认是0； toIndex：搜索到何时停止，默认是数组大小 // key：我们需要搜索的值 c：外部比较器 private static <T> int binarySearch0(T[] a, int fromIndex, int toIndex, T key, Comparator<? super T> c) { // 如果比较器 c 是空的，直接使用 key 的 Comparable.compareTo 方法进行排序 // 假设 key 类型是 String 类型，String 默认实现了 Comparable 接口，就可以直接使用 compareTo 方法进行排序 if (c == null) { // 这是另外一个方法，使用内部排序器进行比较的方法 return binarySearch0(a, fromIndex, toIndex, key); } int low = fromIndex; int high = toIndex - 1; // 开始位置小于结束位置，就会一直循环搜索 while (low <= high) { // 假设 low =0，high =10，那么 mid 就是 5，所以说二分的意思主要在这里，每次都是计算索引的中间值 int mid = (low + high) >>> 1; T midVal = a[mid]; // 比较数组中间值和给定的值的大小关系 int cmp = c.compare(midVal, key); // 如果数组中间值小于给定的值，说明我们要找的值在中间值的右边 if (cmp < 0) low = mid + 1; // 我们要找的值在中间值的左边 else if (cmp > 0) high = mid - 1; else // 找到了 return mid; // key found }
// 返回的值是负数，表示没有找到 return -(low + 1); // key not found. }
```
二分的主要意思是每次查找之前，都找到中间值，然后拿我们要比较的值和中间值比较，根据结果修改比较的上限或者下限，通过循环最终找到相等的位置索引，以上代码实现比较简洁，大家可以在自己理解的基础上，自己复写一遍。
#### 2.2 拷贝
数组拷贝我们经常遇到，有时需要拷贝整个数组，有时需要拷贝部分，比如 ArrayList 在 add（扩容） 或 remove（删除元素不是最后一个） 操作时，会进行一些拷贝。拷贝整个数组我们可以使用 copyOf 方法，拷贝部分我们可以使用 copyOfRange 方法，以 copyOfRange 为例，看下底层源码的实现：
```
// original 原始数组数据 // from 拷贝起点 // to 拷贝终点 public static char[] copyOfRange(char[] original, int from, int to) { // 需要拷贝的长度 int newLength = to - from; if (newLength < 0) throw new IllegalArgumentException(from + " > " + to); // 初始化新数组 char[] copy = new char[newLength]; // 调用 native 方法进行拷贝，参数的意思分别是： // 被拷贝的数组、从数组那里开始、目标数组、从目的数组那里开始拷贝、拷贝的长度 System.arraycopy(original, from, copy, 0, Math.min(original.length - from, newLength)); return copy; }
```
从源码中，我们发现，Arrays 的拷贝方法，实际上底层调用的是 System.arraycopy 这个 native 方法，如果你自己对底层拷贝方法比较熟悉的话，也可以直接使用。
### 3 Collections
Collections 是为了方便使用集合而产生的工具类，Arrays 方便数组使用，Collections 是方便集合使用。
Collections 也提供了 sort 和 binarySearch 方法，sort 底层使用的就是 Arrays.sort 方法，binarySearch 底层是自己重写了二分查找算法，实现的逻辑和 Arrays 的二分查找算法完全一致，这两个方法上 Collections 和 Arrays 的内部实现很类似，接下来我们来看下 Collections 独有的特性。
#### 3.1 求集合中最大、小值
提供了 max 方法来取得集合中的最大值，min 方法来取得集合中的最小值，max 和 min 方法很相似的，我们以 max 方法为例来说明一下，max 提供了两种类型的方法，一个需要传外部排序器，一个不需要传排序器，但需要集合中的元素强制实现 Comparable 接口，后者的泛型定义很
有意思，我们来看下（从右往左看）：
从这段源码中，我们可以学习到两点：
1. max 方法泛型 T 定义得非常巧妙，意思是泛型必须继承 Object 并且实现 Comparable 的接口。一般让我们来定义的话，我们可以会在方法里面去判断有无实现 Comparable 的接口，这种是在运行时才能知道结果。而这里泛型直接定义了必须实现 Comparable 接口，在编译的时候就可告诉使用者，当前类没有实现 Comparable 接口，使用起来很友好；
2. 给我们提供了实现两种排序机制的好示例：自定义类实现 Comparable 接口和传入外部排序器。两种排序实现原理类似，但实现有所差别，我们在工作中如果需要些排序的工具类时，可以效仿。
#### 3.2 多种类型的集合
Collections 对原始集合类进行了封装，提供了更好的集合类给我们，一种是线程安全的集合，一种是不可变的集合，针对 List、Map、Set 都有提供，我们先来看下线程安全的集合：
#### 3.2.1 线程安全的集合
线程安全的集合方法都是 synchronized 打头的，如下：
从方法命名我们都可以看出来，底层是通过 synchronized 轻量锁来实现的，我们以 synchronizedList 为例来说明
下底层的实现：
可以看到 List 的所有操作方法都被加上了 synchronized 锁，所以多线程对集合同时进行操作，是线程安全的。
#### 3.2.1 不可变的集合
得到不可变集合的方法都是以 unmodifiable 开头的。这类方法的意思是，我们会从原集合中，得到一个不可变的新集合，新集合只能访问，无法修改；一旦修改，就会抛出异常。这主要是因
为只开放了查询方法，其余任何修改操作都会抛出异常，我们以unmodifiableList 为例来看下底层实现机制：
#### 3.2.2 小结
以上两种 List 其实解决了工作中的一些困惑，比如说 ArrayList 是线程不安全的，然后其内部数组很容易被修改，有的时候，我们希望 List 一旦生成后，就不能被修改，Collections 对 List 重新进行了封装，提供了两种类型的集合封装形式，从而解决了工作中的一些烦恼，如果你平时使用 List 时有一些烦恼，也可以学习此种方式，自己对原始集合进行封装，来解决 List 使用过程中的不方便。
### 4 Objects
对于 Objects，我们经常使用的就是两个场景，相等判断和判空。
#### 4.1 相等判断
Objects 有提供 equals 和 deepEquals 两个方法来进行相等判断，前者是判断基本类型和自定义类的，后者是用来判断数组的，我们来看下底层的源码实现：
从源码中，可以看出 Objects 对基本类型和复杂类型的对象，都有着比较细粒度的判断，可以放心使用。
#### 4.2 为空判断
Objects 提供了各种关于空的一些判断，isNull 和 nonNull 对于对象是否为空返回 Boolean 值，requireNonNull 方法更加严格，如果一旦为空，会直接抛出异常，我们需要根据生活的场景选择使用。
### 5 面试题
#### 5.1 工作中有没有遇到特别好用的工具类，如何写好一个工具类
答：有的，像 Arrays 的排序、二分查找、Collections 的不可变、线程安全集合类、Objects 的判空相等判断等等工具类，好的工具类肯定很好用，比如说使用 static final 关键字对方法进行修饰，工具类构造器必须是私有等等手段来写好工具类。
#### 5.2 写一个二分查找算法的实现
答：可以参考 Arrays 的 binarySearch 方法的源码实现。
#### 5.3 如果我希望 ArrayList 初始化之后，不能被修改，该怎么办
答：可以使用 Collections 的 unmodifiableList 的方法，该方法会返回一个不能被修改的内部类集合，这些集合类只开放查询的方法，对于调用修改集合的方法会直接抛出异常。
### 总结
从三大工具类中，我们不仅学习到了如何写好一个工具类，还熟悉了三大工具类的具体使用姿势，甚至了解了其底层的源码实现，有兴趣的话，可以自己也可以仿照写个好用的工具类加深学习。
- 前言
- 第1章 基础
- 01 开篇词：为什么学习本专栏
- 02 String、Long 源码解析和面试题
- 03 Java 常用关键字理解
- 04 Arrays、Collections、Objects 常用方法源码解析
- 第2章 集合
- 05 ArrayList 源码解析和设计思路
- 06 LinkedList 源码解析
- 07 List 源码会问哪些面试题
- 08 HashMap 源码解析
- 09 TreeMap 和 LinkedHashMap 核心源码解析
- 10 Map源码会问哪些面试题
- 11 HashSet、TreeSet 源码解析
- 12 彰显细节：看集合源码对我们实际工作的帮助和应用
- 13 差异对比：集合在 Java 7 和 8 有何不同和改进
- 14 简化工作：Guava Lists Maps 实际工作运用和源码
- 第3章 并发集合类
- 15 CopyOnWriteArrayList 源码解析和设计思路
- 16 ConcurrentHashMap 源码解析和设计思路
- 17 并发 List、Map源码面试题
- 18 场景集合：并发 List、Map的应用场景
- 第4章 队列
- 19 LinkedBlockingQueue 源码解析
- 20 SynchronousQueue 源码解析
- 21 DelayQueue 源码解析
- 22 ArrayBlockingQueue 源码解析
- 23 队列在源码方面的面试题
- 24 举一反三：队列在 Java 其它源码中的应用
- 25 整体设计：队列设计思想、工作中使用场景
- 26 惊叹面试官：由浅入深手写队列
- 第5章 线程
- 27 Thread 源码解析
- 28 Future、ExecutorService 源码解析
- 29 押宝线程源码面试题
- 第6章 锁
- 30 AbstractQueuedSynchronizer 源码解析（上）
- 31 AbstractQueuedSynchronizer 源码解析（下）
- 32 ReentrantLock 源码解析
- 33 CountDownLatch、Atomic 等其它源码解析
- 34 只求问倒：连环相扣系列锁面试题
- 35 经验总结：各种锁在工作中使用场景和细节
- 36 从容不迫：重写锁的设计结构和细节
- 第7章 线程池
- 37 ThreadPoolExecutor 源码解析
- 38 线程池源码面试题
- 39 经验总结：不同场景，如何使用线程池
- 40 打动面试官：线程池流程编排中的运用实战
- 第8章 Lambda 流
- 41 突破难点：如何看 Lambda 源码
- 42 常用的 Lambda 表达式使用场景解析和应用
- 第9章 其他
- 43 ThreadLocal 源码解析
- 44 场景实战：ThreadLocal 在上下文传值场景下的实践
- 45 Socket 源码及面试题
- 46 ServerSocket 源码及面试题
- 47 工作实战：Socket 结合线程池的使用
- 第10章 专栏总结
- 48 一起看过的 Java 源码和面试真题