rocketmq源码3-通信-协议

一 协议体

  • RemotingCommand请求报文信息
public class RemotingCommand {
    private int code;//请求码
    private LanguageCode language = LanguageCode.JAVA;//语言
    private int version = 0;//rocketmq版本
    private int opaque = requestId.getAndIncrement();//请求id
    private int flag = 0;//报文类型标记
    private String remark;//描述信息
    private HashMap extFields;//customHeader的属性信息
    private transient CommandCustomHeader customHeader;
//序列化类型
    private SerializeType serializeTypeCurrentRPC = serializeTypeConfigInThisServer;
//之前的部分为协议报文头
//报文体
    private transient byte[] body;
}
  • 设置版本信息
private static void setCmdVersion(RemotingCommand cmd) {
    if (configVersion >= 0) {
        cmd.setVersion(configVersion);
    } else {
        String v = System.getProperty(REMOTING_VERSION_KEY);
        if (v != null) {
            int value = Integer.parseInt(v);
            cmd.setVersion(value);
            configVersion = value;
        }
    }
}
  • createResponseCommand()创建报文体

1.1 编码

  • 报文序列化格式为:总长度|序列化类型+头长度|头|消息体,计算总长度,序列化数据
  • 计算总长度,依次存储数据。
public ByteBuffer encode() {
    // 1> header length size
    int length = 4;

    // 2> header data length
    byte[] headerData = this.headerEncode();
    length += headerData.length;

    // 3> body data length
    if (this.body != null) {
        length += body.length;
    }

    ByteBuffer result = ByteBuffer.allocate(4 + length);

    // length
    result.putInt(length);

    // header length
    result.put(markProtocolType(headerData.length, serializeTypeCurrentRPC));

    // header data
    result.put(headerData);

    // body data;
    if (this.body != null) {
        result.put(this.body);
    }

    result.flip();

    return result;
}
  • 报文头序列化
private byte[] headerEncode() {
    this.makeCustomHeaderToNet();
    if (SerializeType.ROCKETMQ == serializeTypeCurrentRPC) {
        return RocketMQSerializable.rocketMQProtocolEncode(this);
    } else {
        return RemotingSerializable.encode(this);
    }
}
  • makeCustomHeaderToNet()把customHeader属性信息转换成报文头的扩展域数据
  • markProtocolType(headerData.length, serializeTypeCurrentRPC),第一位存储序列化类型,后三位存储报文头长度

1.2 解码

  • 获取总长度信息,分配空间存储数据
  • 获取序列化类型,反序列化报文头信息
  • 计算报文体长度,获取报文体信息
public static RemotingCommand decode(final ByteBuffer byteBuffer) {
    int length = byteBuffer.limit();
    int oriHeaderLen = byteBuffer.getInt();
    int headerLength = getHeaderLength(oriHeaderLen);

    byte[] headerData = new byte[headerLength];
    byteBuffer.get(headerData);

    RemotingCommand cmd = headerDecode(headerData, getProtocolType(oriHeaderLen));

    int bodyLength = length - 4 - headerLength;
    byte[] bodyData = null;
    if (bodyLength > 0) {
        bodyData = new byte[bodyLength];
        byteBuffer.get(bodyData);
    }
    cmd.body = bodyData;

    return cmd;
}

二 序列化

  • 两种序列化类型
public enum SerializeType {
    JSON((byte) 0),
    ROCKETMQ((byte) 1);

    private byte code;

    SerializeType(byte code) {
        this.code = code;
    }

    public static SerializeType valueOf(byte code) {
        for (SerializeType serializeType : SerializeType.values()) {
            if (serializeType.getCode() == code) {
                return serializeType;
            }
        }
        return null;
    }

    public byte getCode() {
        return code;
    }
}

2.1 JSON

  • 编码就是转成json串
public static byte[] encode(final Object obj) {
    final String json = toJson(obj, false);
    if (json != null) {
        return json.getBytes(CHARSET_UTF8);
    }
    return null;
}

public static String toJson(final Object obj, boolean prettyFormat) {
    return JSON.toJSONString(obj, prettyFormat);
}
  • 解码就是json解析
public static  T decode(final byte[] data, Class classOfT) {
    final String json = new String(data, CHARSET_UTF8);
    return fromJson(json, classOfT);
}

