Apache Ignite二进制客户端协议深度解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00073/article/details/148524012

Apache Ignite二进制客户端协议深度解析

ignite Apache Ignite 项目地址: https://gitcode.com/gh_mirrors/ignite16/ignite

协议概述

Apache Ignite的二进制客户端协议允许应用程序通过原始TCP套接字与Ignite集群进行通信，而无需启动完整的Ignite节点。这种轻量级的通信方式为需要高效访问Ignite集群的应用程序提供了便利。

核心优势

轻量级连接：无需承担完整节点的资源开销
低延迟：直接TCP通信减少中间层处理
跨语言支持：基于二进制协议，易于各种语言实现

数据格式详解

字节序规范

Ignite二进制协议采用小端字节序(Little-Endian)，这是现代CPU架构的主流字节序，能提供更好的性能。

数据类型支持

Ignite支持丰富的数据类型表示：

基本类型：包括所有Java基本类型(byte, short, int, long, float, double, char, boolean)
复杂对象：通过二进制对象格式表示
特殊类型：如UUID、Date、Timestamp等

消息协议架构

通用消息结构

所有消息(请求和响应)都遵循以下结构：

4字节消息长度：不包括这4字节本身
消息体：具体内容根据操作类型变化

握手协议

连接建立后必须首先进行握手，确保客户端和服务器版本兼容。

请求结构： | 字段类型 | 说明 | |---------|------| | int | 握手负载长度 | | byte | 握手代码(固定为1) | | short | 主版本号 | | short | 次版本号 | | short | 修订版本号 | | byte | 客户端代码(固定为2) | | String | 用户名 | | String | 密码 |

成功响应： | 字段类型 | 说明 | |---------|------| | int | 消息长度(固定为1) | | byte | 成功标志(1) |

失败响应： | 字段类型 | 说明 | |---------|------| | int | 错误消息长度 | | byte | 成功标志(0) | | short | 服务器主版本号 | | short | 服务器次版本号 | | short | 服务器修订版本号 | | String | 错误消息 |

连接管理

TCP连接配置

Ignite默认在10800端口监听客户端连接，可通过配置修改：

IgniteConfiguration cfg = new IgniteConfiguration();

ClientConnectorConfiguration clientCfg = new ClientConnectorConfiguration();
clientCfg.setHost("127.0.0.1");  // 绑定IP
clientCfg.setPort(10900);        // 起始端口
clientCfg.setPortRange(30);      // 端口范围

cfg.setClientConnectorConfiguration(clientCfg);

连接生命周期

建立TCP连接
执行握手协议
进行业务操作
保持连接或按需关闭

客户端操作实现

操作消息头

所有客户端操作消息都包含公共头部：

请求头： | 字段类型 | 说明 | |---------|------| | int | 负载长度 | | short | 操作代码 | | long | 请求ID(客户端生成) |

响应头： | 字段类型 | 说明 | |---------|------| | int | 响应消息长度 | | long | 请求ID(与请求对应) | | int | 状态码(0表示成功) | | String | 错误消息(仅失败时存在) |

典型操作流程示例

// 建立连接
Socket socket = new Socket();
socket.connect(new InetSocketAddress("127.0.0.1", 10800));

// 准备输出流
DataOutputStream out = new DataOutputStream(socket.getOutputStream());

// 发送握手请求
writeIntLittleEndian(18 + username.length() + password.length(), out);  // 消息长度
writeByteLittleEndian(1, out);  // 握手代码
writeShortLittleEndian(1, out); // 主版本
writeShortLittleEndian(0, out); // 次版本
writeShortLittleEndian(0, out); // 修订版本
writeByteLittleEndian(2, out);  // 客户端代码
writeString(username, out);     // 用户名
writeString(password, out);     // 密码
out.flush();

// 处理握手响应
DataInputStream in = new DataInputStream(socket.getInputStream());
int length = readIntLittleEndian(in);
byte successFlag = readByteLittleEndian(in);

if(successFlag == 1) {
    // 握手成功，可以开始业务操作
} else {
    // 处理握手失败
}

字节序处理实现

由于协议使用小端字节序，需要特殊处理：

// 小端序写入int
private static void writeIntLittleEndian(int v, DataOutputStream out) throws IOException {
    out.write((v >>> 0) & 0xFF);
    out.write((v >>> 8) & 0xFF);
    out.write((v >>> 16) & 0xFF);
    out.write((v >>> 24) & 0xFF);
}

// 小端序读取int
private static int readIntLittleEndian(DataInputStream in) throws IOException {
    int ch1 = in.read();
    int ch2 = in.read();
    int ch3 = in.read();
    int ch4 = in.read();
    if ((ch1 | ch2 | ch3 | ch4) < 0)
        throw new EOFException();
    return ((ch4 << 24) + (ch3 << 16) + (ch2 << 8) + (ch1 << 0));
}