RabbitMQ客户端源码分析(二)之Frame与FrameHandler

文章目录

版本声明
Frame(帧)分析

版本声明

com.rabbitmq:amqp-client:4.3.0
RabbitMQ版本声明: 3.6.15

Frame(帧)分析

AMQP帧(Frame)的格式

tcp/ip是一个流协议，amqp没有采用在流中添加帧定界符来区分帧数据（原因官方认为简单，但是很慢），而是采用在header中写入帧大小来区分不同的帧（官方认为简单而且很快）。
Frame(帧)就是传输协议的具体实现,即传输的具体数据包
- 帧类型通道编号帧大小内容结束标记
从上面可以看到读取一个Frame，大概要实现的逻辑
- 第一步:读取header，检查Frame的类型(1,2,3,8四种类型,AMQP.java类中定义)和Channel编号
- 第二步:根据帧的类型(type)和payload的长度(size)来读取指定大小的payload进行处理
- 第三步:读取最后一个字节(结束帧)。
- 从上面的三步骤来看其实就是在做自定义协议解析的工作，不只是针对AMQP，其实自己定义的协议很多时候也是这么做的。
AMQP协议定义了五种类型的帧:协议头帧、method frame(方法帧)、content header frame(内容头帧)、content body(消息体帧)、HEARTBEAT(心跳帧)
方法帧:一个Method Frame(方法帧)携带一个命令，方法帧payload有下面的格式
Content Header的payload格式如下:
Content Body Frame:内容是我们通常AMQP服务器在客户端与客户端之间传送和应用数据,内容头帧包含一条消息的大小和属性

Frame源码分析

详细的中文注释请访问Frame.java

Frame的属性

public class Frame {
     
     
    /** Frame type code */
    public final int type;

    /** Frame channel number, 0-65535 通道编号，一个TCPIP连接，多个通道，每个通道都有自己的编号*/
    public final int channel;

    /** Frame payload bytes (for inbound frames) 有效载荷,就是除了协议头之外的内容*/
    private final byte[] payload;

    /** Frame payload (for outbound frames) 字节流的累加器，用于*/
    private final ByteArrayOutputStream accumulator;

    /**
     * 自定义协议都是 【协议头】+【协议体】,NON_BODY_SIZE指的是没有协议体内容的情况下最小的传输
     * 长度。从这里可以看出【协议头】=type(1B)+channel(2B)+payloadSize(4B)+1(1B),总共占用8B(8个字节)
     */
    private static final int NON_BODY_SIZE = 1 /* type */ + 2 /* channel */ + 4 /* payload size */ + 1 /* end character */;
        
}

读取Frame

public static Frame readFrom(DataInputStream is) throws IOException {
     
     
    int type;
    int channel;

    try {
     
     
        //读取1B
        type = is.readUnsignedByte();
    } catch (SocketTimeoutException ste) {
     
     
        // System.err.println("Timed out waiting for a frame.");
        return null; // failed
    }

    if (type == 'A') {
     
     
        /*
         * Probably an AMQP.... header indicating a version
         * mismatch.
         */
        /*
         * Otherwise meaningless, so try to read the version,
         * and throw an exception, whether we read the version
         * okay or not.检查协议版本
         */
        protocolVersionMismatch(is);
    }
    //读取2B
    channel = is.readUnsignedShort();
    //读取4B
    int payloadSize = is.readInt();
    //构造存放内容的字节数组
    byte[] payload = new byte[payloadSize];
    /**
     *  readFully数据缓冲区的空间还有剩余时会阻塞等待读取，直到装满。
     *  此处不能使用is.read(payload),
     *  read(byte[] b)一直阻塞等待读取字节，直到字节流中的数据已经全部读完。
     *  而readFully(byte[] b)是当数据缓冲区的空间还有剩余时会阻塞等待读取，直到装满。
     */

    is.readFully(payload);

    int frameEndMarker = is.readUnsignedByte();
    //如果读取完body之后最后一个字节不是结束帧，就代表数据格式不正确，以此来判断Frame的传输的正确性
    if (frameEndMarker != AMQP.FRAME_END) {
     
     
        throw new MalformedFrameException("Bad frame end marker: " + frameEndMarker);
    }

    return new Frame(type, channel, payload);
}