Java Guava

一、不可变集合

不可变集合,顾名思义就是说集合是不可被修改的。集合的数据项是在创建的时候提供,并且在整个生命周期中都不可改变,一旦不可变集合创建之后,是不可以对集合里面的做增,改操作的.为什么需要不可变集合,不可变集合的优势在哪里呢:

  • 对不可靠的客户代码库来说,它使用安全,可以在未受信任的类库中安全的使用这些对象.
  • 线程安全的:immutable对象在多线程下安全,没有竞态条件
  • 不可变集合不需要考虑变化,因此可以节省时间和空间。所有不可变的集合都比它们的可变形式有更好的内存利用率(分析和测试细节)
  • 不可变对象因为固定不变,可以作为常量来安全使用先看下Guava库里面提供了哪些不可变集合,以及这些集合和JDK里面集合的关系.直接用表格形式列出,如下所示; | 可变集合接口 | 属于JDK还是Guava | 不可变版本 | | —- | —- | —- | | Collection | JDK | ImmutableCollection | | List | JDK | ImmutableList | | Set | JDK | ImmutableSet | | SortedSet/NavigableSet | JDK | ImmutableSortedSet | | Map | JDK | ImmutableMap | | SortedMap | JDK | ImmutableSortedMap | | Multiset | Guava | ImmutableMultiset | | SortedMultiset | Guava | ImmutableSortedMultiset | | Multimap | Guava | ImmutableMultimap | | ListMultimap | Guava | ImmutableListMultimap | | SetMultimap | Guava | ImmutableSetMultimap | | BiMap | Guava | ImmutableBiMap | | ClassToInstanceMap | Guava | ImmutableClassToInstanceMap | | Table | Guava | ImmutableTable |

1.1 不可变集合的使用

Guava库里面不可变集合的使用主要在两个方面吧,一个是怎么创建不可变集合,另一个是怎么获取不可变集合里面的元素.关于怎么获取里面的元素,这个咱们不讲.和JDK里面使用集合是一样的.接下来要讲的主要在怎么去创建不可变集合.Guava库里面提供的每个不可变集合类都有如下三种方法.
如果尝试去修改不可变集合会跑出UnsupportedOperationException异常.

  • 调用静态方法of创建.of()方法通过给定集合里面的元素来生成不可变集合.

    1. ImmutableList<String> imutableUserList = ImmutableList.of("jiangxi", "nanchang");
  • 调用静态方法copyOf创建.可以简单的理解为copyOf方法就是讲对应的JDK集合转换为Guava不可变集合.如果想将List转换为不可变集合,就使用ImmutableList.copyOf(list)方法,如果想Set装换为不可变集合就调用ImmutableSet.copyOf(set),其他的不可变集合也是类似的.

    1. List<String> userList = new ArrayList<>();
    2. userList.add("jiangxi");
    3. userList.add("nanchang");
    4. ImmutableList<String> imutableUserList = ImmutableList.copyOf(userList);
  • 调用静态方法build创建.

    1. ImmutableList imutableUserList = ImmutableList.builder()
    2. .add("jiangxi")
    3. .add("nanchang")
    4. .build();

    Guava库里面每个不可变集合一般都有这三种方法来创建对应的不可变集合.当然了里面还有一些其他的方法,都可以到源码里面去看.都是很好理解的一些方法.

    二、新集合类型

    Guava引入了很多JDK没有的(multisets, multimaps, tables, bidirectional maps等)、但发现明显有用的新集合类型。这些新类型是为了和JDK集合框架共存,而没有往JDK集合抽象中硬塞其他概念。作为一般规则,Guava集合非常精准地遵循了JDK接口契约。将白了就是和JDK里面集合的使用是差不多的.

    2.1 Multiset

    Guava提供了一个新的Set类型Multiset,它可以多次添加相等的元素到Set里面去.Multiset有很多实现类.先看下Multiset里面的主要方法:

方法 描述
count(E) 给定元素在Multiset中的计数
elementSet() Multiset中不重复元素的集合,类型为Set
entrySet() 和Map的entrySet类似,返回Set,其中包含的Entry支持getElement()和getCount()方法</multiset.entry
add(E, int) 增加给定元素在Multiset中的计数
remove(E, int) 减少给定元素在Multiset中的计数
setCount(E, int) 设置给定元素在Multiset中的计数,不可以为负数
size() 返回集合元素的总个数(包括重复的元素)

Guava提供了多种Multiset的实现类,大部分都是和JDK中Set类一一对应的,有些也是Guava特有的.

Multiset实现类 JDK对应 内部实现
HashMultiset HashSet HashMap
TreeMultiset TreeSet TreeMap
LinkedHashMultiset LinkedHashSet LinkedHashMap
ConcurrentHashMultiset LinkedHashSet ConcurrentHashMap
ImmutableMultiset
ImmutableMap
SortedMultiset

| SortedMultiset是Multiset 接口的变种,支持排序 |

2.3 Multimap

每个有经验的Java程序员都在某处实现过Map<k, List>Map<k, Set>,并且要忍受这个结构的笨拙。例如,Map<k, Set>通常用来表示非标定有向图。Guava的 Multimap可以很容易地把一个键映射到多个值。换句话说,Multimap是把键映射到任意多个值的一般方式。说白了就是一个key可以对应多个value.Multimap的使用和咱JDK里面Map的使用是类似的.
Multimap的各种实现类.
</k, </k, </k,

Multimap实现类 键行为类似 行为类似
ArrayListMultimap HashMap ArrayList
HashMultimap HashMap HashSet
LinkedListMultimap* LinkedHashMap LinkedList*
LinkedHashMultimap** LinkedHashMap LinkedHashMap
TreeMultimap TreeMap TreeSet
ImmutableListMultimap ImmutableMap ImmutableList
mmutableSetMultimap ImmutableMap ImmutableSet

2.4 BiMap

BiMap是特殊的Map.BiMap提供了一种新的集合类型,它提供了key和value的双向关联的数据结构。平常咱们用的最多的都是通过key获取value.但是反过来通过value获取key就比较复杂了.BiMap就是来解决这个问题的.BiMap有一个神奇的方法BiMap.inverse().可以把Map里面的key,value反过来.BiMap里面key和value都是唯一的不能重复.

对应的BiMap实现 键–值实现 值–键实现
HashBiMap HashMap HashMap
ImmutableBiMap ImmutableMap ImmutableMap
EnumBiMap EnumMap EnumMap
EnumHashBiMap EnumMap HashMap

关于BiMap里面各个类api方法都是很容易懂的.

2.5 Table

当需要多个索引的数据结构的时候,通常情况下,只能用这种丑陋的Map<firstname,Map>来实现。为此Guava提供了一个新的集合类型-Table集合类型,来支持这种数据结构的使用场景。Table支持“row”和“column”,Table是Guava提供的一个接口 Interface Table,由rowKey+columnKey+value组成它有两个键,一个值,和一个n行三列的数据表类似,n行取决于Table对对象中存储了多少个数据.
对于Table而言里面的每个value都有两个key(rowKey,columnKey)
Table主要方法介绍,每个方法其实都很好理解:

  1. public interface Table<R, C, V> {
  2. /**
  3. * 指定行,列对应的值是否存在
  4. */
  5. boolean contains(
  6. @Nullable @CompatibleWith("R") Object rowKey,
  7. @Nullable @CompatibleWith("C") Object columnKey);
  8. /**
  9. * 指定行对应的值是否存在
  10. */
  11. boolean containsRow(@Nullable @CompatibleWith("R") Object rowKey);
  12. /**
  13. * 指定列对应的值是否存在
  14. */
  15. boolean containsColumn(@Nullable @CompatibleWith("C") Object columnKey);
  16. /**
  17. * 值是否存在
  18. */
  19. boolean containsValue(@Nullable @CompatibleWith("V") Object value);
  20. /**
  21. * 获取指定行,列对应的值
  22. */
  23. V get(
  24. @Nullable @CompatibleWith("R") Object rowKey,
  25. @Nullable @CompatibleWith("C") Object columnKey);
  26. /** Returns {@code true} if the table contains no mappings. */
  27. boolean isEmpty();
  28. /** 获取元素个数 */
  29. int size();
  30. // Mutators
  31. /** 清空 */
  32. void clear();
  33. /**
  34. * 放入元素
  35. */
  36. @CanIgnoreReturnValue
  37. @Nullable
  38. V put(R rowKey, C columnKey, V value);
  39. /**
  40. * 放入元素
  41. */
  42. void putAll(Tableextends R, ? extends C, ? extends V> table);
  43. /**
  44. * 移除元素
  45. */
  46. @CanIgnoreReturnValue
  47. @Nullable
  48. V remove(
  49. @Nullable @CompatibleWith("R") Object rowKey,
  50. @Nullable @CompatibleWith("C") Object columnKey);
  51. /**
  52. * 指定行的所有数据
  53. */
  54. Map row(R rowKey);
  55. /**
  56. * 指定列的所有数据
  57. */
  58. Map column(C columnKey);
  59. /**
  60. * 用元素类型为Table.Cell<R, C, V>的Set表现Table<R, C, V>。
  61. * Cell类似于Map.Entry,但它是用行和列两个键区分的。
  62. */
  63. Set<table.cell> cellSet();
  64. /**
  65. * 获取Table里面所有行的key
  66. */
  67. Set rowKeySet();
  68. /**
  69. * 获取Table里面所有列的key
  70. */
  71. Set columnKeySet();
  72. /**
  73. * 获取Table里面所有的值
  74. */
  75. Collection values();
  76. /**
  77. * 用Map<R, Map<C, V>>表现Table<R, C, V>
  78. */
  79. Map<r, Map> rowMap();
  80. /**
  81. * 用Map<C, Map<R, V>>表现Table<R, C, V>
  82. */
  83. Map<c, Map> columnMap();
  84. }

