广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Java源码分析:Guava之不可变集合ImmutableMap的源码分析
  • 285
分享到

Java源码分析:Guava之不可变集合ImmutableMap的源码分析

2024-04-02 19:04:59 285人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

目录一、案例场景二、ImmutableMap源码分析总结一、案例场景 遇到过这样的场景,在定义一个static修饰的Map时,使用了大量的put()方法赋值,就类似这样—— pu

一、案例场景

遇到过这样的场景,在定义一个static修饰的Map时,使用了大量的put()方法赋值,就类似这样——


public static final  Map<String,String> dayMap= new HashMap<>();
static {
    dayMap.put("Monday","今天上英语课");
    dayMap.put("Tuesday","今天上语文课");
    dayMap.put("Wednesday","今天上数学课");
    dayMap.put("Thursday","今天上音乐课");
    dayMap.put("Sunday","今天上编程课");
    ......
}

当时,我就在想,是否可以进一步优化下,使得代码看起来更为优雅些,然后,就发现了Google Guava里的有一个类ImmutableMap,通过这个类可以实现类似建造者模式的链式编程,优化后的效果,如下:


public static final  Map<String,String> dayMap = ImmutableMap.<String, String>builder()
    .put("Monday","今天上英语课")
    .put("Tuesday","今天上语文课")
    .put("Wednesday","今天上数学课")
    .put("Thursday","今天上音乐课")
    .put("Sunday","今天上编程课")
    .build();

二、ImmutableMap源码分析

那么,这个ImmutableMap究竟是如何实现这样的功能呢?

在Google Guava官方教程中,Immutable前缀的集合被定义为不可变集合,包括ImmutableSet、 ImmutableMap等,何为不可变集合?就是指,在集合创建后,集合里所有的状态在生命周期内都不可再修改了,只能读。

那么,什么是可再修改的呢,像jdk中的map、list等,创建后,还可以再通过put()或者add()反复新增或者修改,这种就是可再修改的集合。既然是不可再修改集合,是不是就一定不能再修改了呢?也不是,其实,通过反射还是可以被修改的,但这已经不是不可变集合之所以存在的初衷了。

总结一句话是,不可变集合是线程安全的且可当成常量使用的。

接下来,就进入到ImmutableMap内部,可以看到,其实现了Map接口,跟HashMap有点类似地方在于,Map接口都算是他们的基类,都可以实现父类引用指向子类对象,即向上转型。


public abstract class ImmutableMap<K, V> implements Map<K, V>, Serializable {}

这是一个抽象类,若要实现这样调用 ImmutableMap.<String, String>builder(),表面上就可以猜测到<String, String>builder()一定是被static定义的静态方法,进到源码里,发现确实如此——



public static <K, V> Builder<K, V> builder() {
  return new Builder<K, V>();
}

这个方法的定义对于一些初级程序员而言,可能会觉得很奇怪,其实这个方法格式的本质是这样的 ——


public <T> T method(T t)

这是一种泛型的约定规范,第一个定义一种泛型,表示当前方法有一个范型变量类型,用T表示;第二个T是表示method的返回类型为T。

回过头来看这个builder()方法,就很好理解了,<K, V>是定义一种泛型,表示当前方法的泛型变量,Builder<K, V>表示返回一个泛型变量为<K, V>的对象。

前面定义 ImmutableMap.<String, String>builder(),在这个builder()方法里,就会返回一个new Builder<String, String>()的对象,这个对象通过构造器,初始化了一个大小为ImmutableCollection.Builder.DEFAULT_INITIAL_CAPACITY的数组entries,而这个DEFAULT_INITIAL_CAPACITY的默认值是4。


public static class Builder<K, V> {
    Comparator<? super V> valueComparator;
    ImmutableMapEntry<K, V>[] entries;
    int size;
    boolean entriesUsed;
   public Builder() {
      this(ImmutableCollection.Builder.DEFAULT_INITIAL_CAPACITY);
    }
    Builder(int initialCapacity) {
      this.entries = new ImmutableMapEntry[initialCapacity];
      this.size = 0;
      this.entriesUsed = false;
    }
    ......
}

