Netty——ByteBuffer的方法说明演示示例

Posted 2022-08-04 小志的博客

目录

• • 一、ByteBuffer的常见方法
  • • 1.1、分配空间方法
    • • 1.1.1、分配空间方法的概述
      • 1.1.2、分配空间方法示例
    • 1.2、向 buffer 写入数据方法
    • • 1.2.1、向 buffer 写入数据方法的概述
      • 1.2.2、向 buffer 写入数据方法示例
    • 1.3、从 buffer 读取数据方法
    • • 1.3.1、从 buffer 读取数据方法的概述
      • 1.3.2、从 buffer 读取数据方法示例
      • 1.3.3、buffer 的 get 方法注意事项
    • 1.4、 rewind 方法
    • • 1.4.1、rewind 方法的概述
      • 1.4.2、rewind 方法示例
    • 1.5、get(int i) 方法
    • • 1.5.1、get(int i) 方法的概述
      • 1.5.2、get(int i) 方法示例
    • 1.6、mark 和 reset 方法
    • • 1.6.1、mark 和 reset 方法 方法的概述
      • 1.6.2、mark 和 reset 方法示例

一、ByteBuffer的常见方法

1.1、分配空间方法

1.1.1、分配空间方法的概述

• 可以使用 allocate 方法为 ByteBuffer 分配空间，其它 buffer 类也有该方法。

1.1.2、分配空间方法示例

• 示例代码

  package com.example.nettytest.nio.day1;
  
  import lombok.extern.slf4j.Slf4j;
  import java.nio.ByteBuffer;
  
  /**
   * @description:
   * @author: xz
   * @create: 2022-07-24 18:05
   */
  @Slf4j
  public class TestByteBufferAllocate 
      public static void main(String[] args) 
          log.info("allocate方法====="+ByteBuffer.allocate(16).getClass());
          log.info("allocateDirect方法====="+ByteBuffer.allocateDirect(16).getClass());
          /**
           *  class java.nio.HeapByteBuffer    
           * 		java 堆内存，读写效率较低，受到 GC 的影响
           *  class java.nio.DirectByteBuffer  
           *      直接内存，读写效率高（少一次拷贝），不会受 GC 影响，分配的效率低
           * */
      
  
  

• 输出结果
  

• java.nio.HeapByteBuffer 和java.nio.DirectByteBuffer区别
  （1）、HeapByteBuffer：java 堆内存，读写效率较低，受到 GC 的影响。
  （2）、DirectByteBuffer：直接内存，读写效率高（少一次拷贝），不会受 GC 影响，分配的效率低。

1.2、向 buffer 写入数据方法

1.2.1、向 buffer 写入数据方法的概述

• 有两种方式可以向buffer 写入数据
• 第一种方式：调用 channel 的 read 方法
• 第一种方式：调用 buffer 自己的 put 方法

1.2.2、向 buffer 写入数据方法示例

• 示例代码

  package com.example.nettytest.nio.day1;
  
  import lombok.extern.slf4j.Slf4j;
  import java.nio.ByteBuffer;
  import static com.example.nettytest.nio.day1.ByteBufferUtil.debugAll;
  /**
   * @description:
   * @author: xz
   * @create: 2022-07-24 18:05
   */
  @Slf4j
  public class TestByteBufferAllocate 
      public static void main(String[] args) 
          ByteBuffer buffer = ByteBuffer.allocate(10);
          /**
           * 写入十六进制的一个字节
           * */
          buffer.put((byte) 0x61);
          /**
           * 切换到读模式，并读取一个字节（该十六进制字节读取后会转换成十进制并输出）
           * */
          buffer.flip();
          System.out.println(buffer.get());
      
  
  

• 输出结果
  

1.3、从 buffer 读取数据方法

1.3.1、从 buffer 读取数据方法的概述

• 有两种方式可以从 buffer 读取数据
• 第一种方式：调用 channel 的 write 方法
• 第一种方式：调用 buffer 自己的 get 方法

1.3.2、从 buffer 读取数据方法示例

• 示例代码

  package com.example.nettytest.nio.day1;
  
  import lombok.extern.slf4j.Slf4j;
  import java.nio.ByteBuffer;
  import static com.example.nettytest.nio.day1.ByteBufferUtil.debugAll;
  /**
   * @description:
   * @author: xz
   * @create: 2022-07-24 18:05
   */
  @Slf4j
  public class TestByteBufferAllocate 
      public static void main(String[] args) 
          ByteBuffer buffer = ByteBuffer.allocate(10);
          /**
           * 写入十六进制的一个字节
           * */
          buffer.put((byte) 0x61);
          /**
           * 切换到读模式
           * */
          buffer.flip();
          /**
           * 读取一个字节（该十六进制字节读取后会转换成十进制并输出）
           * */
          byte b = buffer.get();
          log.info("从 buffer 读取到的数据为："+b);
      
  
  