Table的实现类,以及内部是用啥数据类型实现的.

对应的Table实现 内部实现
HashBasedTable HashMap
TreeBasedTable TreeMap
ImmutableTable ImmutableMap
ArrayTable 二维数组

2.6 ClassToInstanceMap

ClassToInstanceMap提供了一种是用Class作为Key, 对应实例作为Value的途径.他定义了T getInstance(Class<T>)T putInstance(Class<T> T)两个方法, 这两个方法消除了元素类型转换的过程并保证了元素在Map中是类型安全的.使用ClassToInstanceMap的唯一目的就是消除类型转换过程中可能产生的错误.比如在传递参数的时候就可以用上ClassToInstanceMap了.

ClassToInstanceMap实现类 解释
MutableClassToInstanceMap 可变类型的ClassToInstanceMap
ImmutableClassToInstanceMap 不可变更的ClassToInstanceMap,在对这个Map构造完成后就不可再变更
  1. ClassToInstanceMap classToInstanceMap = MutableClassToInstanceMap.create();
  2. classToInstanceMap.putInstance(Integer.class, 10);
  3. classToInstanceMap.putInstance(Float.class, 10L);
  4. classToInstanceMap.putInstance(String.class, "abc");

2.7 RangeSet

RangeSet描述了一组不相连的、非空的区间。当把一个区间添加到可变的RangeSet时,所有相连的区间会被合并,空区间会被忽略。
关于RangeSet咱们的关注点在两个方面:一个是RangeSet的值是可以比较的所以RangeSet里面的值对应的对象需要实现Comparable接口、第二个是范围,guava里面通过Range类来表示范围。关于Range里面方法也做一个简单的介绍(不同的函数代表不同的区间),如下:

概念 表示范围 guava Range类对应方法
(a..b) {x a < x < b}
[a..b] {x a <= x <= b}
[a..b) {x a <= x < b}
(a..b] {x a < x <= b}
(a..+∞) {x x > a}
[a..+∞) {x x >= a}
(-∞..b) {x x < b}
(-∞..b] {x x <= b}
(-∞..+∞) all values all()

RangeSet方法介绍,如下:

  1. public interface RangeSet {
  2. /** 是否包含值 */
  3. boolean contains(C value);
  4. /**
  5. * 获取值所在的区间
  6. */
  7. Range rangeContaining(C value);
  8. /**
  9. * 判断RangeSet中是否有任何区间和给定区间交叉
  10. */
  11. boolean intersects(Range otherRange);
  12. /**
  13. * 判断RangeSet中是否有任何区间包括给定区间
  14. */
  15. boolean encloses(Range otherRange);
  16. /**
  17. * 同上,如果RangeSet的范围都在当前RangeSet里面则返回true
  18. */
  19. boolean enclosesAll(RangeSet other);
  20. /**
  21. * 同上,给定的参数的范围都在当前RangeSet里面则返回true
  22. */
  23. default boolean enclosesAll(Iterable<range> other)</range {
  24. for (Range range : other) {
  25. if (!encloses(range)) {
  26. return false;
  27. }
  28. }
  29. return true;
  30. }
  31. /** 是否为null */
  32. boolean isEmpty();
  33. /**
  34. * 返回包括RangeSet中所有区间的最小区间
  35. */
  36. Range span();
  37. /**
  38. * 用Set<range>表现RangeSet,这样可以遍历其中的Range
  39. */</range
  40. Set<range> asRanges();
  41. /**
  42. * 返回组成此范围集的断开连接的范围的降序视图
  43. */
  44. Set<range> asDescendingSetOfRanges();
  45. /**
  46. * 返回RangeSet的补集视图。complement也是RangeSet类型,包含了不相连的、非空的区间。
  47. */
  48. RangeSet complement();
  49. /**
  50. * 返回RangeSet与给定Range的交集视图。这扩展了传统排序集合中的headSet、subSet和tailSet操作
  51. */
  52. RangeSet subRangeSet(Range view);
  53. /**
  54. * 增加一个范围区间
  55. */
  56. void add(Range range);
  57. /**
  58. * 移除一个范围区间,如果有交叉的话,会被分割
  59. */
  60. void remove(Range range);
  61. /**
  62. * 清空
  63. */
  64. void clear();
  65. /**
  66. * 增加参数里面所有的区间到当前RangeSet里面去
  67. */
  68. void addAll(RangeSet other);
  69. /**
  70. * 同上把参数给定的区间都增加到当前RangeSet里面去
  71. */
  72. default void addAll(Iterable<range> ranges)</range {
  73. for (Range range : ranges) {
  74. add(range);
  75. }
  76. }
  77. /**
  78. * 移除参数给定的所有区间,如果有交集的情况会拆分
  79. */
  80. void removeAll(RangeSet other);
  81. /**
  82. * 移除参数给定的所有区间,如果有交集的情况会拆分
  83. */
  84. default void removeAll(Iterable<range> ranges)</range {
  85. for (Range range : ranges) {
  86. remove(range);
  87. }
  88. }
  89. }

RangeSet实现类,guava提供了两个实现类,有兴趣的也可以进去看看源码,如下:

RangeSet实现类 解释
ImmutableRangeSet 是一个不可修改的RangeSet
TreeRangeSet 利用树的形式来实现

RangeSet简单使用

  1. RangeSet rangeSet = TreeRangeSet.create();
  2. rangeSet.add(Range.closed(1, 10));
  3. System.out.println(rangeSet); // [[1..10]]
  4. rangeSet.add(Range.closedOpen(11, 15));
  5. System.out.println(rangeSet); // [[1..10], [11..15)]
  6. rangeSet.add(Range.open(15, 20));
  7. System.out.println(rangeSet); // [[1..10], [11..15), (15..20)]
  8. rangeSet.add(Range.openClosed(0, 0));
  9. System.out.println(rangeSet); // [[1..10], [11..15), (15..20)]
  10. rangeSet.remove(Range.open(5, 10));
  11. System.out.println(rangeSet); // [[1..5], [10..10], [11..15), (15..20)]

2.8 RangeMap

angeMap描述了”不相交的、非空的区间”到特定值的映射。和RangeSet不同,RangeMap不会合并相邻的映射,即便相邻的区间映射到相同的值。说的简单直白一点RangeMap就是以区间作为键。
RangeMap方法介绍,如下:

  1. public interface RangeMap {
  2. /**
  3. * 获取范围对应的元素(子范围也是可以的)
  4. */
  5. @Nullable
  6. V get(K key);
  7. /**
  8. * 如果范围映射中存在此类范围,则返回包含此键及其关联值的范围
  9. * 1\. 先根据范围找到值
  10. * 2\. 在根据值找到,所有范围
  11. */
  12. @Nullable
  13. Map.Entry<range, V> getEntry(K key);
  14. /**
  15. * 返回包含此RangeMap中范围的最小范围
  16. */
  17. Range span();
  18. /**
  19. * 放入一个元素
  20. */
  21. void put(Range range, V value);
  22. /**
  23. * 将范围映射到指定值,将此范围与具有与此范围相连的相同值的任何现有范围合并
  24. */
  25. void putCoalescing(Range range, V value);
  26. /** 放入值 */
  27. void putAll(RangeMap rangeMap);
  28. /** 清空 */
  29. void clear();
  30. /**
  31. * 移除
  32. */
  33. void remove(Range range);
  34. /**
  35. * 将此范围映射的视图作为不可修改的Map返回
  36. */
  37. Map<range, V> asMapOfRanges();
  38. /**
  39. * 将此范围映射的视图作为不可修改的Map返回
  40. */
  41. Map<range, V> asDescendingMapOfRanges();
  42. /**
  43. * 返回此范围映射的与范围相交的部分的视图
  44. */
  45. RangeMap subRangeMap(Range range);
  46. }

RangeMap有两个实现类。有兴趣的大家可以看看源码。

RangeMap实现类 解释
ImmutableRangeMap 不可以修改的RangeMap
TreeRangeMap 利用树的形式来实现

RangeMap简单使用:

  1. RangeMap rangeMap = TreeRangeMap.create();
  2. rangeMap.put(Range.closed(1, 10), "foo"); //{[1,10] => "foo"}
  3. rangeMap.put(Range.open(3, 6), "bar"); //{[1,3] => "foo", (3,6) => "bar", [6,10] => "foo"}
  4. rangeMap.put(Range.open(10, 20), "foo"); //{[1,3] => "foo", (3,6) => "bar", [6,10] => "foo", (10,20) => "foo"}
  5. rangeMap.remove(Range.closed(5, 11)); //{[1,3] => "foo", (3,5) => "bar", (11,20) => "foo"}

三、强大的集合工具类