那么问题来了,这个 ImmutableMapEntry<K, V>[] 是什么类型的数组呢?

这个ImmutableMapEntry<K, V>类 ,是继承一个ImmutableEntry<K, V>类 ——


class ImmutableMapEntry<K, V> extends ImmutableEntry<K, V> {
  static <K, V> ImmutableMapEntry<K, V>[] createEntryArray(int size) {
    return new ImmutableMapEntry[size];
  }
  ImmutableMapEntry(K key, V value) {
    super(key, value);
    checkEntryNotNull(key, value);
  }
}

注意一点, checkEntryNotNull(key, value)做了一个校验,这就意味着,存入的key和value值都不能为空。


static void checkEntryNotNull(Object key, Object value) {
  if (key == null) {
    throw new NullPointerException("null key in entry: null=" + value);
  } else if (value == null) {
    throw new NullPointerException("null value in entry: " + key + "=null");
  }
}

在父类ImmutableEntry<K, V>类里,定义了key和value两个泛型变量,可见,当外部调用builder().put(key,value)来存储key-value数据时,其实是将key-value数据存储到ImmutableEntry对象的key与value里。


class ImmutableEntry<K, V> extends AbstractMapEntry<K, V> implements Serializable {
  final K key;
  final V value;
  ......
}

提到ImmutableEntry<K, V>数组来存储key-value数据,就不得不提一下HashMap。

在JDK1.8当中,HashMap是由数组+链表+红黑树组成,它内部的数组是由node<K,V>[]定义,而这个 Node<K,V> 实现的是Map.Entry<K,V>——

ImmutableMapEntry<K, V>顶部同样是实现了Entry<K,V>——

可见,ImmutableMap与HashMap一样,其存储key-value的对象所属的类,都直接或者间接地实现了Entry<K,V>接口。

分析到这里,再看回Builder<K, V>类源码,就很容易明白 ,这个ImmutableMapEntry<K, V>[] entries与HashMap的数组类似,都是用来存储key-value的数据。

接下来,就是分析put的逻辑原理了。

前面分析到的Builder类,其实是属于抽象类 ImmutableMap<K, V>中的内部静态类,这就意味着,执行ImmutableMap.<String, String>builder().put("Monday","今天上英语课")的本质,其实是相当于执行了ImmutableMap.new Builder<K, V>().put("Monday","今天上英语课")。

put方法的源码如下:


public Builder<K, V> put(K key, V value) {
  ensureCapacity(size + 1); 
  ImmutableMapEntry<K, V> entry = entryOf(key, value);
  // don't inline this: we want to fail atomically if key or value is null
  entries[size++] = entry;
  return this;
}

一、先看第一行代码调用的方法,其作用是判断当新增一个key-value对象存到数组时,是否会有溢出的可能,若出现溢出的情况,就先对数组进行扩容。


private void ensureCapacity(int minCapacity) {
  if (minCapacity > entries.length) {
    entries =
        Arrays.copyOf(
            entries, ImmutableCollection.Builder.expandedCapacity(entries.length, minCapacity));
    entriesUsed = false;
  }
}

二、第二行ImmutableMapEntry<K, V> entry = entryOf(key, value)就是创建一个新的ImmutableMapEntry对象,通过构造器初始化赋值给对象的key与value——


static <K, V> ImmutableMapEntry<K, V> entryOf(K key, V value) {
    return new ImmutableMapEntry<K, V>(key, value);
  }

三、第三行代码 entries[size++] = entry是将新增的ImmutableMapEntry对象存储到数组空闲的位置上,这样通过put(key,value)缓存进来的key-value值,就通过对象的形式存入到了数组当中。

四、最后一行,是返回一个this,ImmutableMap能实现链式编程的原因,就是在这个this上。

当理解了这个this,就会理解ImmutableMap设计的精妙之处。

当我们使用链式编程ImmutableMap.<String, String>builder().put("key1","value1").put("key2","value2") .put("key2","value3")来赋值时,其内部就是反复调用了内部静态类Builder当中的put()方法,那么问题来了,为什么能反复调用呢?