• 输出结果
  

1.3.3、buffer 的 get 方法注意事项

• get 方法会让 position 读指针向后走，如果想重复读取数据：
  （1）、可以调用 rewind 方法将 position 重新置为 0。
  （2）、或者调用 get(int i) 方法获取索引 i 的内容，它不会移动读指针。

1.4、 rewind 方法

1.4.1、rewind 方法的概述

• rewind 方法将 position 重新置为 0。

1.4.2、rewind 方法示例

• 工具类，输出ByteBuffer内部结构使用

  package com.example.nettytest.nio.day1;
  
  import io.netty.util.internal.StringUtil;
  
  import java.nio.ByteBuffer;
  
  import static io.netty.util.internal.MathUtil.isOutOfBounds;
  import static io.netty.util.internal.StringUtil.NEWLINE;
  
  public class ByteBufferUtil 
      private static final char[] BYTE2CHAR = new char[256];
      private static final char[] HEXDUMP_TABLE = new char[256 * 4];
      private static final String[] HEXPADDING = new String[16];
      private static final String[] HEXDUMP_ROWPREFIXES = new String[65536 >>> 4];
      private static final String[] BYTE2HEX = new String[256];
      private static final String[] BYTEPADDING = new String[16];
  
      static 
          final char[] DIGITS = "0123456789abcdef".toCharArray();
          for (int i = 0; i < 256; i++) 
              HEXDUMP_TABLE[i << 1] = DIGITS[i >>> 4 & 0x0F];
              HEXDUMP_TABLE[(i << 1) + 1] = DIGITS[i & 0x0F];
          
  
          int i;
  
          // Generate the lookup table for hex dump paddings
          for (i = 0; i < HEXPADDING.length; i++) 
              int padding = HEXPADDING.length - i;
              StringBuilder buf = new StringBuilder(padding * 3);
              for (int j = 0; j < padding; j++) 
                  buf.append("   ");
              
              HEXPADDING[i] = buf.toString();
          
  
          // Generate the lookup table for the start-offset header in each row (up to 64KiB).
          for (i = 0; i < HEXDUMP_ROWPREFIXES.length; i++) 
              StringBuilder buf = new StringBuilder(12);
              buf.append(NEWLINE);
              buf.append(Long.toHexString(i << 4 & 0xFFFFFFFFL | 0x100000000L));
              buf.setCharAt(buf.length() - 9, '|');
              buf.append('|');
              HEXDUMP_ROWPREFIXES[i] = buf.toString();
          
  
          // Generate the lookup table for byte-to-hex-dump conversion
          for (i = 0; i < BYTE2HEX.length; i++) 
              BYTE2HEX[i] = ' ' + StringUtil.byteToHexStringPadded(i);
          
  
          // Generate the lookup table for byte dump paddings
          for (i = 0; i < BYTEPADDING.length; i++) 
              int padding = BYTEPADDING.length - i;
              StringBuilder buf = new StringBuilder(padding);
              for (int j = 0; j < padding; j++) 
                  buf.append(' ');
              
              BYTEPADDING[i] = buf.toString();
          
  
          // Generate the lookup table for byte-to-char conversion
          for (i = 0; i < BYTE2CHAR.length; i++) 
              if (i <= 0x1f || i >= 0x7f) 
                  BYTE2CHAR[i] = '.';
               else 
                  BYTE2CHAR[i] = (char) i;
              
          
      
  
      /**
       * 打印所有内容
       * @param buffer
       */
      public static void debugAll(ByteBuffer buffer) 
          int oldlimit = buffer.limit();
          buffer.limit(buffer.capacity());
          StringBuilder origin = new StringBuilder(256);
          appendPrettyHexDump(origin, buffer, 0, buffer.capacity());
          System.out.println("+--------+-------------------- all ------------------------+----------------+");
          System.out.printf("position: [%d], limit: [%d]\\n", buffer.position(), oldlimit);
          System.out.println(origin);
          buffer.limit(oldlimit);
      
  
      /**
       * 打印可读取内容
       * @param buffer
       */
      public static void debugRead(ByteBuffer buffer) 
          StringBuilder builder = new StringBuilder(256);
          appendPrettyHexDump(builder, buffer, buffer.position(), buffer.limit() - buffer.position());
          System.out.println("+--------+-------------------- read -----------------------+----------------+");
          System.out.printf("position: [%d], limit: [%d]\\n", buffer.position(), buffer.limit());
          System.out.println(builder);
      
  
      public static void main(String[] args) 
          ByteBuffer buffer = ByteBuffer.allocate(10);
          buffer.put(new byte[]97, 98, 99, 100);
          debugAll(buffer);
      
  
      private static void appendPrettyHexDump(StringBuilder dump, ByteBuffer buf, int offset, int length) 
          if (isOutOfBounds(offset, length, buf.capacity())) 
              throw new IndexOutOfBoundsException(
                      "expected: " + "0 <= offset(" + offset + ") <= offset + length(" + length
                              + ") <= " + "buf.capacity(" + buf.capacity() + ')');
          
          if (length == 0) 
              return;
          
          dump.append(
                  "         +-------------------------------------------------+" +
                          NEWLINE + "         |  0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f |" +
                          NEWLINE + "+--------+-------------------------------------------------+----------------+");
  
          final int startIndex = offset;
          final int fullRows = length >>> 4;
          final int remainder = length & 0xF;
  
          // Dump the rows which have 16 bytes.
          for (int row = 0; row < fullRows; row++) 
              int rowStartIndex = (row << 4) + startIndex;
  
              // Per-row prefix.
              appendHexDumpRowPrefix(dump, row, rowStartIndex);
  
              // Hex dump
              int rowEndIndex = rowStartIndex + 16;
              for (int j = rowStartIndex; j < rowEndIndex; j++) 
                  dump.append(BYTE2HEX[getUnsignedByte(buf, j)]);
              
              dump.append(" |");
  
              // ASCII dump
              for (int j = rowStartIndex; j < rowEndIndex; j++) 
                  dump.append(BYTE2CHAR[getUnsignedByte(buf, j)]);
              
              dump.append('|');
          
  
          // Dump the last row which has less than 16 bytes.
          if (remainder != 0) 
              int rowStartIndex = (fullRows << 4) + startIndex;
              appendHexDumpRowPrefix(dump, fullRows, rowStartIndex);
  
              // Hex dump
              int rowEndIndex = rowStartIndex + remainder;
              for (int j = rowStartIndex; j < rowEndIndex; j++) 
                  dump.append(BYTE2HEX[getUnsignedByte(buf, j)]);
              
              dump.append(HEXPADDING[remainder]);
              dump.append(" |");
  
              // Ascii dump
              for (int j = rowStartIndex; j < rowEndIndex; j++) 
                  dump.append(BYTE2CHAR[getUnsignedByte(buf, j)]);
              
              dump.append(BYTEPADDING[remainder]);
              dump.append('|');
          
  
          dump.append(NEWLINE +
                  "+--------+-------------------------------------------------+----------------+");
      
  
      private static void appendHexDumpRowPrefix(StringBuilder dump, int row, int rowStartIndex) 
          if (row < HEXDUMP_ROWPREFIXES.length) 
              dump.append(HEXDUMP_ROWPREFIXES[row]);
           else 
              dump.append(NEWLINE);
              dump.append(Long.toHexString(rowStartIndex & 0xFFFFFFFFL | 0x100000000L));
              dump.setCharAt(dump.length() - 9, '|');
              dump.append('|');
          
      
  
      public static short getUnsignedByte(ByteBuffer buffer, int index) 
          return (short) (buffer.get(index) & 0xFF);
      
  
  

• 示例代码

  package com.example.nettytest.nio.day1;
  import java.nio.ByteBuffer;
  import static com.example.nettytest.nio.day1.ByteBufferUtil.debugAll;
  
  /**
   * @description:
   * @author: xz
   * @create: 2022-07-24 18:38
   */
  public class TestByteBufferRead 
      public static void main(String[] args) 
          rewind();
      
  
      public static void rewind()
          ByteBuffer buffer = ByteBuffer.allocate(10);
          //写入数据
          buffer.put(new byte[]'a', 'b', 'c', 'd'以上是关于Netty——ByteBuffer的方法说明演示示例的主要内容，如果未能解决你的问题，请参考以下文章
   
   Netty——ByteBuffer的内部结构演示示例
   Netty——ByteBuffer的内部结构演示示例
   io.netty.ByteBuf writeBytes(java.nio.ByteBuffer src) API说明
   netty ByteBuf
   Netty网络编程第一卷
   Netty——字符串与 ByteBuffer相互转换示例