提供java.util.Collections中没有的集合工具。任何对JDK集合框架有经验的程序员都熟悉和喜欢java.util.Collections包含的工具方法。Guava沿着这些路线提供了更多的工具方法:适用于所有集合的静态方法。这是Guava最流行和成熟的部分之一。

集合接口 属于JDK还是Guava 对应的Guava工具类
Iterable JDK Iterables
Collection JDK Collections2:不要和java.util.Collections混淆
List JDK Lists
Set JDK Sets
SortedSet JDK Sets
Map JDK Maps
SortedMap JDK Maps
Queue JDK Queues
Multiset Guava Multisets
Multimap Guava Multimaps
BiMap Guava Maps
Table Guava Tables

3.1 Iterables

  1. public final class Iterators {
  2. /**
  3. * 返回不可修改的迭代器
  4. */
  5. public static Iterable unmodifiableIterable(final Iterableextends T> iterable);
  6. @Deprecated
  7. public static Iterable unmodifiableIterable(ImmutableCollection iterable);
  8. /** 元素个数 */
  9. public static int size(Iterable iterable);
  10. /**
  11. * 是否包含指定元素
  12. */
  13. public static boolean contains(Iterable iterable, @Nullable Object element);
  14. /**
  15. * 移除集合类的元素
  16. */
  17. @CanIgnoreReturnValue
  18. public static boolean removeAll(Iterable removeFrom, Collection elementsToRemove);
  19. /**
  20. * 交集,完全属于
  21. */
  22. @CanIgnoreReturnValue
  23. public static boolean retainAll(Iterable removeFrom, Collection elementsToRetain);
  24. /**
  25. * 移除满足条件的元素
  26. */
  27. @CanIgnoreReturnValue
  28. public static boolean removeIf(Iterable removeFrom, Predicatesuper T> predicate);
  29. /** 移除第一个满足添加的元素,并且返回该元素 */
  30. static @Nullable T removeFirstMatching(
  31. Iterable removeFrom, Predicatesuper T> predicate);
  32. /**
  33. * 如果两个iterable中的所有元素相等且顺序一致,返回true
  34. */
  35. public static boolean elementsEqual(Iterable iterable1, Iterable iterable2);
  36. /**
  37. * 获取iterable中唯一的元素,如果iterable为空或有多个元素,则快速失败
  38. */
  39. public static T getOnlyElement(Iterable iterable);
  40. public static @Nullable T getOnlyElement(
  41. Iterableextends T> iterable, @Nullable T defaultValue);
  42. /**
  43. * 返回迭代器里面满足指定类型的元素对应的数据
  44. */
  45. @GwtIncompatible // Array.newInstance(Class, int)
  46. public static T[] toArray(Iterableextends T> iterable, Class type);
  47. /**
  48. * 把迭代器里面的元素放入到数组里面去
  49. */
  50. static T[] toArray(Iterableextends T> iterable, T[] array);
  51. /**
  52. * 把迭代器里面的元素放入到数组里面去
  53. */
  54. static Object[] toArray(Iterable iterable);
  55. /**
  56. * 把迭代器里面的元素放入到集合里面去
  57. */
  58. private static Collection castOrCopyToCollection(Iterable iterable);
  59. /**
  60. * 集合里面的元素都添加到迭代器里面去
  61. */
  62. @CanIgnoreReturnValue
  63. public static boolean addAll(Collection addTo, Iterableextends T> elementsToAdd);
  64. /**
  65. * 返回对象在iterable中出现的次数
  66. */
  67. public static int frequency(Iterable iterable, @Nullable Object element) {
  68. if ((iterable instanceof Multiset)) {
  69. return ((Multiset) iterable).count(element);
  70. } else if ((iterable instanceof Set)) {
  71. return ((Set) iterable).contains(element) ? 1 : 0;
  72. }
  73. return Iterators.frequency(iterable.iterator(), element);
  74. }
  75. /**
  76. * 返回一个循环迭代器,可以比作是双向链表,最后一个又和第一个连接起来
  77. */
  78. public static Iterable cycle(final Iterable iterable);
  79. @SafeVarargs
  80. public static Iterable cycle(T... elements);
  81. /**
  82. * 串联起来
  83. */
  84. public static Iterable concat(Iterableextends T> a, Iterableextends T> b);
  85. public static Iterable concat(
  86. Iterableextends T> a, Iterableextends T> b, Iterableextends T> c)
  87. public static Iterable concat(
  88. Iterableextends T> a,
  89. Iterableextends T> b,
  90. Iterableextends T> c,
  91. Iterableextends T> d);
  92. @SafeVarargs
  93. public static Iterable concat(Iterableextends T>... inputs);
  94. public static Iterable concat(Iterableextends Iterableextends T>> inputs);
  95. /**
  96. * 对迭代器做划分,多少个元素一组, 每个分组没满个数的会填null
  97. * [a, b, c, d, e]} with a partition size of 3 yields {[[a, b, c], [d, e, null]]}
  98. */
  99. public static Iterable<List> partition(final Iterable iterable, final int size);
  100. /**
  101. * 对迭代器做划分,多少个元素一组, 每个分组没满个数的会填null
  102. * [a, b, c, d, e]} with a partition size of 3 yields {[[a, b, c], [d, e]]}
  103. */
  104. public static Iterable<List> paddedPartition(final Iterable iterable, final int size);
  105. /**
  106. * 过滤出满足条件的值
  107. */
  108. public static Iterable filter(
  109. final Iterable unfiltered, final Predicatesuper T> retainIfTrue);
  110. /**
  111. * 过滤出指定类型的元素
  112. */
  113. @SuppressWarnings("unchecked")
  114. @GwtIncompatible // Class.isInstance
  115. public static Iterable filter(final Iterable unfiltered, final Class desiredType);
  116. /**
  117. * 迭代器里面只要有一个元素满足条件就返回true
  118. */
  119. public static boolean any(Iterable iterable, Predicatesuper T> predicate);
  120. /**
  121. * 迭代器里面的每个元素是否都满足条件
  122. */
  123. public static boolean all(Iterable iterable, Predicatesuper T> predicate);
  124. /**
  125. * 获取满足条件的值
  126. */
  127. public static T find(Iterable iterable, Predicatesuper T> predicate);
  128. /**
  129. * 获取满足条件的值,如果没有找到返回defaultValue
  130. */
  131. public static @Nullable T find(
  132. Iterableextends T> iterable, Predicatesuper T> predicate, @Nullable T defaultValue);
  133. /**
  134. * 获取满足条件的值,值用Optional报装
  135. */
  136. public static Optional tryFind(Iterable iterable, Predicatesuper T> predicate);
  137. /**
  138. * 获取满足条件记录的位置
  139. */
  140. public static int indexOf(Iterable iterable, Predicatesuper T> predicate);
  141. /**
  142. * 对迭代器里面的每个记录做相应的转换
  143. */
  144. public static Iterable transform(
  145. final Iterable fromIterable, final Functionsuper F, ? extends T> function);
  146. /**
  147. * 获取指定位置记录
  148. */
  149. public static T get(Iterable iterable, int position);
  150. /**
  151. * 获取指定位置的的记录,如果没有找到返回defaultValue
  152. */
  153. public static @Nullable T get(
  154. Iterableextends T> iterable, int position, @Nullable T defaultValue);
  155. /**
  156. * 获取第一个记录,如果没有找到就用defaultValue代替
  157. */
  158. public static @Nullable T getFirst(Iterableextends T> iterable, @Nullable T defaultValue);
  159. /**
  160. * 获取最后一个记录
  161. */
  162. public static T getLast(Iterable iterable);
  163. /**
  164. * 获取最后一个记录,如果没有获取到就是defaultValue
  165. */
  166. public static @Nullable T getLast(Iterableextends T> iterable, @Nullable T defaultValue);
  167. /**
  168. * 获取最后一个记录
  169. */
  170. private static T getLastInNonemptyList(List list);
  171. /**
  172. * 返回跳过指定元素的Iterable
  173. */
  174. public static Iterable skip(final Iterable iterable, final int numberToSkip);
  175. /**
  176. * 返回一个(可能)被截取的iterable,元素个数最多为给定值
  177. */
  178. public static Iterable limit(final Iterable iterable, final int limitSize);
  179. /**
  180. * 返回一个用于过滤、转换集合中的数据
  181. */
  182. public static Iterable consumingIterable(final Iterable iterable);
  183. // Methods only in Iterables, not in Iterators
  184. /**
  185. * 判断可迭代对象元素是否为null
  186. */
  187. public static boolean isEmpty(Iterable iterable);
  188. /**
  189. * 获取排序之后的可迭代对象
  190. */
  191. @Beta
  192. public static Iterable mergeSorted(
  193. final Iterableextends Iterableextends T>> iterables,
  194. final Comparatorsuper T> comparator);
  195. }

3.2 Collections2

  1. public final class Collections2 {
  2. /**
  3. * 过滤
  4. */
  5. public static Collection filter(Collection unfiltered, Predicate super E> predicate);
  6. /**
  7. * 转换
  8. */
  9. public static Collection transform(
  10. Collection fromCollection, Functionsuper F, T> function);
  11. /**
  12. * 先将元素排序,在排列
  13. */
  14. @Beta
  15. public static <e extends comparable super E>> Collection<List> orderedPermutations(
  16. Iterable elements);
  17. @Beta
  18. public static Collection<List> orderedPermutations(
  19. Iterable elements, Comparator super E> comparator);
  20. /**
  21. * 直接排列
  22. */
  23. @Beta
  24. public static Collection<List> permutations(Collection elements);
  25. }