答案就是这个返回的this,其返回的还是Builder对象本身啊,Builderd对象当然可以继续调用其put方法了。在这个反复调用的过程中, 只有entries[size++] 是一直在新增变化的。

这其实是建造者设计模式的一种体现,只不过平常遇到的建造者设计模式,大多都是将对象的各个属性灵活进行拼装,组成一个定制化的对象,而这里,则是灵活去定制化一个数组存储情况。

最后就是,就是执行.build()方法了——


ImmutableMap.<String, String>builder()
    .put("Monday","今天上英语课")
    ......
    .build();

这个build()源码里写的很复杂,这里直接简单优化了下,大概意思,就是将entries数组包装成一个实现Map接口的子对象进行返回。


public ImmutableMap<K, V> build() {
  switch (size) {
    case 0:
      return of();
    case 1:
      return  new SingletonImmutableBiMap<K, V>(k1, v1);
    default:
      return  new RegularImmutableMap<K, V>(entries, table, mask);
  }
}

当数组长度超过1时,其可以返回SingletonImmutableBiMap或者RegularImmutableMap,两者都是间接实现了Map接口,对比一下各自的类定义——


final class SingletonImmutableBiMap<K, V> extends ImmutableBiMap<K, V> {
  final transient K singleKey;
  final transient V singleValue;
  ......
}

final class RegularImmutableMap<K, V> extends ImmutableMap<K, V> {
  // entries in insertion order
  private final transient Entry<K, V>[] entries;
  // array of linked lists of entries
  private final transient ImmutableMapEntry<K, V>[] table;
  // 'and' with an int to get a table index
  private final transient int mask;
  ......
}

发现,都有一个共同特点,类与类中的属性,都是以final修饰符来定义的,这就意味着,一旦调用build()方法创建初始化后,就不可以再改变了。

这就是ImmutableMap集合不可变的真正原因所在。

最后,还有一个问题是,当通过ImmutableMap创建完成一个Map对象后,再试图通过put来插入数据时,会发生什么情况呢?

这时,再通过put方法调用时,例如,以上边定义的dayMap为例,在某个方法里,再试图通过dayMap..put("Monday","今天上英语课") 来修改或者新增map数据时,这里调用的put就已经不是内部类Builder<K, V>()里的put方法了,而是ImmutableMap本身的put方法,这个方法的源码如下——



@CanIgnoreReturnValue
@Deprecated
@Override
public final V put(K k, V v) {
  throw new UnsupportedOperationException();
}

其注释表示,map unmodified,即无法再被修改,若仍调用put执行,只会喜提一个异常

UnsupportedOperationException

总结

本篇文章就到这里了,希望能给你带来帮助,也希望您能够多多关注编程网的更多内容!

--结束END--

本文标题: Java源码分析:Guava之不可变集合ImmutableMap的源码分析