public static  T fromJson(String json, Class classOfT) {
    return JSON.parseObject(json, classOfT);
}

2.2 ROCKETMQ

2.2.1 编码

  • 获取remark信息
// String remark
byte[] remarkBytes = null;
int remarkLen = 0;
if (cmd.getRemark() != null && cmd.getRemark().length() > 0) {
    remarkBytes = cmd.getRemark().getBytes(CHARSET_UTF8);
    remarkLen = remarkBytes.length;
}
  • 获取扩展域信息
// HashMap extFields
byte[] extFieldsBytes = null;
int extLen = 0;
if (cmd.getExtFields() != null && !cmd.getExtFields().isEmpty()) {
    extFieldsBytes = mapSerialize(cmd.getExtFields());
    extLen = extFieldsBytes.length;
}
  • 计算报文总长度
private static int calTotalLen(int remark, int ext) {
    // int code(~32767)
    int length = 2
        // LanguageCode language
        + 1
        // int version(~32767)
        + 2
        // int opaque
        + 4
        // int flag
        + 4
        // String remark
        + 4 + remark
        // HashMap extFields
        + 4 + ext;

    return length;
}
  • 分配内存ByteBuffer headerBuffer = ByteBuffer.allocate(totalLen);
  • 写入报文数据
// int code(~32767),请求编码
headerBuffer.putShort((short) cmd.getCode());
// LanguageCode language
headerBuffer.put(cmd.getLanguage().getCode());
// int version(~32767),mcq版本
headerBuffer.putShort((short) cmd.getVersion());
// int opaque,请求id
headerBuffer.putInt(cmd.getOpaque());
// int flag,报文类型
headerBuffer.putInt(cmd.getFlag());
// String remark,描述信息。序列化时先写入长度,后写入数据
if (remarkBytes != null) {
    headerBuffer.putInt(remarkBytes.length);
    headerBuffer.put(remarkBytes);
} else {
    headerBuffer.putInt(0);
}
// HashMap extFields; 扩展信息。序列化时先写入长度,后写入数据
if (extFieldsBytes != null) {
    headerBuffer.putInt(extFieldsBytes.length);
    headerBuffer.put(extFieldsBytes);
} else {
    headerBuffer.putInt(0);
}

return headerBuffer.array();
  • flag标识报文类型,
    第一位为1表示响应报文,0表示请求报文
    第二位为1表示单向报文,0表示双向报文
RPC_TYPE = 0;
RPC_ONEWAY = 1;
public void markResponseType() {
    int bits = 1 << RPC_TYPE;
    this.flag |= bits;
}
public void markOnewayRPC() {
    int bits = 1 << RPC_ONEWAY;
    this.flag |= bits;
}

2.2.1.1 mapSerialize

public static byte[] mapSerialize(HashMap map) {
    // keySize+key+valSize+val
    if (null == map || map.isEmpty())
        return null;

    int totalLength = 0;
    int kvLength;
    Iterator> it = map.entrySet().iterator();
//计算序列化所需的总长度
    while (it.hasNext()) {
        Map.Entry entry = it.next();
        if (entry.getKey() != null && entry.getValue() != null) {
            kvLength =
                // keySize + Key
                2 + entry.getKey().getBytes(CHARSET_UTF8).length
                    // valSize + val
                    + 4 + entry.getValue().getBytes(CHARSET_UTF8).length;
            totalLength += kvLength;
        }
    }

    ByteBuffer content = ByteBuffer.allocate(totalLength);
    byte[] key;
    byte[] val;
    it = map.entrySet().iterator();
//序列化存储,key长度+key值+val长度+val值
    while (it.hasNext()) {
        Map.Entry entry = it.next();
        if (entry.getKey() != null && entry.getValue() != null) {
            key = entry.getKey().getBytes(CHARSET_UTF8);
            val = entry.getValue().getBytes(CHARSET_UTF8);

            content.putShort((short) key.length);
            content.put(key);

            content.putInt(val.length);
            content.put(val);
        }
    }

    return content.array();
}

2.2.2 解码

  • 根据编码规则反向解析数据为结构化的对象。

你可能感兴趣的:(rocketmq源码3-通信-协议)