3.3 Lists

  1. public final class Lists {
  2. /**
  3. * 构造ArrayList
  4. */
  5. @GwtCompatible(serializable = true)
  6. public static ArrayList newArrayList();
  7. @SafeVarargs
  8. @GwtCompatible(serializable = true)
  9. public static ArrayList newArrayList(E... elements);
  10. @GwtCompatible(serializable = true)
  11. public static ArrayList newArrayList(Iterable extends E> elements);
  12. @GwtCompatible(serializable = true)
  13. public static ArrayList newArrayList(Iterator extends E> elements);
  14. /**
  15. * 构造一个带初始化带大小initialArraySize的ArrayList实例
  16. */
  17. @GwtCompatible(serializable = true)
  18. public static ArrayList newArrayListWithCapacity(int initialArraySize);
  19. /**
  20. * 构造一个期望长度为estimatedSize的ArrayList实例
  21. */
  22. @GwtCompatible(serializable = true)
  23. public static ArrayList newArrayListWithExpectedSize(int estimatedSize);
  24. // LinkedList
  25. /**
  26. * 获取LinkedList
  27. */
  28. @GwtCompatible(serializable = true)
  29. public static LinkedList newLinkedList();
  30. @GwtCompatible(serializable = true)
  31. public static LinkedList newLinkedList(Iterable extends E> elements);
  32. /**
  33. * CopyOnWriteArrayList 读写分离,线程安志的List
  34. */
  35. @GwtIncompatible // CopyOnWriteArrayList
  36. public static CopyOnWriteArrayList newCopyOnWriteArrayList();
  37. @GwtIncompatible // CopyOnWriteArrayList
  38. public static CopyOnWriteArrayList newCopyOnWriteArrayList(
  39. Iterable extends E> elements);
  40. /**
  41. * 转坏为List
  42. */
  43. public static List asList(@Nullable E first, E[] rest);
  44. public static List asList(@Nullable E first, @Nullable E second, E[] rest);
  45. /**
  46. * 对集合做笛卡尔操作
  47. * 假设集合A={a,b},集合B={0,1,2},则两个集合的笛卡尔积为{(a,0),(a,1),(a,2),(b,0),(b,1),(b,2)}
  48. */
  49. public static List<List> cartesianProduct(List extends List extends B>> lists);
  50. @SafeVarargs
  51. public static List<List> cartesianProduct(List extends B>... lists);
  52. /**
  53. * 对list里面的每个元素做转换
  54. */
  55. public static List transform(
  56. List fromList, Functionsuper F, ? extends T> function);
  57. /**
  58. * 对list做分区处理
  59. */
  60. public static List<List> partition(List list, int size);
  61. /**
  62. * String转换成不可变更的ImmutableList
  63. */
  64. public static ImmutableList charactersOf(String string);
  65. /**
  66. * CharSequence转list
  67. */
  68. @Beta
  69. public static List charactersOf(CharSequence sequence);
  70. /**
  71. * 反转
  72. */
  73. public static List reverse(List list);
  74. }

3.4 Sets

  1. public final class Sets {
  2. /**
  3. * 返回一个包含给定枚举元素的不可变的Set实例
  4. */
  5. // http://code.google.com/p/google-web-toolkit/issues/detail?id=3028
  6. @GwtCompatible(serializable = true)
  7. public static <e extends enum> ImmutableSet immutableEnumSet(
  8. E anElement, E... otherElements);
  9. @GwtCompatible(serializable = true)
  10. public static <e extends enum> ImmutableSet immutableEnumSet(Iterable elements);
  11. /**
  12. * 返回一个Collector
  13. */
  14. public static <e extends enum> Collector<e, ?, immutableset> toImmutableEnumSet();
  15. /**
  16. * 返回一个EnumSet实例
  17. */
  18. public static <e extends enum> EnumSet newEnumSet();
  19. // HashSet
  20. /**
  21. * 返回一个可变的HashSet实例
  22. */
  23. public static HashSet newHashSet();
  24. public static HashSet newHashSet(E... elements);
  25. public static HashSet newHashSet(Iterable elements);
  26. public static HashSet newHashSet(Iterator elements);
  27. /**
  28. * 构造一个期望长度为expectedSize的HashSet实例
  29. */
  30. public static HashSet newHashSetWithExpectedSize(int expectedSize);
  31. /**
  32. * 创建一个线程安全的Set,由ConcurrentHashMap的实例支持,因此进行了相同的并发性担保,
  33. * 与HashSet不同的是,这个Set不允许null元素,该Set是可序列化的。
  34. */
  35. public static Set newConcurrentHashSet();
  36. /**
  37. * 创建一个线程安全的Set,包含给定的元素,由ConcurrentHashMap的实例支持,因此进行了相同的并发性担保,
  38. * 与 HashSet不同的是,这个Set不允许null元素,该Set是可序列化的
  39. */
  40. public static Set newConcurrentHashSet(Iterable elements);
  41. // LinkedHashSet
  42. /**
  43. * 创建一个可变的、空的LinkedHashSet实例
  44. */
  45. public static LinkedHashSet newLinkedHashSet();
  46. /**
  47. * 构造一个包含给定元素的LinkedHashSet实例
  48. */
  49. public static LinkedHashSet newLinkedHashSet(Iterable elements);
  50. /**
  51. * 构造一个期望长度为expectedSize的LinkedHashSet实例
  52. */
  53. public static LinkedHashSet newLinkedHashSetWithExpectedSize(int expectedSize);
  54. // TreeSet
  55. /**
  56. * 返回一个可变的空的TreeSet实例
  57. */
  58. public static TreeSet newTreeSet();
  59. /**
  60. * 返回一个可变的包含给定元素的TreeSet实例
  61. */
  62. public static TreeSet newTreeSet(Iterable elements);
  63. /**
  64. * 创建一个具有给定的比较器可变TreeSet的实例
  65. */
  66. public static TreeSet newTreeSet(Comparator comparator);
  67. /**
  68. * 创建一个空的Set
  69. */
  70. public static Set newIdentityHashSet() {
  71. return Collections.newSetFromMap(Maps.newIdentityHashMap());
  72. }
  73. /**
  74. * 生成一个CopyOnWriteArraySet,CopyOnWriteArraySet读写分离,线程安全
  75. */
  76. @GwtIncompatible // CopyOnWriteArraySet
  77. public static CopyOnWriteArraySet newCopyOnWriteArraySet();
  78. @GwtIncompatible // CopyOnWriteArraySet
  79. public static CopyOnWriteArraySet newCopyOnWriteArraySet(Iterable elements);
  80. /**
  81. * 创建一个枚举EnumSet
  82. */
  83. public static <e extends enum> EnumSet complementOf(Collection collection);
  84. /**
  85. * 创建一个枚举EnumSet,并且里面是值是除了type类型之外的值
  86. */
  87. public static <e extends enum> EnumSet complementOf(
  88. Collection collection, Class type);
  89. /**
  90. * 基于指定的Map对象创建一个新的Set对象
  91. */
  92. @Deprecated
  93. public static Set newSetFromMap(Map map);
  94. /**
  95. * 合集,并集
  96. */
  97. public static com.google.common.collect.Sets.SetView union(final Set set1, final Set set2);
  98. /**
  99. * 交集
  100. */
  101. public static com.google.common.collect.Sets.SetView intersection(final Set set1, final Set set2);
  102. /**
  103. * 差集
  104. */
  105. public static com.google.common.collect.Sets.SetView difference(final Set set1, final Set set2);
  106. /**
  107. * 对等差分
  108. * 给出两个集合 (如集合 A = {1, 2, 3} 和集合 B = {2, 3, 4}),
  109. * 而数学术语 "对等差分" 的集合就是指由所有只在两个集合其中之一的元素组成的集合(A △ B = C = {1, 4})
  110. */
  111. public static com.google.common.collect.Sets.SetView symmetricDifference(
  112. final Set set1, final Set set2);
  113. /**
  114. * 过滤
  115. */
  116. // TODO(kevinb): how to omit that last sentence when building GWT javadoc?
  117. public static Set filter(Set unfiltered, com.google.common.base.Predicate predicate);
  118. public static SortedSet filter(SortedSet unfiltered, com.google.common.base.Predicate predicate);
  119. @GwtIncompatible // NavigableSet
  120. @SuppressWarnings("unchecked")
  121. public static NavigableSet filter(
  122. NavigableSet unfiltered, com.google.common.base.Predicate predicate);
  123. /**
  124. * 对Set做笛卡尔操作
  125. *
  126. * 假设集合A={a,b},集合B={0,1,2},则两个集合的笛卡尔积为{(a,0),(a,1),(a,2),(b,0),(b,1),(b,2)}
  127. */
  128. public static Set<list> cartesianProduct(List> sets);
  129. @SafeVarargs
  130. public static Set<list> cartesianProduct(Set... sets) {
  131. return cartesianProduct(Arrays.asList(sets));
  132. }
  133. /**
  134. *
  135. * 返回Set的所有可能子集的集合。
  136. * 例如 powerSet(ImmutableSet.of(1, 2))} returns the set {@code {{}, {1}, {2}, {1, 2}}}.
  137. */
  138. @GwtCompatible(serializable = false)
  139. public static Set<set> powerSet(Set set) {
  140. return new com.google.common.collect.Sets.PowerSet(set);
  141. }
  142. /**
  143. * 返回大小为size的Set的所有子集的集合
  144. * 例如 combinations(ImmutableSet.of(1, 2, 3), 2)} returns the set {@code {{1, 2}, {1, 3}, {2, 3}}}.
  145. */
  146. @Beta
  147. public static Set<set> combinations(Set set, final int size);
  148. /**
  149. * 返回一个不可修改的NavigableSet
  150. */
  151. public static NavigableSet unmodifiableNavigableSet(NavigableSet set);
  152. /**
  153. * 返回一个同步的(线程安全的)NavigableSet
  154. */
  155. @GwtIncompatible // NavigableSet
  156. public static NavigableSet synchronizedNavigableSet(NavigableSet navigableSet) {
  157. return Synchronized.navigableSet(navigableSet);
  158. }
  159. /**
  160. * 获取范围内的Set
  161. */
  162. @Beta
  163. @GwtIncompatible // NavigableSet
  164. public static <k extends comparableNavigableSet subSet(
  165. NavigableSet set, Range range);
  166. }

