Netty分布式ByteBuf缓冲区分配器源码解析

缓冲区分配器

顾明思议就是分配缓冲区的工具, 在netty中, 缓冲区分配器的顶级抽象是接口ByteBufAllocator, 里面定义了有关缓冲区分配的相关api

抽象类AbstractByteBufAllocator实现了ByteBufAllocator接口, 并且实现了其大部分功能

和AbstractByteBuf一样, AbstractByteBufAllocator也实现了缓冲区分配的骨架逻辑, 剩余的交给其子类

以其中的分配ByteBuf的方法为例, 对其做简单的介绍

public ByteBuf buffer() {
    if (directByDefault) {
        return directBuffer();
    }
    return heapBuffer();
}

这里if (directByDefault)会判断默认创建的ByteBuf是不是一个基于直接内存的ByteBuf, 也就是direct类型的ByteBuf, 如果是, 则通过directBuffer()方法返回direct类型的ByteBuf, 否则, 会通过heapBuffer()返回heap类型的ByteBuf

跟到directBuffer()方法中

public ByteBuf directBuffer() {
    return directBuffer(DEFAULT_INITIAL_CAPACITY, Integer.MAX_VALUE);
}

这里又调用了一个重载directBuffer方法, 其中DEFAULT_INITIAL_CAPACITY代表分配的默认容量, Integer.MAX_VALUE表示分配的ByteBuf可扩容的最大容量, 也就是Integer类型的最大值, 我们再跟进去:

public ByteBuf directBuffer(int initialCapacity, int maxCapacity) {
    if (initialCapacity == 0 && maxCapacity == 0) {
        return emptyBuf;
    }
    validate(initialCapacity, maxCapacity);
    return newDirectBuffer(initialCapacity, maxCapacity);
}

这里判断如果初始容量和最大容量都为0的话, 则返回一个emptyBuf的成员变量, emptyBuf代表一个空的ByteBuf

然后通过validate方法进行参数验证

最后newDirectBuffer创建一个Direct类型的ByteBuf, 并将初始容量和最大容量传入

在AbstractByteBufAllocator中, newDirectBuffer是一个抽象方法, 由其子类实现

protected abstract ByteBuf newDirectBuffer(int initialCapacity, int maxCapacity);

我们回到缓冲区分配的方法

public ByteBuf buffer() {
    if (directByDefault) {
        return directBuffer();
    }
    return heapBuffer();
}

刚才简单剖析了directBuffer()的分配, 现在在继续跟到heapBuffer()中, 看其分配heap类型的ByteBuf的抽象逻辑:

public ByteBuf heapBuffer() {
    return heapBuffer(DEFAULT_INITIAL_CAPACITY, Integer.MAX_VALUE);
}

这里同样调用了重载的heapBuffer, 并传入了初始容量和最大容量

再继续跟heapBuffer方法:

public ByteBuf heapBuffer(int initialCapacity, int maxCapacity) {
    if (initialCapacity == 0 && maxCapacity == 0) {
        return emptyBuf;
    }
    validate(initialCapacity, maxCapacity);
    return newHeapBuffer(initialCapacity, maxCapacity);
}

同样, 这里如果初始容量和最大容量都为空的话, 返回一个代表空的ByteBuf

然后通过validate方法进行参数验证

最后通过newHeapBuffer方法创建一个新的heap类型的ByteBuf

同样, newHeapBuffer方法在AbstractByteBufAllocator中也是一个抽象方法, 具体逻辑交给其子类实现

protected abstract ByteBuf newHeapBuffer(int initialCapacity, int maxCapacity);

newDirectBuffer和newHeapBuffer两个抽象方法中, 在其子类PooledByteBufAllocator和UnpooledByteBufAllocator中都有实现

我们以UnpooledByteBufAllocator的newHeapBuffer方法为例, 看其实现:

protected ByteBuf newHeapBuffer(int initialCapacity, int maxCapacity) {
    return PlatformDependent.hasUnsafe() ? new UnpooledUnsafeHeapByteBuf(this, initialCapacity, maxCapacity)
            : new UnpooledHeapByteBuf(this, initialCapacity, maxCapacity);
}

里实现方式其实很简单, 首先通过PlatformDependent.hasUnsafe()判断当前运行环境是否能创建unsafe对象, 如果能, 则直接通过new UnpooledUnsafeHeapByteBuf(this, initialCapacity, maxCapacity)方式创建一个UnpooledUnsafeHeapByteBuf对象, 也就是一个Unsafe的ByteBuf对象

如果当前环境不能创建unsafe对象, 则通过new UnpooledHeapByteBuf(this, initialCapacity, maxCapacity)这种方方式创建一个UnpooledHeapByteBuf对象, 也就是非Unsafe的ByteBuf对象

从这里能看出, 其实在创建ByteBuf对象时, 是否创建unsafe类型的对象并不是我们自己控制的, 而是通过程序判断当前环境来决定是否创建unsafe类型的ByteBuf对象的

有关ByteBufAllocator的继承关系如下: