学习Netty一般都是使用其中的NIO,因此就必须要了解JDK NIO的一些知识,包括 SocketChannel,ServerSocketChannel,Buffer, Selector, SelectionKey等等,只有对NIO有足够了解,学习Netty起来才会事半功倍。在本文中,会结合源码对JDK的NIO实现进行解析, 源码中加入了我个人的理解的注释,不足之处希望能在评论中不吝指出。
下面是一段JDK的NIO的服务端代码:
/**
* 代码片段1
* @author zhangc
* @version 1.0
* @date 2019/12/2
*/
public class NioServer {
public static void main(String[] args) throws IOException {
Selector selector1 = Selector.open();
Selector selector2 = Selector.open();
new Thread(() -> {
try {
// 启动服务端
ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
//绑定1214端口
serverSocketChannel.socket().bind(new InetSocketAddress(1214));
//设置为非阻塞模式
serverSocketChannel.configureBlocking(false);
//注册通道serverSocketChannel的OP_ACCEPT(服务端建立连接就绪)事件到serverSelector上
serverSocketChannel.register(selector1, SelectionKey.OP_ACCEPT);
while (true) {
// 监测1毫秒内是否有新的连接
if (selector1.select(1) > 0) {
//获取感兴趣的事件
Set set = selector1.selectedKeys();
Iterator keyIterator = set.iterator();
while (keyIterator.hasNext()) {
SelectionKey key = keyIterator.next();
if (key.isAcceptable()) {
try {
// 获取此次OP_ACCEPT事件建的通道
SocketChannel clientChannel = ((ServerSocketChannel) key.channel()).accept();
// 设置非阻塞模型
clientChannel.configureBlocking(false);
// 给这个通道绑定OP_READ(读)事件
clientChannel.register(selector2, SelectionKey.OP_READ);
} finally {
keyIterator.remove();
}
}
}
}
}
} catch (IOException e) {
}
}).start();
new Thread(() -> {
try {
while (true) {
// 监测1毫秒内是否有新的可读数据
if (selector2.select(1) > 0) {
//获取感兴趣的事件
Set set = selector2.selectedKeys();
Iterator keyIterator = set.iterator();
while (keyIterator.hasNext()) {
SelectionKey key = keyIterator.next();
if (key.isReadable()) {
try {
//获取此次读事件的通道
SocketChannel clientChannel = (SocketChannel) key.channel();
//批量读取数据
ByteBuffer byteBuffer = ByteBuffer.allocate(1024);
clientChannel.read(byteBuffer);
//byteBuffer转变为
byteBuffer.flip();
System.out.println(Charset.defaultCharset().newDecoder().decode(byteBuffer)
.toString());
} finally {
keyIterator.remove();
}
}
}
}
}
} catch (IOException e) {
}
}).start();
}
}
Selector是多路复用器(实现可以是select,poll,epoll),相当于一个listener(个人看法),每一个Selector,都需要一个独立的线程去处理。一个Selector中可以绑定多个SocketChannel/ServerSocketChannel,当绑定的SocketChannel/ServerSocketChannel中发生Selector感兴趣的事件(SelectionKey)时,Selector中的publicSelectedKeys(Set)中会增加一个SelectionKey(这次的事件)对象。SelectionKey有四种类型,分别是OP_ACCEPT、OP_CONNECT、OP_READ、OP_WRITE,其中ServerSocketChannel的有效事件(validOps)为OP_ACCEPT,其余三种为SocketChannel的有效事件。上面的代码一个线程中在selector1上给ServerSocketChannel注册了OP_ACCEPT事件,selector1只负责监听新的连接,每当有新的连接建立时,selector1会新建一个此次连接的TCP通道——SocketChannel,然后在selector2上为这个SocketChannel 注册OP_READ事件。在另一个线程中,selector2中绑定的SocketChannel每当有OP_READ事件时,读取通道中的数据并打印在控制台上。
关于SelectionKey
SelectionKey是一个抽象类,它有且仅有1个子类AbstractSelectionKey,AbstractSelectionKey有且仅有一个子类是SelectionKeyImpl。SelectionKey定义了4个常量:
/**
* 代码片段2
*/
public static final int OP_READ = 1 << 0;
public static final int OP_WRITE = 1 << 2;
public static final int OP_CONNECT = 1 << 3;
public static final int OP_ACCEPT = 1 << 4;
只看2进制的后5位(前27位为0),OP_READ为00001,OP_WRITE为00100,OP_CONNECT为01000,OP_ACCEPT为10000,也就是分别是右边第1,3,4,5位为1,其余位为0。基于此,SocketChannel和ServerSocketChannel中获取有效事件的方法是这样的:
/**
* 代码片段3
* NIO代码示例
*/
/*
* SocketChannel获取有效事件 返回的二进制前27位为0,后5位为01101
*/
public final int validOps() {
return (SelectionKey.OP_READ
| SelectionKey.OP_WRITE
| SelectionKey.OP_CONNECT);
}
/*
* ServerSocketChannel获取有效事件 返回的二进制前27位为0,后5位为10000
*/
public final int validOps() {
return SelectionKey.OP_ACCEPT;
}
下面我们看serverSocketChannel.register(selector1, SelectionKey.OP_ACCEPT)这个方法的实现:
/**
* 代码片段4
* AbstractSelectableChannel代码(ServerSocketChanner和SocketChannel的父类)代码
*/
public final SelectionKey register(Selector sel, int ops)
throws ClosedChannelException
{
return register(sel, ops, null);
}
public final SelectionKey register(Selector sel, int ops, Object att)
throws ClosedChannelException
{
synchronized (regLock) {
if (!isOpen())
throw new ClosedChannelException();
//判断注册的事件是否有效 validOps()获取int类型表示的有效事件v,
//v的32位2进制数为1的位,ops对应的位可以1,v为0的位ops对应的位只能为0,否则就无效
if ((ops & ~validOps()) != 0)
throw new IllegalArgumentException();
if (blocking)
throw new IllegalBlockingModeException();
//看这个channel是否已经绑定了这个Selector,如果已经绑定了这个Selector就重新设置这个Selector的interestOps
//如果没有绑定该Selector就会将其绑定
SelectionKey k = findKey(sel);
if (k != null) {
k.interestOps(ops);
k.attach(att);
}
if (k == null) {
// New registration
synchronized (keyLock) {
if (!isOpen())
throw new ClosedChannelException();
k = ((AbstractSelector)sel).register(this, ops, att);
addKey(k);
}
}
return k;
}
}
SelectionKey中维护了对应的Selector,在Channel中维护了一个SelectionKey的数组,在将Selector上为Channel注册事件时,如果Channel中没有绑定对应的Selector,那么就会新建一个SelectionKey(即上面代码片段4中的k = ((AbstractSelector)sel).register(this, ops, att);),具体代码如下:
/**
* 代码片段5
* AbstractSelectableChannel
*/
protected final SelectionKey register(AbstractSelectableChannel var1, int var2, Object var3) {
if (!(var1 instanceof SelChImpl)) {
throw new IllegalSelectorException();
} else {
//这个this就是当前的Selector,将Selector作为构造参数构造一个SelectionKey对象
SelectionKeyImpl var4 = new SelectionKeyImpl((SelChImpl)var1, this);
var4.attach(var3);
Set var5 = this.publicKeys;
//将构造的SelectionKey对象也绑定到Selector中
synchronized(this.publicKeys) {
this.implRegister(var4);
}
//设置SelectionKey的感兴趣事件
var4.interestOps(var2);
return var4;
}
}
构造完成后,会将这个SelectionKey放在Channel的SelectionKey类型数组中,而在Channel中判断是否绑定事件,就是判断这个数组中每一个SelectionKey中维护的Selector是否是这个Selector。这样我们大致的了解了为Channel在Selector上注册事件的流程:
- 首先判断是否是有效事件,不同的Channnel中维护的有效事件不同,ServerSocketChannel中的有效事件为OP_ACCEPT,SocketChannel中的有效事件为OP_CONNECT、OP_READ、OP_WRITE
- 然后在Channel中的SelectionKey数组中判断这些SelectionKey中维护的Selector是否包含当前的Selector,如果不包含就用这个Selector构造一个SelectionKey并放入数组
- 如果包含这个Selector就将对应的SelectionKey的感兴趣事件修改
注册多个感兴趣的事件只需要将多个事件对应的int进行或操作即可:
/**
* 代码片段6
* 注册多个事件
*/
channel.register(selector, SelectionKey.OP_READ | SelectionKey.OP_WRITE | SelectionKey.OP_CONNECT);
对SelectionKey注册多个感兴趣的时间也一样,如果要增加SelectionKey的感兴趣的事件,也只需进行或操作:
/**
* 代码片段7
* 增加SelectionKey的感兴趣的事件
*/
key.interestOps(key.interestOps() | SelectionKey.OP_WRITE);
关于Buffer
在Buffer类的文档注释中是这样描述的:一个特定的基本类型的数据容器,一个buffer(缓冲区,即创建的Buffer对象)是一个线性的、有限的特定基本类型的元素序列,除了它的内容,它本质的属性是它的capacity,limit和position。capacity:buffer包含的元素数量,不为负数且不可改变;limit:第一个不能被读或写的元素的索引,不为负数且不能大于capacity;position:下一个可以被读或写的元素的索引,不为负数且不大于limit。对于每一个非boolean类型的基本类型,jdk都提供了一个Buffer的子类。
数据传输
Buffer的每个子类都定义了2种get和put操作:
- 相对操作——从当前position开始读或者写一个或多个元素,并根据传输的元素增加position的值,如果需要传输的数据超过了limit,相对get操作会抛出BufferUnderflowException异常,相对put操作会抛出BufferOverflowException,在这两种情况下,数据不会被传输
- 绝对操作——使用一个明确的元素索引,并不需要改变position,如果这个索引超出了limit,绝对操作会抛出IndexOutOfBoundsException
关于Buffer类为什么不直接定义get和put方法,我认为原因应该是:java的泛型不支持基本数据类型,如果要定义泛型的get和put方法就要转化成包装类,而在IO操作中频繁地进行拆箱装箱会影响性能。因此,jdk为除了boolean之外的每个基本数据类型定义了Buffer的子类,在这些子抽象类中定义了每种数据类型的get和put方法。
mark和reset
Buffer中的mark是当reset方法被执行时position被重置的索引,mark值并不总是被定义(没有定义的话,初始值为-1),但当mark被定义了,它不为负数且不大于position。如果定义了mark,当position被调整到小于mark时,mark被丢弃(置为-1)。如果mark没有被定义时执行reset方法,会抛出InvalidMarkException。
不变性
mark, position, limit和capacity的值存在以下不变性:
mark <= position <= limit <= capacity
新创建的buffer的position总是0,且mark是未定义的。初始化的limit值可能为0,也可能为其他值,取决于buffer的类型和它构造的方式,新分配的buffer的每个元素都初始化为零。
clear,flip和rewind
除了获取position,limit和capacity的方法、获取mark的方法和reset方法,Buffer类还定义了以下基于缓冲区的操作:
- clear——让buffer为一个新的通道读取序列或相对put操作准备就绪,设置limit为capacity、position为0;
- flip——让buffer一个新的通道写入序列或者相对get操作准备就绪,设置limit为当前的position、position为0;
- rewind——让buffer为重新读取它已经包含的数据准备就绪,设置limit不变,position为0。
只读的buffer
所有buffer都是可读的,但不是所有buffer都是可写的。修改buffer的方法对于每个Buffer的子类来说是可选的,当在只读的buffer上调用这些修改buffer的方法时,会抛出ReadOnlyBufferException。只读的buffer不允许它的数据内容被改变,但它的mark,position和limit是可变的。
一个buffer是不是只读buffer取决于它的isReadOnly方法。
线程安全性
buffer不是多线程安全的。如果一个buffer用来被超过一个线程获取,那么它应该被合适的同步操作进行控制。
HeapByteBuffer和DirectByteBuffer
HeapByteBuffer和DirectByteBuffer都是MappedByteBuffer的子类,MappedByteBuffer继承了ByteBuffer类,顾名思义,HeapByteBuffer和DirectByteBuffer都是字节缓存区,其他基本类型也都对应有HeapXXXBuffer和DirectXXXBuffer类。以HeapByteBuffer和DirectByteBuffer为例,它们的区别如下:
- HeapByteBuffer是分配在JVM堆(Heap)内存上的,遵循JVM的内存管理机制(GC也由JVM负责)。HeapByteBuffer中维护了一个final修饰的byte数组hb,来存储缓冲区的内容。
- DirectByteBuffer是从堆外申请的内存(直接内存),这个内存大小不受-Xmx最大堆内存参数的限制。相比HeapByteBuffer,DirectByteBuffer减少了数据拷贝的次数,但创建和释放的代价更高。DirectByteBuffer中维护了一个名为cleaner的虚引用跟踪堆外内存以及一个long类型的address字段存储内存地址,当DirectByteBuffer将要被GC时,cleaner这个指向直接内存的虚引用会被放入引用队列,在cleaner指向的内存被回首之前,该DirectByteBuffer不会被彻底销毁。(此处建议了解DMA、java的虚引用、操作系统的用户态和内核态、Zero-Copy零拷贝的知识)
抽象类ByteBuffer提供了静态方法allocate(int capacity)和allocateDirect(int capacity)分别用来创建HeapByteBuffer和DirectByteBuffer对象。在这个两个方法中分别调用HeapByteBuffer和DirectByteBuffer的构造方法并返回。HeapByteBuffer的构造方法比较简单,只是对对象的mark,hb,position,limit,capacity等属性进行初始化;而DirectByteBuffer则不太一样,如下所示:
/**
* 代码片段8
* DirectByteBuffer构造函数
*/
// Primary constructor
//
DirectByteBuffer(int cap) { // package-private
super(-1, 0, cap, cap);
//内存是否按页分配对齐
boolean pa = VM.isDirectMemoryPageAligned();
//每页的大小
int ps = Bits.pageSize();
//分配内存的大小
long size = Math.max(1L, (long)cap + (pa ? ps : 0));
//将分配大小和容量大小加到Bits中的totalCapacity(总容量)和reservedMemory(总大小)两个属性(AtomicLong类型)中
Bits.reserveMemory(size, cap);
long base = 0;
try {
//在堆外分配内存
base = unsafe.allocateMemory(size);
} catch (OutOfMemoryError x) {
//内存不够再减去
Bits.unreserveMemory(size, cap);
throw x;
}
unsafe.setMemory(base, size, (byte) 0);
//计算堆外内存的首地址
if (pa && (base % ps != 0)) {
// Round up to page boundary
address = base + ps - (base & (ps - 1));
} else {
address = base;
}
//创建cleaner虚引用绑定这个buffer,cleaner回收时会执行clean方法,clean方法会调用Deallocator的run方法
cleaner = Cleaner.create(this, new Deallocator(base, size, cap));
att = null;
}
可以看到,DirectByteBuffer的创建需要使用unsafe去堆外申请内存,然后将地址保存下来,并通过一个Cleanner的虚引用保存该内存地址的首部
和长度。
下面来看HeapByteBuffer和DirectByteBuffer的get、put方法,首先是HeapByteBuffer的get方法:
/**
* 代码片段9
* HeapByteBuffer的get方法和get方法中调用的部分方法
*/
//获取当前position实际地址的方法
//返回i加上偏移量offset 这个offset在创建HeapByteBuffer时指定,是一个final修饰的int类型
protected int ix(int i) {
return i + offset;
}
//相对操作get position加1 然后返回保存数据的数组中下标为position+offset的字节
public byte get() {
return hb[ix(nextGetIndex())];
}
//绝对操作get 返回保存数据的数组中下标为i+offset的字节
public byte get(int i) {
return hb[ix(checkIndex(i))];
}
//相对操作get,将保存数据的数组中下标从position+this.offset开始length长度的部分复制到dst数组中下标从offset开始length长度的部分
//并设置position += length,返回当前的buffer
public ByteBuffer get(byte[] dst, int offset, int length) {
checkBounds(offset, length, dst.length);
if (length > remaining())
throw new BufferUnderflowException();
System.arraycopy(hb, ix(position()), dst, offset, length);
position(position() + length);
return this;
}
然后是HeapByteBuffer中的put方法:
/**
* 代码片段10
* HeapByteBuffer的put方法和put方法中调用的部分方法
*/
//相对操作put position加1 将x保存在保存书据的数组的position+offset下标位置
public ByteBuffer put(byte x) {
hb[ix(nextPutIndex())] = x;
return this;
}
//绝对操作put position不变 将x保存在保存书据的数组的i+offset下标位置
public ByteBuffer put(int i, byte x) {
hb[ix(checkIndex(i))] = x;
return this;
}
//相对操作put 将src中从offset开始的length长度的数据复制到buffer中数组的position+offset开始的length长度的部分
//并设置position += length,返回当前的buffer
public ByteBuffer put(byte[] src, int offset, int length) {
//检查是否数组越界
checkBounds(offset, length, src.length);
if (length > remaining())
throw new BufferOverflowException();
System.arraycopy(src, offset, hb, ix(position()), length);
position(position() + length);
return this;
}
//相对操作put 将另一个ByteBuffer src中从当前position+offset位置开始limit - position长度的数据
//复制到this的position+offset的位置 并将src和this的position都加n(n为src的剩余可读/写长度,limit - position)
public ByteBuffer put(ByteBuffer src) {
if (src instanceof HeapByteBuffer) {
//如果是HeapByteBuffer且不是本身就进行数组复制,并将this和src的position加n
if (src == this)
throw new IllegalArgumentException();
HeapByteBuffer sb = (HeapByteBuffer)src;
//判断this的剩余容量够不够
int n = sb.remaining();
if (n > remaining())
throw new BufferOverflowException();
System.arraycopy(sb.hb, sb.ix(sb.position()),
hb, ix(position()), n);
sb.position(sb.position() + n);
position(position() + n);
} else if (src.isDirect()) {
//如果是直接字节缓冲,就用src的get操作将数据写到this的保存数据的数组,并将position加n
int n = src.remaining();
if (n > remaining())
throw new BufferOverflowException();
src.get(hb, ix(position()), n);
position(position() + n);
} else {
//如果既不是HeapByteBuffer,也不是直接字节缓冲,就调用父类的put方法
super.put(src);
}
return this;
}
下面是DirectByteBuffer的get方法:
/**
* 代码片段11
* DirectByteBuffer的get方法和get方法中调用的部分方法
*/
//获取当前position实际地址的方法
//返回i加上address
private long ix(int i) {
return address + ((long)i << 0);
}
//相对操作get 当前position++ 然后获取从直接内存中获取position+addess对应位置的值
public byte get() {
return ((unsafe.getByte(ix(nextGetIndex()))));
}
//绝对操作get position不变 从直接内存中获取i+addess对应位置的值
public byte get(int i) {
return ((unsafe.getByte(ix(checkIndex(i)))));
}
//相对操作的get 从内存中将position+address开始、长度为length的数据取出放入数组dst的下标offset开始、length长度的部分
//并设置position += length,返回当前的buffer
public ByteBuffer get(byte[] dst, int offset, int length) {
if (((long)length << 0) > Bits.JNI_COPY_TO_ARRAY_THRESHOLD) {
//如果length大于Bits.JNI_COPY_TO_ARRAY_THRESHOLD(这个值为6)就直接复制到数组中
//JNI_COPY_TO_ARRAY_THRESHOLD表示根据经验确定JNI调用的平均成本逐个元素复制超过整个数组复制的点,这个数字可能会随着时间改变
//检查数组是否越界
checkBounds(offset, length, dst.length);
int pos = position();
int lim = limit();
assert (pos <= lim);
int rem = (pos <= lim ? lim - pos : 0);
if (length > rem)
throw new BufferUnderflowException();
Bits.copyToArray(ix(pos), dst, arrayBaseOffset,
(long)offset << 0,
(long)length << 0);
position(pos + length);
} else {
//如果不大于6,就调用父类的get方法进行逐个元素复制
super.get(dst, offset, length);
}
return this;
}
//父类ByteBuffer中的get方法 循环去执行无参的相对get方法
public ByteBuffer get(byte[] dst, int offset, int length) {
checkBounds(offset, length, dst.length);
if (length > remaining())
throw new BufferUnderflowException();
int end = offset + length;
for (int i = offset; i < end; i++)
dst[i] = get();
return this;
}
然后是DirectByteBuffer的put方法:
/**
* 代码片段12
* DirectByteBuffer的put方法和put方法中调用的部分方法
*/
//相对操作put position++ 然后将直接内存中address+position对应位置的设置为x
public ByteBuffer put(byte x) {
unsafe.putByte(ix(nextPutIndex()), ((x)));
return this;
}
//绝对操作put position不变 将直接内存中address+i对应位置的设置为x
public ByteBuffer put(int i, byte x) {
unsafe.putByte(ix(checkIndex(i)), ((x)));
return this;
}
//相对操作put 然后将直接内存中address+position对应位置开始、src剩余可读/写容量长度的内存区域设置为
//src的position开始、src剩余可读/写容量长度的内容
//并且src和this的position都加n(n为src剩余可读/写容量长度,limit - position )
public ByteBuffer put(ByteBuffer src) {
if (src instanceof DirectByteBuffer且不为本身,) {
//如果src是DirectByteBuffer且不为本身,就在堆外进行内存复制
if (src == this)
throw new IllegalArgumentException();
DirectByteBuffer sb = (DirectByteBuffer)src;
int spos = sb.position();
int slim = sb.limit();
assert (spos <= slim);
int srem = (spos <= slim ? slim - spos : 0);
int pos = position();
int lim = limit();
assert (pos <= lim);
int rem = (pos <= lim ? lim - pos : 0);
//判断是否有足够的容量
if (srem > rem)
throw new BufferOverflowException();
//内存拷贝
unsafe.copyMemory(sb.ix(spos), ix(pos), (long)srem << 0);
sb.position(spos + srem);
position(pos + srem);
} else if (src.hb != null) {
//如果src不是DirectByteBuffer,且保存数据的数组hb不为空,就讲hb作为参数调用下面的另一个重载的put方法
int spos = src.position();
int slim = src.limit();
assert (spos <= slim);
int srem = (spos <= slim ? slim - spos : 0);
put(src.hb, src.offset + spos, srem);
src.position(spos + srem);
} else {
super.put(src);
}
return this;
}
//相对操作的put 从内存中将position+address开始、长度为length的数据存入数组src的下标offset开始、length长度的部分的内容
//并设置position += length,返回当前的buffer
public ByteBuffer put(byte[] src, int offset, int length) {
if (((long)length << 0) > Bits.JNI_COPY_FROM_ARRAY_THRESHOLD) {
//如果length大于JNI_COPY_FROM_ARRAY_THRESHOLD(值为6) 就将整个数组直接复制到内存
//表示根据经验确定JNI调用的平均成本逐个元素复制超过整个数组复制的点,这个数字可能会随着时间改变
checkBounds(offset, length, src.length);
int pos = position();
int lim = limit();
assert (pos <= lim);
int rem = (pos <= lim ? lim - pos : 0);
if (length > rem)
throw new BufferOverflowException();
//直接将数组拷贝到内存
Bits.copyFromArray(src, arrayBaseOffset,
(long)offset << 0,
ix(pos),
(long)length << 0);
position(pos + length);
} else {
//如果小于6 调用父类的put方法 循环将数组从offset到offset+length的数据逐个复制
super.put(src, offset, length);
}
return this;
}
以上的源码中都清楚地通过注释阐明了HeapByteBuffer和DirectByteBuffer的put和get操作的工作流程,根据源码,可以总结出:
- position就是buffer中当前读到/写到的地方的索引,当相对读完或者相对写完数据后,position会发生改变。因此在相对写之后、相对读之前,要调用buffer.flip()——设置limit为当前的position(因为position往后就没有数据了)、position为0(为相对读做好准备);在相对读之后、相对写之前,要调用buffer.clear()——设置limit为capacity(想写多少写多少,这里limit限制的是读)、position为0(为相对写做好准备)。flip和clear并不会改变数组hb或者堆外内存中数据的内容,只是改变几个标记值。
总结
JDK的NIO虽然与Netty相比不尽完善,但还是有很多可取之处的。而且,学习JDK的NIO之后也能更方便地阅读Netty的源码。如果你想学习Netty,并正在了解JDK NIO的相关知识,希望这篇文章能给你带来收获。