3.5 Maps

  1. public final class Maps {
  2. /**
  3. * 创建ImmutableMap -- 不可以修改的Map
  4. */
  5. @GwtCompatible(serializable = true)
  6. public static <k extends enum, V> ImmutableMap immutableEnumMap(
  7. Map;
  8. /**
  9. * 创建Collector
  10. */
  11. public static <t, k extends enum, V> Collector<t, ?, immutablemap> toImmutableEnumMap(
  12. java.util.function.Functionsuper T, ? extends K> keyFunction,
  13. java.util.function.Functionsuper T, ? extends V> valueFunction);
  14. public static <t, k extends enum, V> Collector<t, ?, immutablemap> toImmutableEnumMap(
  15. java.util.function.Functionsuper T, ? extends K> keyFunction,
  16. java.util.function.Functionsuper T, ? extends V> valueFunction,
  17. BinaryOperator mergeFunction);
  18. /**
  19. * 创建HashMap
  20. */
  21. public static HashMap newHashMap();
  22. public static HashMap newHashMap(Map map);
  23. /**
  24. * 创建LinkedHashMap
  25. */
  26. public static LinkedHashMap newLinkedHashMap();
  27. public static LinkedHashMap newLinkedHashMap(Map map);
  28. /**
  29. * 构造一个期望长度为estimatedSize的LinkedHashMap实例
  30. */
  31. public static LinkedHashMap newLinkedHashMapWithExpectedSize(int expectedSize);
  32. /**
  33. * ConcurrentMap -- 是一个能够支持并发访问的java.util.map集合
  34. */
  35. public static ConcurrentMap newConcurrentMap();
  36. /**
  37. * TreeMap
  38. */
  39. public static TreeMap newTreeMap();
  40. public static TreeMap newTreeMap(SortedMap;
  41. public static TreeMap newTreeMap(@Nullable Comparator comparator);
  42. /**
  43. * 创建一个EnumMap
  44. */
  45. public static <k extends enum, V> EnumMap newEnumMap(Class type);
  46. public static <k extends enum, V> EnumMap newEnumMap(Map;
  47. /**
  48. * 创建一个空的Map
  49. */
  50. public static IdentityHashMap newIdentityHashMap() {
  51. return new IdentityHashMap<>();
  52. }
  53. /**
  54. * 差集
  55. */
  56. @SuppressWarnings("unchecked")
  57. public static MapDifference difference(
  58. Map left, Map right);
  59. public static MapDifference difference(
  60. Map left,
  61. Map right,
  62. Equivalencesuper V> valueEquivalence);
  63. public static SortedMapDifference difference(
  64. SortedMap right);
  65. /**
  66. * 转换为Map
  67. */
  68. public static Map asMap(Set set, Functionsuper K, V> function);
  69. /**
  70. * 转换为SortedMap
  71. */
  72. public static SortedMap asMap(SortedSet set, Functionsuper K, V> function);
  73. /**
  74. * 转换为NavigableMap
  75. */
  76. @GwtIncompatible // NavigableMap
  77. public static NavigableMap asMap(
  78. NavigableSet set, Functionsuper K, V> function);
  79. /**
  80. * value做相应的转换之后,生成ImmutableMap
  81. */
  82. public static ImmutableMap toMap(
  83. Iterable keys, Functionsuper K, V> valueFunction);
  84. public static ImmutableMap toMap(
  85. Iterator keys, Functionsuper K, V> valueFunction);
  86. /**
  87. * key做相应的转换之后,生成ImmutableMap
  88. */
  89. @CanIgnoreReturnValue
  90. public static ImmutableMap uniqueIndex(
  91. Iterable values, Functionsuper V, K> keyFunction);
  92. @CanIgnoreReturnValue
  93. public static ImmutableMap uniqueIndex(
  94. Iterator values, Functionsuper V, K> keyFunction);
  95. /**
  96. * 属性文件里面读到的内容Properties转换为ImmutableMap
  97. */
  98. @GwtIncompatible // java.util.Properties
  99. public static ImmutableMap fromProperties(Properties properties);
  100. /**
  101. * 生成不可以修改的Entry
  102. */
  103. @GwtCompatible(serializable = true)
  104. public static Entry immutableEntry(@Nullable K key, @Nullable V value);
  105. /**
  106. * BiMapConverter
  107. */
  108. public static Converter asConverter(final BiMap bimap);
  109. /**
  110. * 线程安全的BiMap
  111. */
  112. public static BiMap synchronizedBiMap(BiMap bimap);
  113. /**
  114. * 不可以修改的BiMap
  115. */
  116. public static BiMap unmodifiableBiMap(BiMap bimap);
  117. /**
  118. * 转换值
  119. */
  120. public static Map transformValues(
  121. Map fromMap, Functionsuper V1, V2> function);
  122. public static SortedMap transformValues(
  123. SortedMap fromMap, Functionsuper V1, V2> function);
  124. @GwtIncompatible // NavigableMap
  125. public static NavigableMap transformValues(
  126. NavigableMap fromMap, Functionsuper V1, V2> function);
  127. /**
  128. * 转换
  129. */
  130. public static Map transformEntries(
  131. Map fromMap, EntryTransformersuper K, ? super V1, V2> transformer);
  132. public static SortedMap transformEntries(
  133. SortedMap fromMap, EntryTransformersuper K, ? super V1, V2> transformer);
  134. @GwtIncompatible // NavigableMap
  135. public static NavigableMap transformEntries(
  136. final NavigableMap fromMap, EntryTransformersuper K, ? super V1, V2> transformer);
  137. @GwtIncompatible // NavigableMap
  138. private static class TransformedEntriesNavigableMap<K, V1, V2>
  139. extends TransformedEntriesSortedMap<K, V1, V2> implements NavigableMap<K, V2> {
  140. TransformedEntriesNavigableMap(
  141. NavigableMap fromMap, EntryTransformersuper K, ? super V1, V2> transformer) {
  142. super(fromMap, transformer);
  143. }
  144. @Override
  145. public Entry ceilingEntry(K key) {
  146. return transformEntry(fromMap().ceilingEntry(key));
  147. }
  148. @Override
  149. public K ceilingKey(K key) {
  150. return fromMap().ceilingKey(key);
  151. }
  152. @Override
  153. public NavigableSet descendingKeySet() {
  154. return fromMap().descendingKeySet();
  155. }
  156. @Override
  157. public NavigableMap descendingMap() {
  158. return transformEntries(fromMap().descendingMap(), transformer);
  159. }
  160. @Override
  161. public Entry firstEntry() {
  162. return transformEntry(fromMap().firstEntry());
  163. }
  164. @Override
  165. public Entry floorEntry(K key) {
  166. return transformEntry(fromMap().floorEntry(key));
  167. }
  168. @Override
  169. public K floorKey(K key) {
  170. return fromMap().floorKey(key);
  171. }
  172. @Override
  173. public NavigableMap headMap(K toKey) {
  174. return headMap(toKey, false);
  175. }
  176. @Override
  177. public NavigableMap headMap(K toKey, boolean inclusive) {
  178. return transformEntries(fromMap().headMap(toKey, inclusive), transformer);
  179. }
  180. @Override
  181. public Entry higherEntry(K key) {
  182. return transformEntry(fromMap().higherEntry(key));
  183. }
  184. @Override
  185. public K higherKey(K key) {
  186. return fromMap().higherKey(key);
  187. }
  188. @Override
  189. public Entry lastEntry() {
  190. return transformEntry(fromMap().lastEntry());
  191. }
  192. @Override
  193. public Entry lowerEntry(K key) {
  194. return transformEntry(fromMap().lowerEntry(key));
  195. }
  196. @Override
  197. public K lowerKey(K key) {
  198. return fromMap().lowerKey(key);
  199. }
  200. @Override
  201. public NavigableSet navigableKeySet() {
  202. return fromMap().navigableKeySet();
  203. }
  204. @Override
  205. public Entry pollFirstEntry() {
  206. return transformEntry(fromMap().pollFirstEntry());
  207. }
  208. @Override
  209. public Entry pollLastEntry() {
  210. return transformEntry(fromMap().pollLastEntry());
  211. }
  212. @Override
  213. public NavigableMap subMap(
  214. K fromKey, boolean fromInclusive, K toKey, boolean toInclusive) {
  215. return transformEntries(
  216. fromMap().subMap(fromKey, fromInclusive, toKey, toInclusive), transformer);
  217. }
  218. @Override
  219. public NavigableMap subMap(K fromKey, K toKey) {
  220. return subMap(fromKey, true, toKey, false);
  221. }
  222. @Override
  223. public NavigableMap tailMap(K fromKey) {
  224. return tailMap(fromKey, true);
  225. }
  226. @Override
  227. public NavigableMap tailMap(K fromKey, boolean inclusive) {
  228. return transformEntries(fromMap().tailMap(fromKey, inclusive), transformer);
  229. }
  230. private @Nullable Entry transformEntry(@Nullable Entry entry) {
  231. return (entry == null) ? null : Maps.transformEntry(transformer, entry);
  232. }
  233. @Override
  234. protected NavigableMap fromMap() {
  235. return (NavigableMap) super.fromMap();
  236. }
  237. }
  238. static Predicate<entrysuper K> keyPredicate) {
  239. return compose(keyPredicate, Maps.keyFunction());
  240. }
  241. static Predicate<entrysuper V> valuePredicate) {
  242. return compose(valuePredicate, Maps.valueFunction());
  243. }
  244. /**
  245. * 根据key过滤
  246. */
  247. public static Map filterKeys(
  248. Map unfiltered, final Predicatesuper K> keyPredicate);
  249. public static SortedMap filterKeys(
  250. SortedMap unfiltered, final Predicatesuper K> keyPredicate);
  251. @GwtIncompatible // NavigableMap
  252. public static NavigableMap filterKeys(
  253. NavigableMap unfiltered, final Predicatesuper K> keyPredicate);
  254. public static BiMap filterKeys(
  255. BiMap unfiltered, final Predicatesuper K> keyPredicate);
  256. /**
  257. * 根据值过滤
  258. */
  259. public static Map filterValues(
  260. Map unfiltered, final Predicatesuper V> valuePredicate);
  261. public static SortedMap filterValues(
  262. SortedMap unfiltered, final Predicatesuper V> valuePredicate);
  263. @GwtIncompatible // NavigableMap
  264. public static NavigableMap filterValues(
  265. NavigableMap unfiltered, final Predicatesuper V> valuePredicate);
  266. public static BiMap filterValues(
  267. BiMap unfiltered, final Predicatesuper V> valuePredicate);
  268. /**
  269. * 过滤
  270. */
  271. public static Map filterEntries(
  272. Map unfiltered, Predicatesuper Entry> entryPredicate);
  273. public static SortedMap filterEntries(
  274. SortedMap unfiltered, Predicatesuper Entry> entryPredicate);
  275. @GwtIncompatible // NavigableMap
  276. public static NavigableMap filterEntries(
  277. NavigableMap unfiltered, Predicatesuper Entry> entryPredicate);
  278. public static BiMap filterEntries(
  279. BiMap unfiltered, Predicatesuper Entry> entryPredicate);
  280. /**
  281. * 返回一个不可修改的NavigableMap
  282. */
  283. @GwtIncompatible // NavigableMap
  284. public static NavigableMap unmodifiableNavigableMap(
  285. NavigableMap;
  286. /**
  287. * 返回一个同步的(线程安全的)NavigableMap
  288. */
  289. @GwtIncompatible // NavigableMap
  290. public static NavigableMap synchronizedNavigableMap(
  291. NavigableMap navigableMap);
  292. /**
  293. * key范围内的Map
  294. */
  295. @Beta
  296. @GwtIncompatible // NavigableMap
  297. public static <k extends comparable<? super K>, V> NavigableMap subMap(
  298. NavigableMap map, Range range);
  299. }

3.6 Queues

  1. public final class Queues {
  2. /**
  3. * 创建ArrayBlockingQueue
  4. */
  5. @GwtIncompatible // ArrayBlockingQueue
  6. public static ArrayBlockingQueue newArrayBlockingQueue(int capacity);
  7. // ArrayDeque
  8. /**
  9. * 创建ArrayDeque
  10. */
  11. public static ArrayDeque newArrayDeque();
  12. /**
  13. * 创建ArrayDeque
  14. */
  15. public static ArrayDeque newArrayDeque(Iterable elements);
  16. // ConcurrentLinkedQueue
  17. /** 创建ConcurrentLinkedQueue */
  18. @GwtIncompatible // ConcurrentLinkedQueue
  19. public static ConcurrentLinkedQueue newConcurrentLinkedQueue();
  20. /**
  21. * 创建ConcurrentLinkedQueue
  22. */
  23. @GwtIncompatible // ConcurrentLinkedQueue
  24. public static ConcurrentLinkedQueue newConcurrentLinkedQueue(
  25. Iterable elements);
  26. // LinkedBlockingDeque
  27. /**
  28. * LinkedBlockingDeque
  29. */
  30. @GwtIncompatible // LinkedBlockingDeque
  31. public static LinkedBlockingDeque newLinkedBlockingDeque();
  32. /**
  33. * LinkedBlockingDeque
  34. */
  35. @GwtIncompatible // LinkedBlockingDeque
  36. public static LinkedBlockingDeque newLinkedBlockingDeque(int capacity);
  37. /**
  38. * LinkedBlockingDeque
  39. */
  40. @GwtIncompatible // LinkedBlockingDeque
  41. public static LinkedBlockingDeque newLinkedBlockingDeque(Iterable elements);
  42. // LinkedBlockingQueue
  43. /** LinkedBlockingQueue */
  44. @GwtIncompatible // LinkedBlockingQueue
  45. public static LinkedBlockingQueue newLinkedBlockingQueue();
  46. /**
  47. * LinkedBlockingQueue
  48. */
  49. @GwtIncompatible // LinkedBlockingQueue
  50. public static LinkedBlockingQueue newLinkedBlockingQueue(int capacity);
  51. /**
  52. * LinkedBlockingQueue
  53. */
  54. @GwtIncompatible // LinkedBlockingQueue
  55. public static LinkedBlockingQueue newLinkedBlockingQueue(Iterable elements);
  56. /**
  57. * PriorityBlockingQueue
  58. */
  59. @GwtIncompatible // PriorityBlockingQueue
  60. public static PriorityBlockingQueue newPriorityBlockingQueue();
  61. /**
  62. * PriorityBlockingQueue
  63. */
  64. @GwtIncompatible // PriorityBlockingQueue
  65. public static PriorityBlockingQueue newPriorityBlockingQueue(
  66. Iterable elements);
  67. // PriorityQueue
  68. /**
  69. * PriorityQueue
  70. */
  71. public static PriorityQueue newPriorityQueue();
  72. /**
  73. * PriorityQueue
  74. */
  75. public static PriorityQueue newPriorityQueue(
  76. Iterable elements);
  77. // SynchronousQueue
  78. /** SynchronousQueue 同步Queue,线程安全 */
  79. @GwtIncompatible // SynchronousQueue
  80. public static SynchronousQueue newSynchronousQueue();
  81. /**
  82. * 一次性的从BlockingQueue获取多少个数据
  83. */
  84. @Beta
  85. @CanIgnoreReturnValue
  86. @GwtIncompatible // BlockingQueue
  87. @SuppressWarnings("GoodTime") // should accept a java.time.Duration
  88. public static int drain(
  89. BlockingQueue q,
  90. Collectionsuper E> buffer,
  91. int numElements,
  92. long timeout,
  93. TimeUnit unit)
  94. throws InterruptedException;
  95. /**
  96. * 从BlockingQueue里面获取数据,和drain的区别就是当有异常的时候也会停止获取
  97. */
  98. @Beta
  99. @CanIgnoreReturnValue
  100. @GwtIncompatible // BlockingQueue
  101. @SuppressWarnings("GoodTime") // should accept a java.time.Duration
  102. public static int drainUninterruptibly(
  103. BlockingQueue q,
  104. Collectionsuper E> buffer,
  105. int numElements,
  106. long timeout,
  107. TimeUnit unit);
  108. /**
  109. * 获取同步Queue, 同步Queue是线程安全的
  110. */
  111. public static Queue synchronizedQueue(Queue queue);
  112. /**
  113. * 获取同步的Deque,Deque是双端队列
  114. */
  115. public static Deque synchronizedDeque(Deque deque);
  116. }

3.7 Multisets

  1. public final class Multisets {
  2. /**
  3. * 用于生成一个Collector,T代表流中的一个一个元素,R代表最终的结果。参考Collector.of()的实现
  4. */
  5. public static <t, e, m extends multiset> Collector
  6. java.util.function.Functionsuper T, E> elementFunction,
  7. java.util.function.ToIntFunctionsuper T> countFunction,
  8. java.util.function.Supplier multisetSupplier);
  9. /**
  10. * 转换为不可以修改的Multiset
  11. */
  12. public static Multiset unmodifiableMultiset(Multiset multiset);
  13. /**
  14. * 转换为不可以修改的Multiset
  15. */
  16. @Deprecated
  17. public static Multiset unmodifiableMultiset(ImmutableMultiset multiset);
  18. /**
  19. * 转换为不可以修改的SortedMultiset
  20. */
  21. @Beta
  22. public static SortedMultiset unmodifiableSortedMultiset(SortedMultiset sortedMultiset);
  23. /**
  24. * Returns an immutable multiset entry with the specified element and count. The entry will be
  25. * serializable if {@code e} is.
  26. *
  27. * @param e the element to be associated with the returned entry
  28. * @param n the count to be associated with the returned entry
  29. * @throws IllegalArgumentException if {@code n} is negative
  30. */
  31. public static Multiset.Entry immutableEntry(@Nullable E e, int n) {
  32. return new com.google.common.collect.Multisets.ImmutableEntry(e, n);
  33. }
  34. /**
  35. * 过滤
  36. */
  37. @Beta
  38. public static Multiset filter(Multiset unfiltered, Predicatesuper E> predicate);
  39. /**
  40. * 交集
  41. */
  42. public static Multiset intersection(
  43. final Multiset multiset1, final Multiset multiset2);
  44. /**
  45. * 合集
  46. */
  47. @Beta
  48. public static Multiset sum(
  49. final Multiset multiset1, final Multiset multiset2);
  50. /**
  51. * 差集
  52. */
  53. @Beta
  54. public static Multiset difference(
  55. final Multiset multiset1, final Multiset multiset2);
  56. /**
  57. * 对任意o,如果subMultiset.count(o)<=superMultiset.count(o),返回true
  58. * 和containsAll()是有区别的,containsAll是指包含所有不重复的元素。举两个例子
  59. *
  60. * Multiset multiset1 = HashMultiset.create();
  61. * multiset1.add("a", 2);
  62. * multiset1.add("b");
  63. *
  64. * Multiset multiset2 = HashMultiset.create();
  65. * multiset2.add("a", 5);
  66. *
  67. * multiset1.containsAll(multiset2); // 返回true;因为包含了所有不重复元素,
  68. *
  69. * Multisets.containsOccurrences(multiset1, multiset2); // returns false
  70. */
  71. @CanIgnoreReturnValue
  72. public static boolean containsOccurrences(Multiset superMultiset, Multiset subMultiset);
  73. /**
  74. * 修改multisetToModify,以保证任意o都符合multisetToModify.count(o)<=multisetToRetain.count(o)
  75. */
  76. @CanIgnoreReturnValue
  77. public static boolean retainOccurrences(
  78. Multiset multisetToModify, Multiset multisetToRetain);
  79. /**
  80. * 对occurrencesToRemove中的重复元素,仅在multisetToModify中删除相同个数。
  81. * Multiset multiset1 = HashMultiset.create();
  82. * multiset1.add("a", 2);
  83. *
  84. * Multiset multiset2 = HashMultiset.create();
  85. * multiset2.add("a", 5);
  86. *
  87. * multiset2.removeOccurrences(multiset1); // multiset2 现在包含3个"a"
  88. */
  89. @CanIgnoreReturnValue
  90. public static boolean removeOccurrences(
  91. Multiset multisetToModify, Iterable occurrencesToRemove);
  92. @CanIgnoreReturnValue
  93. public static boolean removeOccurrences(
  94. Multiset multisetToModify, Multiset occurrencesToRemove);
  95. /**
  96. * 返回Multiset的不可变拷贝,并将元素按重复出现的次数做降序排列
  97. */
  98. @Beta
  99. public static ImmutableMultiset copyHighestCountFirst(Multiset multiset);
  100. }

3.8 Multimaps

  1. public final class Multimaps {
  2. /**
  3. * 用于生成一个Collector,T代表流中的一个一个元素,R代表最终的结果。参考Collector.of()的实现
  4. */
  5. @Beta
  6. public static <t, k, v, m extends multimap> Collector
  7. java.util.function.Functionsuper T, ? extends K> keyFunction,
  8. java.util.function.Functionsuper T, ? extends V> valueFunction,
  9. java.util.function.Supplier multimapSupplier);
  10. /**
  11. * 用于生成一个Collector,T代表流中的一个一个元素,R代表最终的结果。参考Collector.of()的实现
  12. */
  13. @Beta
  14. public static <t, k, v, m extends multimap> Collector
  15. java.util.function.Functionsuper T, ? extends K> keyFunction,
  16. java.util.function.Functionsuper T, ? extends Stream> valueFunction,
  17. java.util.function.Supplier multimapSupplier);
  18. /**
  19. * 生成Multimap
  20. */
  21. public static Multimap newMultimap(
  22. Map<k, collection> map, final Supplier> factory)</k, collection;
  23. /**
  24. * 生成ListMultimap
  25. */
  26. public static ListMultimap newListMultimap(
  27. Map<k, collection> map, final Supplier> factory)</k, collection;
  28. /**
  29. * 生成SetMultimap
  30. */
  31. public static SetMultimap newSetMultimap(
  32. Map<k, collection> map, final Supplier> factory)</k, collection;
  33. /**
  34. * 生成SortedSetMultimap
  35. */
  36. public static SortedSetMultimap newSortedSetMultimap(
  37. Map<k, collection> map, final Supplier> factory)</k, collection;
  38. /**
  39. * 反转Multimap
  40. */
  41. @CanIgnoreReturnValue
  42. public static <k, v, m extends multimap> M invertFrom(
  43. Multimap source, M dest);
  44. /**
  45. * 生成同步Multimap -- 线程安全
  46. */
  47. public static Multimap synchronizedMultimap(Multimap multimap);
  48. /**
  49. * 生成不可以修改的Multimap
  50. */
  51. public static Multimap unmodifiableMultimap(Multimap delegate);
  52. @Deprecated
  53. public static Multimap unmodifiableMultimap(ImmutableMultimap delegate);
  54. /**
  55. * 生成同步SetMultimap -- 线程安全
  56. */
  57. public static SetMultimap synchronizedSetMultimap(SetMultimap multimap);
  58. /**
  59. * 生成不可以修改的SetMultimap
  60. */
  61. public static SetMultimap unmodifiableSetMultimap(SetMultimap delegate);
  62. @Deprecated
  63. public static SetMultimap unmodifiableSetMultimap(
  64. ImmutableSetMultimap delegate);
  65. /**
  66. * 生成同步SortedSetMultimap -- 线程安全
  67. */
  68. public static SortedSetMultimap synchronizedSortedSetMultimap(
  69. SortedSetMultimap multimap);
  70. /**
  71. * 生成不可以修改的SortedSetMultimap
  72. */
  73. public static SortedSetMultimap unmodifiableSortedSetMultimap(
  74. SortedSetMultimap delegate);
  75. /**
  76. * 生成同步的ListMultimap -- 线程安全
  77. */
  78. public static ListMultimap synchronizedListMultimap(ListMultimap multimap);
  79. /**
  80. * 生成不可以修改的ListMultimap
  81. */
  82. public static ListMultimap unmodifiableListMultimap(ListMultimap delegate);
  83. @Deprecated
  84. public static ListMultimap unmodifiableListMultimap(
  85. ImmutableListMultimap delegate);
  86. /**
  87. * 生成不可修改的Collection
  88. */
  89. private static Collection unmodifiableValueCollection(Collection collection);
  90. /**
  91. * 生成不可修改的Collection
  92. */
  93. private static Collection<entry> unmodifiableEntries(
  94. Collection<entry> entries);
  95. /**
  96. * ListMultimap转换为Map
  97. */
  98. @Beta
  99. @SuppressWarnings("unchecked")
  100. // safe by specification of ListMultimap.asMap()
  101. public static Map<k, list> asMap(ListMultimap multimap);
  102. /**
  103. * SetMultimap转换为Map
  104. */
  105. @Beta
  106. @SuppressWarnings("unchecked")
  107. // safe by specification of SetMultimap.asMap()
  108. public static Map<k, set> asMap(SetMultimap multimap);
  109. /**
  110. * SortedSetMultimap转换为Map
  111. */
  112. @Beta
  113. @SuppressWarnings("unchecked")
  114. // safe by specification of SortedSetMultimap.asMap()
  115. public static Map<k, sortedset> asMap(SortedSetMultimap multimap);
  116. /**
  117. * Multimap转换为Map
  118. */
  119. @Beta
  120. public static Map<k, collection> asMap(Multimap multimap);
  121. /**
  122. * Map转换为SetMultimap
  123. */
  124. public static SetMultimap forMap(Map map);
  125. /**
  126. * 对Value值做转换
  127. */
  128. public static Multimap transformValues(
  129. Multimap fromMultimap, final Functionsuper V1, V2> function);
  130. public static ListMultimap transformValues(
  131. ListMultimap fromMultimap, final Functionsuper V1, V2> function);
  132. /**
  133. * 对Entry值做转换
  134. */
  135. public static Multimap transformEntries(
  136. Multimap fromMap, EntryTransformersuper K, ? super V1, V2> transformer);
  137. public static ListMultimap transformEntries(
  138. ListMultimap fromMap, EntryTransformersuper K, ? super V1, V2> transformer);
  139. /**
  140. *
  141. * 按照共同的特定属性,组装成ImmutableListMultimap
  142. *
  143. * ImmutableSet digits = ImmutableSet.of("zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine");
  144. * Function lengthFunction = new Function() {
  145. * public Integer apply(String string) {
  146. * return string.length();
  147. * }
  148. * };
  149. *
  150. * ImmutableListMultimap digitsByLength= Multimaps.index(digits, lengthFunction);
  151. * /*
  152. * * digitsByLength maps:
  153. * * 3 => {"one", "two", "six"}
  154. * * 4 => {"zero", "four", "five", "nine"}
  155. * * 5 => {"three", "seven", "eight"}
  156. *
  157. */
  158. public static ImmutableListMultimap index(
  159. Iterable values, Functionsuper V, K> keyFunction);
  160. public static ImmutableListMultimap index(
  161. Iterator values, Functionsuper V, K> keyFunction);
  162. /**
  163. * 根据key过滤
  164. */
  165. public static SetMultimap filterKeys(
  166. SetMultimap unfiltered, final Predicatesuper K> keyPredicate);
  167. public static ListMultimap filterKeys(
  168. ListMultimap unfiltered, final Predicatesuper K> keyPredicate);
  169. /**
  170. * 根据值过滤
  171. */
  172. public static Multimap filterValues(
  173. Multimap unfiltered, final Predicatesuper V> valuePredicate);
  174. public static SetMultimap filterValues(
  175. SetMultimap unfiltered, final Predicatesuper V> valuePredicate);
  176. /**
  177. * 根据Entry过滤
  178. */
  179. public static Multimap filterEntries(
  180. Multimap unfiltered, Predicatesuper Entry> entryPredicate);
  181. public static SetMultimap filterEntries(
  182. SetMultimap unfiltered, Predicatesuper Entry> entryPredicate);
  183. }

