導(dǎo)讀
原創(chuàng)文章在跳，轉(zhuǎn)載請注明出處。
本文源碼地址：netty-source-code-analysis
本文所使用的netty版本4.1.6.Final：帶注釋的netty源碼
本文簡要地介紹ByteBuf的結(jié)構(gòu)鸣驱、主要api和創(chuàng)建方法哮内。
1 ByteBuf的結(jié)構(gòu)
每一個ByteBuf都有一個可容納的字節(jié)上限叫capacity圈暗。在ByteBuf中通過兩個指針readerIndex和writerIndex將整個個ByteBuf劃分成3個部分，分別是已丟棄部分缘挽、可讀部分和可寫部分瞄崇，示意圖如下。
+-------------------+------------------+------------------+
| 已丟棄 | 可讀 | 可寫 |
| | (CONTENT) | |
+-------------------+------------------+------------------+
| | | |
0 <= readerIndex <= writerIndex <= capacity
readerIndex壕曼、writerIndex和capacity之間滿足簡單地數(shù)學(xué)關(guān)系0 <= readerIndex <= writerIndex <= capcity苏研。
一個新建的從未進(jìn)行過讀寫操作的ByteBuf，readerIndex和writerIndex都為0腮郊。整個空間都是可寫部分摹蘑。
+---------------------------------------------------------+
| 可寫 |
| |
+---------------------------------------------------------+
| |
0 capacity
readerIndex
writerIndex
現(xiàn)在往其中寫入一些數(shù)據(jù)，寫數(shù)據(jù)的過程會引起writerIndex的移動轧飞，writerIndex移動的最大值為capacity衅鹿，寫數(shù)據(jù)的過程中readerIndex保持不變。
+--------------------------------------+------------------+
| 可讀 | 可寫 |
| (CONTENT) | |
+--------------------------------------+------------------+
| | |
0 <= writerIndex <= capacity
readerIndex
接著讀取一些數(shù)據(jù)过咬，讀數(shù)據(jù)的過程會引起readerIndex的移動大渤，readerIndex的最大值為writerIndex，在讀數(shù)據(jù)的過程中writerIndex保持不變掸绞。已經(jīng)被讀取過的部分就成了已丟棄部分泵三。
+-------------------+------------------+------------------+
| 已丟棄 | 可讀 | 可寫 |
| | (CONTENT) | |
+-------------------+------------------+------------------+
| | | |
0 <= readerIndex <= writerIndex <= capacity
2 ByteBuf的主要方法
2.1 write族方法
write族方法用來向ByteBuf中寫入各種類型的數(shù)據(jù)，比如writeBytes、writeChar烫幕、writeInt等俺抽。另外支持寫入小端字節(jié)序數(shù)據(jù)，比如writeIntLE较曼、writeLongLE等凌埂。
write族方法的調(diào)用時寫入數(shù)據(jù)的起始位置就是當(dāng)前writerIndex指向的位置，寫入數(shù)據(jù)會引起writerIndex的移動诗芜。
2.2 read族方法
read族方法用來從ByteBuf中讀取數(shù)據(jù)，比如readBytes埃疫、writeBytes伏恐、writeLong等。同樣也支持讀取小端字節(jié)序數(shù)據(jù)栓霜，比如readIntLE翠桦、readLongLE等。
read族方法的調(diào)用會引起readerIndex的移動胳蛮。
2.3 set族方法
和write族方法一樣销凑，set族方法同樣用來向ByteBuf中寫入各種類型的數(shù)據(jù)。write能寫入的數(shù)據(jù)set也能仅炊，比如writeInt和setInt斗幼。不同的是set族方法在調(diào)用時需要傳遞一個索引參數(shù)，也就是說需要指定寫入數(shù)據(jù)的位置抚垄，比如writeInt(int value)和setInt(int index, int value)蜕窿。
set族方法的調(diào)用不會引起writerIndex的移動。
2.4 get族方法
和read族方法一樣呆馁，get族方法同樣用來從ByteBuf中讀取數(shù)據(jù)桐经。比如有getInt、getLong方法浙滤。與read族方法不一樣的是在調(diào)用時需要傳遞一個索引參數(shù)阴挣，也就是說需要指定讀取數(shù)據(jù)的位置，比如getInt(int index)和readInt()纺腊。
read族方法的調(diào)用不會引起readerIndex的移動畔咧。
2.5 讀取/設(shè)置 Index的方法
ByteBuf提供了writerIndex()和readerIndex()方法分別可以返回當(dāng)前的writerIndex和readerIndex。
除了read和write方法可以改變readerIndex和writerIndex摹菠，ByteBuf也提供了可以手動設(shè)置readerIndex的readerIndex(int readerIndex)及手動設(shè)置writerIndex的writerIndex(int writerIndex)方法盒卸。
2.6 slice方法
slice方法將當(dāng)前ByteBuf的可讀數(shù)據(jù)區(qū)映射到一個新的ByteBuf，并返回這個新的ByteBuf次氨。這個新的ByteBuf與原ByteBuf共享數(shù)據(jù)區(qū)域蔽介，但是擁有獨(dú)立的readerIndex和writerIndex。
也提供了slice(int index, int length)方法可以指定映射的數(shù)據(jù)區(qū)域范圍。
對新的ByteBuf數(shù)據(jù)的修改同樣會影響到的原來的ByteBuf的數(shù)據(jù)虹蓄，反之亦然犀呼。
2.7 duplicate方法
duplicate方法將當(dāng)前ByteBuf的整個數(shù)據(jù)區(qū)映射到一個新的ByteBuf，并返回這個新的ByteBuf薇组。這個新的ByteBuf與原ByteBuf共享數(shù)據(jù)區(qū)域外臂，但是擁有獨(dú)立的readerIndex和writerIndex。
對新的ByteBuf數(shù)據(jù)的修改同樣會影響到的原來的ByteBuf的數(shù)據(jù)律胀，反之亦然宋光。
2.8 copy方法
copy方法返回當(dāng)前ByteBuf的一個復(fù)制品，新的ByteBuf擁有與原來的ByteBuf不一樣的數(shù)據(jù)區(qū)域炭菌，readerIndex和writerIndex也是獨(dú)立的罪佳。
同樣提供了copy(int index, int length)方法可以指定復(fù)制的數(shù)據(jù)區(qū)域范圍。
對新的ByteBuf數(shù)據(jù)的修改不會影響到原來的ByteBuf黑低，反之亦然赘艳。
2.9 retain和release方法
ByteBuf使用引用計數(shù)法來表示當(dāng)前ByteBuf被引用的次數(shù)，如果一個ByteBuf的被引用次數(shù)為0克握，則釋放該ByteBuf對應(yīng)的內(nèi)存蕾管。
3 ByteBuf的主要實現(xiàn)及創(chuàng)建
ByteBuf的主要實現(xiàn)類圖如下圖所示，總體上分為Pooled和UnPooled兩類菩暗，顧名思義為池化的和非池化的掰曾，又根據(jù)分配的是直接內(nèi)存還是堆內(nèi)存分為HeapByteBuf和DirectByteBuf。
3.1 通過ByteBufAllocator創(chuàng)建
ByteBufAllocator有兩個實現(xiàn)分別為PooledByteBufAllocator和UnpooledByteBufAllocator對應(yīng)分配出來是的PooledByteBuf和UnpooledByteBuf停团。
PooledByteBufAllocator將在后續(xù)的文章中重點(diǎn)分析婴梧，而UnpooledByteBufAllocator則比較簡單，不再贅述客蹋。
3.2 通過包裹ByteBuffer及byte[]創(chuàng)建
使用Unpooled.wrappedBuffer方法可以對jdkButeBuffer及byte[]進(jìn)行包裹創(chuàng)建出一個UnpooledByteBuf塞蹭。
4 總結(jié)
ByteBuf主要api有read/write，get/set讶坯，slice番电，duplicate，copy等系列方法辆琅。實現(xiàn)類上主要分為Unpooled和Pooled漱办，并且支持分配HeapByteBuf及DirectByteBuf。
關(guān)于作者
王建新婉烟，轉(zhuǎn)轉(zhuǎn)架構(gòu)部服務(wù)治理負(fù)責(zé)人娩井，主要負(fù)責(zé)服務(wù)治理、RPC框架似袁、分布式調(diào)用跟蹤洞辣、監(jiān)控系統(tǒng)等咐刨。愛技術(shù)、愛學(xué)習(xí)扬霜，歡迎聯(lián)系交流定鸟。