本文链接: https://www.lsjlt.com/news/129416.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Java源码分析:Guava之不可变集合ImmutableMap的源码分析
    目录一、案例场景二、ImmutableMap源码分析总结一、案例场景 遇到过这样的场景,在定义一个static修饰的Map时,使用了大量的put()方法赋值,就类似这样—— pu...
    99+
    2022-11-12
  • 关于Java Guava ImmutableMap不可变集合源码分析
    目录Java Guava不可变集合ImmutableMap的源码分析一、案例场景二、ImmutableMap源码分析Java Guava不可变集合ImmutableMap的源码分析 ...
    99+
    2022-11-12
  • java集合类源码分析之Set详解
    Set集合与List一样,都是继承自Collection接口,常用的实现类有HashSet和TreeSet。值得注意的是,HashSet是通过HashMap来实现的而TreeSet是通过TreeMap来实现的,所以HashSet和TreeS...
    99+
    2023-05-31
    java 集合类源码 set
  • Java集合框架概览之ArrayList源码分析
    今天小编给大家分享一下Java集合框架概览之ArrayList源码分析的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。一、从一...
    99+
    2023-07-05
  • Java并发源码分析ConcurrentHashMap线程集合
    目录简介常量构造方法putinitTabletabAtcasTabAthelpTransferputTreeVal锁状态lockRootcontendedLocktreeifyBin...
    99+
    2023-02-01
    Java ConcurrentHashMap Java 线程集合
  • Java源码解析之ConcurrentHashMap的示例分析
    小编给大家分享一下Java源码解析之ConcurrentHashMap的示例分析,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!早期 ConcurrentHashMap,其实现是基于:分离锁,也就是将内部进行分段(Segme...
    99+
    2023-06-15
  • Java线程变量ThreadLocal源码分析
    1.ThreadLocal 线程变量,和当前线程绑定的,只保存当前线程的变量,对于其他线程是隔离的,是访问不到里面的数据的。 2.在Looper中使用到了ThreadLocal,创建...
    99+
    2022-11-13
  • Java中的CyclicBarrier源码分析
    这篇文章主要介绍了Java中的CyclicBarrier源码分析的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇Java中的CyclicBarrier源码分析文章都会有所收获,下面我们一起来看看吧。CyclicB...
    99+
    2023-06-30
  • java 中Buffer源码的分析
    java 中Buffer源码的分析BufferBuffer的类图如下:除了Boolean,其他基本数据类型都有对应的Buffer,但是只有ByteBuffer才能和Channel交互。只有ByteBuffer才能产生Direct的buffe...
    99+
    2023-05-31
    java buffer源码 buf
  • Java源码解析之接口Collection的示例分析
    小编给大家分享一下Java源码解析之接口Collection的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!一、图示二、方法定义我们先想一想,公司如果要我...
    99+
    2023-06-15
  • JAVA核心知识之ConcurrentHashMap源码分析
    1 前言 ConcurrentHashMap是基于Hash表的Map接口实现,键与值均不允许为NULL,他是一个线程安全的Map。同时他也是一个无序的Map,不同时间进行遍历可能会得...
    99+
    2022-11-12
  • Vue源码分析之虚拟DOM的示例分析
    小编给大家分享一下Vue源码分析之虚拟DOM的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!为什么需要虚拟dom?虚拟DOM就是为了解决浏览器性能问题而被...
    99+
    2023-06-15
  • 如何进行jQuery EasyUI 1.2.6源码合集的分析
    如何进行jQuery EasyUI 1.2.6源码合集的分析,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。相信关注过jQuer...
    99+
    2022-10-19
  • python源码剖析之PyObject的示例分析
    这篇文章主要介绍python源码剖析之PyObject的示例分析,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!一、Python中的对象Python中一切皆是对象。————Guido van Rossum(1989)这...
    99+
    2023-06-15
  • Java源码ConcurrentHashMap的示例分析
    小编给大家分享一下Java源码ConcurrentHashMap的示例分析,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!一、记录形式打算直接把过程写在源码中,会按序进行注释,查阅的时候可以按序号只看注释部分二、Concur...
    99+
    2023-06-15
  • Java ConcurrentHashMap的源码分析详解
    目录概述ForwardingNode节点TreeNodeTreeBinSizeCtl初始化初始化流程查找插入扩容红黑树的读&写读操作写操作小结容器计数总结概述 Concurr...
    99+
    2023-03-02
    Java ConcurrentHashMap源码 Java ConcurrentHashMap
  • Python列表和集合效率源码对比分析
    这篇“Python列表和集合效率源码对比分析”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Python列表和集合效率源码对比...
    99+
    2023-07-06
  • PHP底层内核源码之变量的示例分析
    小编给大家分享一下PHP底层内核源码之变量的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!PHP变量的四个基本特征:1.变量命名变量命名上,PHP继承了P...
    99+
    2023-06-15
  • Java定时器Timer的源码分析
    目录一、TimerTask1. 任务状态2. 任务属性说明3. 任务方法说明二、Timer1. sched方法2. cancel方法3. purge方法三、TaskQueue四、Ti...
    99+
    2022-11-13
    Java Timer源码 Java Timer定时器 Java Timer
  • java中CopyOnWriteArrayList源码的示例分析
    这篇文章将为大家详细讲解有关java中CopyOnWriteArrayList源码的示例分析,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。简介CopyOnWriteArrayList是ArrayList的...
    99+
    2023-06-29
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作