3.9 Tables

  1. public final class Tables {
  2. /**
  3. * 用于生成一个Collector,T代表流中的一个一个元素,R代表最终的结果。参考Collector.of()的实现
  4. */
  5. @Beta
  6. public static <t, r, c, v, i extends Table> Collector
  7. java.util.function.Functionsuper T, ? extends R> rowFunction,
  8. java.util.function.Functionsuper T, ? extends C> columnFunction,
  9. java.util.function.Functionsuper T, ? extends V> valueFunction,
  10. java.util.function.Supplier tableSupplier);
  11. public static <t, r, c, v, i extends Table> Collector
  12. java.util.function.Functionsuper T, ? extends R> rowFunction,
  13. java.util.function.Functionsuper T, ? extends C> columnFunction,
  14. java.util.function.Functionsuper T, ? extends V> valueFunction,
  15. BinaryOperator mergeFunction,
  16. java.util.function.Supplier tableSupplier);
  17. /**
  18. * 生成一个单元格对象
  19. */
  20. public static Cell immutableCell(
  21. @Nullable R rowKey, @Nullable C columnKey, @Nullable V value);
  22. /**
  23. * 允许你把Table<C, R, V>转置成Table<R, C, V
  24. */
  25. public static Table transpose(Table table);
  26. /**
  27. * 允许你指定Table用什么样的map实现行和列
  28. */
  29. @Beta
  30. public static Table newCustomTable(
  31. Map<r, Map> backingMap, Supplierextends Map> factory);
  32. /**
  33. * 对value做转换
  34. */
  35. @Beta
  36. public static Table transformValues(
  37. Table fromTable, Functionsuper V1, V2> function);
  38. /**
  39. * 返回不可修改的Table
  40. */
  41. public static Table unmodifiableTable(
  42. Tableextends R, ? extends C, ? extends V> table);
  43. /**
  44. * 生成不可修改的RowSortedTable
  45. */
  46. @Beta
  47. public static RowSortedTable unmodifiableRowSortedTable(
  48. RowSortedTable<r, ? extends C, ? extends V> table);
  49. /**
  50. * 生成同步Table -- 线程安全
  51. */
  52. public static Table synchronizedTable(Table table);
  53. }

