Java ~ Reference ~ FinalizerHistogram【源码】

前言

---

 文章

• 相关系列：《Java ~ Reference【目录】》（持续更新）
• 相关系列：《Java ~ Reference ~ FinalizerHistogram【源码】》（学习过程/多有漏误/仅作参考/不再更新）
• 相关系列：《Java ~ Reference ~ FinalizerHistogram【总结】》（学习总结/最新最准/持续更新）
• 相关系列：《Java ~ Reference ~ FinalizerHistogram【问题】》（学习解答/持续更新）
• 涉及内容：《Java ~ Reference ~ Finalizer【总结】》

一 FinalizerHistogram（终结者柱状图）类源码及机制详解

---

 类

    FinalizerHistogram（终结者柱状图）类用于支持GC.finalizer_info诊断命令，由虚拟机进行调用。终结者柱状图类的作用是统计Finalizer（终结者）总数，其会以终结者所指对象/F类对象的类为维度对f-queue中的终结者进行统计，返回倒序排序（即从大到小）的终结者总数统计结果，以支持GC.finalizer_info诊断命令。

/**
 * This FinalizerHistogram class is for GC.finalizer_info diagnostic command support. It is invoked by the VM.
 * 终结者柱状图类用于支持GC.finalizer_info诊断命令。其由虚拟机调用。
 */
final class FinalizerHistogram {
    ...
}

 方法

• static Entry[] getFinalizerHistogram() —— 获取终结者柱状图 —— 以终结者所指对象/F类对象的类为维度获取倒序排序的终结者总数数组。
      方法首先会创建一个哈希映射，用于承载所有的统计结果。随后从终结者类中获取f-queue遍历，获取（但不移除）所有的终结者，并以终结者所指对象/F类对象的类为维度统计终结者总数。每次统计后都需要断开当前线程与所指对象/F类对象的关联，以避免影响其被GC回收。统计完成后，从哈希映射中获取条目数组，并以【实例总数】为比较条件倒序排序后返回。

// Method below is called by VM and VM expect certain entry class layout.
// 方法由VM调用，并且VM期望某些条目类布局。

/**
 * @Description: --------------------------------------------------------------- 名称 ---------------------------------------------------------------
 * @Description: 获取终结者柱状图
 * @Description: --------------------------------------------------------------- 作用 ---------------------------------------------------------------
 * @Description: 以终结者所指对象/F类对象的类为维度获取倒序排序的终结者总数数组。
 * @Description: --------------------------------------------------------------- 逻辑 ---------------------------------------------------------------
 * @Description: 方法首先会创建一个哈希映射，用于承载所有的统计结果。随后从终结者类中获取f-queue遍历，获取（但不
 * @Description: 移除）所有的终结者，并以终结者所指对象/F类对象的类为维度统计终结者总数。每次统计后都需要断开当前
 * @Description: 线程与所指对象/F类对象的关联，以避免影响其被GC回收。统计完成后，从哈希映射中获取条目数组，并以【
 * @Description: 实例总数】为比较条件倒序排序后返回。
 * @Description: --------------------------------------------------------------- 注意 ---------------------------------------------------------------
 * @Description: ~
 * @Description: --------------------------------------------------------------- 疑问 ---------------------------------------------------------------
 * @Description: ~
 */
static Entry[] getFinalizerHistogram() {
    // 方法首先会创建一个哈希映射，用于承载所有的统计结果。随后从终结者类中获取f-queue遍历，获取（但不移除）所有的
    // 终结者，并以终结者所指对象/F类对象的类为维度统计终结者总数。每次统计后都需要断开当前线程与所指对象/F类对象
    // 的关联，以避免影响其被GC回收。
    Map<String, Entry> countMap = new HashMap<>();
    ReferenceQueue<Object> queue = Finalizer.getQueue();
    queue.forEach(r -> {
        Object referent = r.get();
        if (referent != null) {
            countMap.computeIfAbsent(referent.getClass().getName(), Entry::new).increment();
            /* Clear stack slot containing this variable, to decrease the chances of false retention with a conservative GC */
            /* 清理堆栈槽包含的当前变量, 以减少保守GC时错误保留的机会 */
            referent = null;
        }
    });
    // 统计完成后，从哈希映射中获取条目数组，并以【实例总数】为比较条件倒序排序后返回。
    Entry fhe[] = countMap.values().toArray(new Entry[countMap.size()]);
    Arrays.sort(fhe, Comparator.comparingInt(Entry::getInstanceCount).reversed());
    return fhe;
}

二 Entry（条目）类源码及机制详解

---

 类

    条目类是终结者柱状图类的自实现内部类，是对终结者进行统计的基本单位。

/**
 * Final references, used to implement finalization
 *
 * @Description: 终引用类
 */
private static final class Entry {
    ...
}

 字段

• instanceCount —— 实例总数 —— 记录终结者总数。

        /**
         * @Description: --------------------------------------------------------------- 名称 ---------------------------------------------------------------
         * @Description: 实例总数
         * @Description: --------------------------------------------------------------- 作用 ---------------------------------------------------------------
         * @Description: 记录终结者总数。
         * @Description: --------------------------------------------------------------- 逻辑 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 注意 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 疑问 ---------------------------------------------------------------
         * @Description: ~
         */
        private int instanceCount;

• className —— 类名 —— 记录类名。

        /**
         * @Description: --------------------------------------------------------------- 名称 ---------------------------------------------------------------
         * @Description: 类名
         * @Description: --------------------------------------------------------------- 作用 ---------------------------------------------------------------
         * @Description: 记录类名。
         * @Description: --------------------------------------------------------------- 逻辑 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 注意 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 疑问 ---------------------------------------------------------------
         * @Description: ~
         */
        private final String className;

 构造方法

    Entry(String className) —— 通过类名创建条目。

        Entry(String className) {
            this.className = className;
        }

 方法

• int getInstanceCount() —— 获取实例总数 —— 获取当前条目的终结者总数

        /**
         * @Description: --------------------------------------------------------------- 名称 ---------------------------------------------------------------
         * @Description: 获取实例总数
         * @Description: --------------------------------------------------------------- 作用 ---------------------------------------------------------------
         * @Description: 获取当前条目的实例总数。
         * @Description: --------------------------------------------------------------- 逻辑 ---------------------------------------------------------------
         * @Description: 方法直接返回【实例总数】。
         * @Description: --------------------------------------------------------------- 注意 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 疑问 ---------------------------------------------------------------
         * @Description: ~
         */
        int getInstanceCount() {
            return instanceCount;
        }

• void increment()—— 递增 —— 递增当前条目的终结者总数

        /**
         * @Description: --------------------------------------------------------------- 名称 ---------------------------------------------------------------
         * @Description: 递增
         * @Description: --------------------------------------------------------------- 作用 ---------------------------------------------------------------
         * @Description: 递增当前条目的实例总数。
         * @Description: --------------------------------------------------------------- 逻辑 ---------------------------------------------------------------
         * @Description: 方法直接递增【实例总数】实现。
         * @Description: --------------------------------------------------------------- 注意 ---------------------------------------------------------------
         * @Description: ~
         * @Description: --------------------------------------------------------------- 疑问 ---------------------------------------------------------------
         * @Description: ~
         */
        void increment() {
            instanceCount += 1;
        }