浅谈 Java 引用：弱引用 WeakReference

前言

最近在测试 micrometer 的 Gauge 度量时，发现被观察的目标对象，在一开始时能被采集到指标，过了一段时间后（jvm发生了gc），被观察对象的指标采集不到了，经过跟踪发现，Gauge在构建被观察对象时，使用了Java的弱引用。

测试场景回溯

• 目标

为了采集 httpclient 的连接管理器（连接池）的指标，如 leased、pending、available、max

public interface ConnPoolControl<T> {
    ... 其它略
    PoolStats getTotalStats();
    PoolStats getStats(final T route);
}

public class PoolStats implements Serializable {
    ... 其它略
    private final int leased;
    private final int pending;
    private final int available;
    private final int max;
}

• 伏笔点：获取连接池统计对象（PoolStats）

public abstract class AbstractConnPool<T, C, E extends PoolEntry<T, C>> implements ConnPool<T, E>, ConnPoolControl<T> {
    ... 其它略
    public PoolStats getTotalStats() {
        this.lock.lock();
        try {
            return new PoolStats(						// 注意: 这里是 new 出的对象
                    this.leased.size(),
                    this.pending.size(),
                    this.available.size(),
                    this.maxTotal);
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public PoolStats getStats(final T route) {
        Args.notNull(route, "Route");
        this.lock.lock();
        try {
            final RouteSpecificPool<T, C, E> pool = getPool(route);
            return new PoolStats(					// 注意: 这里是 new 出的对象
                    pool.getLeasedCount(),
                    pool.getPendingCount(),
                    pool.getAvailableCount(),
                    getMax(route));
        } finally {
            this.lock.unlock();
        }
    }
    ... 其它略
}

• 问题点：构建&注册 Gauge 度量

// 业务代码
PoolingHttpClientConnectionManager cm = HttpClientPoolUtil.getConnectionManager();
if (cm != null) {
    for (HttpRoute route : cm.getRoutes()) {
        String hostname = route.getTargetHost().getHostName();
        PoolStats poolStats = cm.getStats(route); // 注意：这里 getStats 返回的是 new 出的对象
        Gauge.builder("httpclient_leased", poolStats, PoolStats::getLeased).tag("hostname", hostname).register(Metrics.globalRegistry);
        Gauge.builder("httpclient_available", poolStats, PoolStats::getAvailable).tag("hostname", hostname).register(Metrics.globalRegistry);
        Gauge.builder("httpclient_pending", poolStats, PoolStats::getPending).tag("hostname", hostname).register(Metrics.globalRegistry);
        Gauge.builder("httpclient_max", poolStats, PoolStats::getMax).tag("hostname", hostname).register(Metrics.globalRegistry);
    }
}

// 下面的是 micrometer 组件源码（只贴了相关的）
public abstract class MeterRegistry {
    ... 其它略
    <T> Gauge gauge(Meter.Id id, @Nullable T obj, ToDoubleFunction<T> valueFunction) {
        return registerMeterIfNecessary(Gauge.class, id, id2 -> newGauge(id2, obj, valueFunction), NoopGauge::new);
    }

    protected abstract <T> Gauge newGauge(Meter.Id id, @Nullable T obj, ToDoubleFunction<T> valueFunction);
    ... 其它略
}

public class CompositeMeterRegistry extends MeterRegistry {
    ... 其它略
    @Override
    protected <T> Gauge newGauge(Meter.Id id, @Nullable T obj, ToDoubleFunction<T> valueFunction) {
        return new CompositeGauge<>(id, obj, valueFunction);
    }
    ... 其它略
}

class CompositeGauge<T> extends AbstractCompositeMeter<Gauge> implements Gauge {
    ... 其它略
    CompositeGauge(Meter.Id id, @Nullable T obj, ToDoubleFunction<T> f) {
        super(id);
        ref = new WeakReference<>(obj); // obj 是被观察的目标对象
        this.f = f;
    }
    ... 其它略
}

在看到 ref = new WeakReference<>(obj); 这一句时，问题就可以结束了。

下面用图表述问题：当栈中引用结束后，只剩下方法区的常量对象(即globalRegistry)meterMap中的Gauge对象，以弱引用的形式执行堆在的对象PoolStats，这时候，对于jvm来说，PoolStats 对象就可以被 gc 了，因此问题发生。

最后

只要规避堆中的对象仅仅只被一个弱引用指向（还被强引用指向），此问题就不会发生，不在此赘述。