四、扩展工具类

有时候需要实现自己的集合扩展。也许要在元素被添加到列表时增加特定的行为,或者想实现一个Iterable,其底层实际上是遍历数据库查询的结果集。Guava也提供了若干工具方法,以便让类似的工作变得更简单。

4.1 Forwarding装饰器

针对所有类型的集合接口,Guava都提供了Forwarding抽象类以简化装饰者模式的使用。Forwarding抽象类定义了一个抽象方法:delegate(),可以覆盖这个方法来返回被装饰对象。所有其他方法都会直接委托给delegate()。例如说:ForwardingList.get(int)实际上执行了delegate().get(int)
通过创建ForwardingXXX的子类并实现delegate()方法,可以选择性地覆盖子类的方法来增加装饰功能,而不需要自己委托每个方法。
讲的更加直接一点就是,通过delegate()返回一个委托对象,这样可以对委托对象的一些方法的前后做一些自己的操作。
Forwarding装饰器对应的类有很多,随便列出几个比如:ForwardingList(托管List的一些方法)、ForwardingMap(托管Map的一些方法)、ForwardingDeque(托管Deque的一些方法)等等。
ForwardingList来举一个例子,让大家明白Forwarding装饰器的使用。自定义ListWithDefault继承ForwardingList实现一个从List里面获取数据的时候如果为空则用一个默认值代替。当然实际使用过程中,大家需要根据不同的场讲做不同的变换。

  1. import java.util.*;
  2. import com.google.common.collect.*;
  3. public class ListWithDefault<E> extends ForwardingList<E> {
  4. final E defaultValue;
  5. final List delegate;
  6. ListWithDefault(List delegate, E defaultValue) {
  7. this.delegate = delegate;
  8. this.defaultValue = defaultValue;
  9. }
  10. @Override protected List delegate() {
  11. return delegate;
  12. }
  13. @Override public E get(int index) {
  14. E v = super.get(index);
  15. return (v == null ? defaultValue : v);
  16. }
  17. @Override public Iterator iterator() {
  18. final Iterator iter = super.iterator();
  19. return new ForwardingIterator() {
  20. @Override protected Iterator delegate() {
  21. return iter;
  22. }
  23. @Override public E next() {
  24. E v = super.next();
  25. return (v == null ? defaultValue : v);
  26. }
  27. };
  28. }
  29. }

4.2 PeekingIterator

Iterators提供一个Iterators.peekingIterator(Iterator)方法,来把Iterator包装为PeekingIterator,这是Iterator的子类,它能让你事先窥视[peek()]到下一次调用next()返回的元素。
PeekingIterator相对Iterator多了一个函数peek()函数。peek()让我们可以提前看到下一个元素。
关于PeekingIterator的使用举个例子,复制一个List,并去除连续的重复元素。

  1. List result = Lists.newArrayList();
  2. PeekingIterator iter = Iterators.peekingIterator(source.iterator());
  3. while (iter.hasNext()) {
  4. E current = iter.next();
  5. while (iter.hasNext() && iter.peek().equals(current)) {
  6. //跳过重复的元素
  7. iter.next();
  8. }
  9. result.add(current);
  10. }

4.3 AbstractIterator

实现自己的IteratorAbstractIterator提供了一个abstract computeNext()函数,可以介入next()函数的获取。当然到没有元素的时候记得调用endOfData();
关于AbstractIterator的使用,也从网上找到一个例子,如下,要包装一个iterator以跳过空值。

  1. public static Iterator<String> skipNulls(final Iterator<String> in) {
  2. return new AbstractIterator<String>() {
  3. protected String computeNext() {
  4. while (in.hasNext()) {
  5. String s = in.next();
  6. if (s != null) {
  7. return s;
  8. }
  9. }
  10. return endOfData();
  11. }
  12. };
  13. }

4.5 AbstractSequentialIterator

AbstractSequentialIterator可以看做是迭代器的另一种实现方式。AbstractSequentialIterator的源码也很简单,可以一起来看下,源码如下

  1. public abstract class AbstractSequentialIterator<T> extends UnmodifiableIterator<T> {
  2. private @Nullable T nextOrNull;
  3. /**
  4. * 我们需要提供第一个元素
  5. */
  6. protected AbstractSequentialIterator(@Nullable T firstOrNull) {
  7. this.nextOrNull = firstOrNull;
  8. }
  9. /**
  10. * 我们需要实现的方法
  11. */
  12. @Nullable
  13. protected abstract T computeNext(T previous);
  14. /**
  15. * 是否有下一个元素
  16. */
  17. @Override
  18. public final boolean hasNext() {
  19. return nextOrNull != null;
  20. }
  21. /**
  22. * 在调用next()方法获取next元素之后,又通过computeNext()方法把接下来的一个元素给算出来了
  23. */
  24. @Override
  25. public final T next() {
  26. if (!hasNext()) {
  27. throw new NoSuchElementException();
  28. }
  29. try {
  30. return nextOrNull;
  31. } finally {
  32. nextOrNull = computeNext(nextOrNull);
  33. }
  34. }
  35. }

通过源码的阅读,AbstractSequentialIterator就是通过指定第一个元素之后,在根据computeNext()函数依据某种规则产生下一个元素。
用一个例子来说明AbstractSequentialIterator的使用,每一个数都是前一个数的两倍。

  1. Iterator powersOfTwo = new AbstractSequentialIterator(1) { // 注意初始值1!
  2. protected Integer computeNext(Integer previous) {
  3. // 下一个数是前数的两倍,一直到2的3次方
  4. return (previous == 1 << 3) ? null : previous * 2;
  5. }
  6. };