怒肝四个月MySQL源码，我总结出这篇MySQL协议（详尽版）！！

淡淡的烟草味﹌ 2021-09-03 04:05 191阅读 0赞

## 写在前面 ##

> 最近，在开发一个分库分表中间件，由于功能需求，需要分析MySQL协议，发现网上对于MySQL协议分析的文章大部分都过时了，原因是分析的MySQL版本太低了。怎么办呢？于是乎，我便硬着头皮开始啃MySQL源码，经过两个多月的整理，终于总结出这篇MySQL协议。
> 
> 注：部分来自于互联网，感谢数据库大牛前辈们的默默付出！！

## 交互过程 ##

MySQL客户端与服务器的交互主要分为两个阶段：握手认证阶段和命令执行阶段。

### 握手认证阶段 ###

握手认证阶段为客户端与服务器建立连接后进行，交互过程如下：

*  服务器 -> 客户端：握手初始化消息
 *  客户端 -> 服务器：登陆认证消息
 *  服务器 -> 客户端：认证结果消息

### 命令执行阶段 ###

客户端认证成功后，会进入命令执行阶段，交互过程如下：

*  客户端 -> 服务器：执行命令消息
 *  服务器 -> 客户端：命令执行结果

**MySQL客户端与服务器的完整交互过程如下**：

\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GkdRdRi5-1605703163469)(http://hutaow.com/images/articles/201311/mysql\_protocol\_message.png)\]

## 基本类型 ##

### 整型值 ###

MySQL报文中整型值分别有1、2、3、4、8字节长度，使用小字节序传输。

### 字符串（以NULL结尾）（Null-Terminated String） ###

字符串长度不固定，当遇到’NULL’（0x00）字符时结束。

### 二进制数据（长度编码）（Length Coded Binary） ###

数据长度不固定，长度值由数据前的1-9个字节决定，其中长度值所占的字节数不定，字节数由第1个字节决定，如下表：

<table> 
 <thead> 
  <tr> 
   <th>第一个字节值</th> 
   <th>后续字节数</th> 
   <th>长度值说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0-250</td> 
   <td>0</td> 
   <td>第一个字节值即为数据的真实长度</td> 
  </tr> 
  <tr> 
   <td>251</td> 
   <td>0</td> 
   <td>空数据，数据的真实长度为零</td> 
  </tr> 
  <tr> 
   <td>252</td> 
   <td>2</td> 
   <td>后续额外2个字节标识了数据的真实长度</td> 
  </tr> 
  <tr> 
   <td>253</td> 
   <td>3</td> 
   <td>后续额外3个字节标识了数据的真实长度</td> 
  </tr> 
  <tr> 
   <td>254</td> 
   <td>8</td> 
   <td>后续额外8个字节标识了数据的真实长度</td> 
  </tr> 
 </tbody> 
</table>

### 字符串（长度编码）（Length Coded String） ###

字符串长度不固定，无’NULL’（0x00）结束符，编码方式与上面的 Length Coded Binary 相同。

## 报文结构 ##

报文分为消息头和消息体两部分，其中消息头占用固定的4个字节，消息体长度由消息头中的长度字段决定，报文结构如下：

![e7a84d24b1a2342ebcc186ed3138c5ec.png][]

### 消息头 ###

**报文长度**

用于标记当前请求消息的实际数据长度值，以字节为单位，占用3个字节，最大值为 0xFFFFFF，即接近 16 MB 大小（比16MB少1个字节）。

**序号**

在一次完整的请求/响应交互过程中，用于保证消息顺序的正确，每次客户端发起请求时，序号值都会从0开始计算。

### 消息体 ###

消息体用于存放请求的内容及响应的数据，长度由消息头中的长度值决定。

## 报文类型 ##

### 登陆认证交互报文 ###

**握手初始化报文（服务器 -> 客户端）**

![f98839fd0611dcfc8b3b878e81cc42f2.png][]

**服务协议版本号**：该值由 PROTOCOL\_VERSION 宏定义决定（参考MySQL源代码`/include/mysql_version.h`头文件定义）

**服务版本信息**：该值为字符串，由 MYSQL\_SERVER\_VERSION 宏定义决定（参考MySQL源代码`/include/mysql_version.h`头文件定义）

**服务器线程ID**：服务器为当前连接所创建的线程ID。

**挑战随机数**：MySQL数据库用户认证采用的是挑战/应答的方式，服务器生成该挑战数并发送给客户端，由客户端进行处理并返回相应结果，然后服务器检查是否与预期的结果相同，从而完成用户认证的过程。

**服务器权能标志**：用于与客户端协商通讯方式，各标志位含义如下（参考MySQL源代码`/include/mysql_com.h`中的宏定义）：

<table> 
 <thead> 
  <tr> 
   <th>标志位名称</th> 
   <th>标志位</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>CLIENT_LONG_PASSWORD</td> 
   <td>0x0001</td> 
   <td>new more secure passwords</td> 
  </tr> 
  <tr> 
   <td>CLIENT_FOUND_ROWS</td> 
   <td>0x0002</td> 
   <td>Found instead of affected rows</td> 
  </tr> 
  <tr> 
   <td>CLIENT_LONG_FLAG</td> 
   <td>0x0004</td> 
   <td>Get all column flags</td> 
  </tr> 
  <tr> 
   <td>CLIENT_CONNECT_WITH_DB</td> 
   <td>0x0008</td> 
   <td>One can specify db on connect</td> 
  </tr> 
  <tr> 
   <td>CLIENT_NO_SCHEMA</td> 
   <td>0x0010</td> 
   <td>Do not allow database.table.column</td> 
  </tr> 
  <tr> 
   <td>CLIENT_COMPRESS</td> 
   <td>0x0020</td> 
   <td>Can use compression protocol</td> 
  </tr> 
  <tr> 
   <td>CLIENT_ODBC</td> 
   <td>0x0040</td> 
   <td>Odbc client</td> 
  </tr> 
  <tr> 
   <td>CLIENT_LOCAL_FILES</td> 
   <td>0x0080</td> 
   <td>Can use LOAD DATA LOCAL</td> 
  </tr> 
  <tr> 
   <td>CLIENT_IGNORE_SPACE</td> 
   <td>0x0100</td> 
   <td>Ignore spaces before ‘(’</td> 
  </tr> 
  <tr> 
   <td>CLIENT_PROTOCOL_41</td> 
   <td>0x0200</td> 
   <td>New 4.1 protocol</td> 
  </tr> 
  <tr> 
   <td>CLIENT_INTERACTIVE</td> 
   <td>0x0400</td> 
   <td>This is an interactive client</td> 
  </tr> 
  <tr> 
   <td>CLIENT_SSL</td> 
   <td>0x0800</td> 
   <td>Switch to SSL after handshake</td> 
  </tr> 
  <tr> 
   <td>CLIENT_IGNORE_SIGPIPE</td> 
   <td>0x1000</td> 
   <td>IGNORE sigpipes</td> 
  </tr> 
  <tr> 
   <td>CLIENT_TRANSACTIONS</td> 
   <td>0x2000</td> 
   <td>Client knows about transactions</td> 
  </tr> 
  <tr> 
   <td>CLIENT_RESERVED</td> 
   <td>0x4000</td> 
   <td>Old flag for 4.1 protocol</td> 
  </tr> 
  <tr> 
   <td>CLIENT_SECURE_CONNECTION</td> 
   <td>0x8000</td> 
   <td>New 4.1 authentication</td> 
  </tr> 
  <tr> 
   <td>CLIENT_MULTI_STATEMENTS</td> 
   <td>0x0001 0000</td> 
   <td>Enable/disable multi-stmt support</td> 
  </tr> 
  <tr> 
   <td>CLIENT_MULTI_RESULTS</td> 
   <td>0x0002 0000</td> 
   <td>Enable/disable multi-results</td> 
  </tr> 
 </tbody> 
</table>

**字符编码**：标识服务器所使用的字符集。

**服务器状态**：状态值定义如下（参考MySQL源代码`/include/mysql_com.h`中的宏定义）：

<table> 
 <thead> 
  <tr> 
   <th>状态名称</th> 
   <th>状态值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SERVER_STATUS_IN_TRANS</td> 
   <td>0x0001</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_AUTOCOMMIT</td> 
   <td>0x0002</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_CURSOR_EXISTS</td> 
   <td>0x0040</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_LAST_ROW_SENT</td> 
   <td>0x0080</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_DB_DROPPED</td> 
   <td>0x0100</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_NO_BACKSLASH_ESCAPES</td> 
   <td>0x0200</td> 
  </tr> 
  <tr> 
   <td>SERVER_STATUS_METADATA_CHANGED</td> 
   <td>0x0400</td> 
  </tr> 
 </tbody> 
</table>

**登陆认证报文（客户端 -> 服务器）**

**MySQL 4.0 及之前的版本**

![d0e287ac6b443c809ae4ea491bbdb505.png][]

**MySQL 4.1 及之后的版本**

![5e0f75b90a72a3a901339ec60e562f9b.png][]

**客户端权能标志**：用于与客户端协商通讯方式，标志位含义与握手初始化报文中的相同。客户端收到服务器发来的初始化报文后，会对服务器发送的权能标志进行修改，保留自身所支持的功能，然后将权能标返回给服务器，从而保证服务器与客户端通讯的兼容性。

**最大消息长度**：客户端发送请求报文时所支持的最大消息长度值。

**字符编码**：标识通讯过程中使用的字符编码，与服务器在认证初始化报文中发送的相同。

**用户名**：客户端登陆用户的用户名称。

**挑战认证数据**：客户端用户密码使用服务器发送的挑战随机数进行加密后，生成挑战认证数据，然后返回给服务器，用于对用户身份的认证。

**数据库名称**：当客户端的权能标志位 CLIENT\_CONNECT\_WITH\_DB 被置位时，该字段必须出现。

### 客户端命令请求报文（客户端 -> 服务器） ###

![6a5ffe611bced954532104eb49acb437.png][]

**命令**：用于标识当前请求消息的类型，例如切换数据库（0x02）、查询命令（0x03）等。命令值的取值范围及说明如下表（参考MySQL源代码`/include/mysql_com.h`头文件中的定义）：

<table> 
 <thead> 
  <tr> 
   <th>类型值</th> 
   <th>命令</th> 
   <th>功能</th> 
   <th>关联函数</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0x00</td> 
   <td>COM_SLEEP</td> 
   <td>（内部线程状态）</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x01</td> 
   <td>COM_QUIT</td> 
   <td>关闭连接</td> 
   <td>mysql_close</td> 
  </tr> 
  <tr> 
   <td>0x02</td> 
   <td>COM_INIT_DB</td> 
   <td>切换数据库</td> 
   <td>mysql_select_db</td> 
  </tr> 
  <tr> 
   <td>0x03</td> 
   <td>COM_QUERY</td> 
   <td>SQL查询请求</td> 
   <td>mysql_real_query</td> 
  </tr> 
  <tr> 
   <td>0x04</td> 
   <td>COM_FIELD_LIST</td> 
   <td>获取数据表字段信息</td> 
   <td>mysql_list_fields</td> 
  </tr> 
  <tr> 
   <td>0x05</td> 
   <td>COM_CREATE_DB</td> 
   <td>创建数据库</td> 
   <td>mysql_create_db</td> 
  </tr> 
  <tr> 
   <td>0x06</td> 
   <td>COM_DROP_DB</td> 
   <td>删除数据库</td> 
   <td>mysql_drop_db</td> 
  </tr> 
  <tr> 
   <td>0x07</td> 
   <td>COM_REFRESH</td> 
   <td>清除缓存</td> 
   <td>mysql_refresh</td> 
  </tr> 
  <tr> 
   <td>0x08</td> 
   <td>COM_SHUTDOWN</td> 
   <td>停止服务器</td> 
   <td>mysql_shutdown</td> 
  </tr> 
  <tr> 
   <td>0x09</td> 
   <td>COM_STATISTICS</td> 
   <td>获取服务器统计信息</td> 
   <td>mysql_stat</td> 
  </tr> 
  <tr> 
   <td>0x0A</td> 
   <td>COM_PROCESS_INFO</td> 
   <td>获取当前连接的列表</td> 
   <td>mysql_list_processes</td> 
  </tr> 
  <tr> 
   <td>0x0B</td> 
   <td>COM_CONNECT</td> 
   <td>（内部线程状态）</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x0C</td> 
   <td>COM_PROCESS_KILL</td> 
   <td>中断某个连接</td> 
   <td>mysql_kill</td> 
  </tr> 
  <tr> 
   <td>0x0D</td> 
   <td>COM_DEBUG</td> 
   <td>保存服务器调试信息</td> 
   <td>mysql_dump_debug_info</td> 
  </tr> 
  <tr> 
   <td>0x0E</td> 
   <td>COM_PING</td> 
   <td>测试连通性</td> 
   <td>mysql_ping</td> 
  </tr> 
  <tr> 
   <td>0x0F</td> 
   <td>COM_TIME</td> 
   <td>（内部线程状态）</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x10</td> 
   <td>COM_DELAYED_INSERT</td> 
   <td>（内部线程状态）</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x11</td> 
   <td>COM_CHANGE_USER</td> 
   <td>重新登陆（不断连接）</td> 
   <td>mysql_change_user</td> 
  </tr> 
  <tr> 
   <td>0x12</td> 
   <td>COM_BINLOG_DUMP</td> 
   <td>获取二进制日志信息</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x13</td> 
   <td>COM_TABLE_DUMP</td> 
   <td>获取数据表结构信息</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x14</td> 
   <td>COM_CONNECT_OUT</td> 
   <td>（内部线程状态）</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x15</td> 
   <td>COM_REGISTER_SLAVE</td> 
   <td>从服务器向主服务器进行注册</td> 
   <td>（无）</td> 
  </tr> 
  <tr> 
   <td>0x16</td> 
   <td>COM_STMT_PREPARE</td> 
   <td>预处理SQL语句</td> 
   <td>mysql_stmt_prepare</td> 
  </tr> 
  <tr> 
   <td>0x17</td> 
   <td>COM_STMT_EXECUTE</td> 
   <td>执行预处理语句</td> 
   <td>mysql_stmt_execute</td> 
  </tr> 
  <tr> 
   <td>0x18</td> 
   <td>COM_STMT_SEND_LONG_DATA</td> 
   <td>发送BLOB类型的数据</td> 
   <td>mysql_stmt_send_long_data</td> 
  </tr> 
  <tr> 
   <td>0x19</td> 
   <td>COM_STMT_CLOSE</td> 
   <td>销毁预处理语句</td> 
   <td>mysql_stmt_close</td> 
  </tr> 
  <tr> 
   <td>0x1A</td> 
   <td>COM_STMT_RESET</td> 
   <td>清除预处理语句参数缓存</td> 
   <td>mysql_stmt_reset</td> 
  </tr> 
  <tr> 
   <td>0x1B</td> 
   <td>COM_SET_OPTION</td> 
   <td>设置语句选项</td> 
   <td>mysql_set_server_option</td> 
  </tr> 
  <tr> 
   <td>0x1C</td> 
   <td>COM_STMT_FETCH</td> 
   <td>获取预处理语句的执行结果</td> 
   <td>mysql_stmt_fetch</td> 
  </tr> 
 </tbody> 
</table>

**参数**：内容是用户在MySQL客户端输入的命令（不包括每行命令结尾的";"分号）。另外这个字段的字符串不是以NULL字符结尾，而是通过消息头中的长度值计算而来。

例如：当我们在MySQL客户端中执行`use hutaow;`命令时（切换到`hutaow`数据库），发送的请求报文数据会是下面的样子：

0x02 0x68 0x75 0x74 0x61 0x6f 0x77

其中，`0x02`为请求类型值`COM_INIT_DB`，后面的`0x68 0x75 0x74 0x61 0x6f 0x77`为ASCII字符`hutaow`。

**COM\_QUIT 消息报文**

**功能**：关闭当前连接（客户端退出），无参数。

**COM\_INIT\_DB 消息报文**

**功能**：切换数据库，对应的SQL语句为`USE`。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>数据库名称（字符串到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_QUERY 消息报文**

**功能**：最常见的请求消息类型，当用户执行SQL语句时发送该消息。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>SQL语句（字符串到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_FIELD\_LIST 消息报文**

**功能**：查询某表的字段（列）信息，等同于SQL语句`SHOW [FULL] FIELDS FROM ...`。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>表格名称（Null-Terminated String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>字段（列）名称或通配符（可选）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_CREATE\_DB 消息报文**

**功能**：创建数据库，该消息已过时，而被SQL语句`CREATE DATABASE`代替。

**COM\_DROP\_DB 消息报文**

**功能**：删除数据库，该消息已过时，而被SQL语句`DROP DATABASE`代替。

**COM\_REFRESH 消息报文**

**功能**：清除缓存，等同于SQL语句`FLUSH`，或是执行`mysqladmin flush-foo`命令时发送该消息。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>清除缓存选项（位图方式存储，各标志位含义如下）</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x01: REFRESH_GRANT</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x02: REFRESH_LOG</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x04: REFRESH_TABLES</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x08: REFRESH_HOSTS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x10: REFRESH_STATUS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x20: REFRESH_THREADS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x40: REFRESH_SLAVE</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x80: REFRESH_MASTER</td> 
  </tr> 
 </tbody> 
</table>

**COM\_SHUTDOWN 消息报文**

**功能**：停止MySQL服务。执行`mysqladmin shutdown`命令时发送该消息。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>停止服务选项</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x00: SHUTDOWN_DEFAULT</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x01: SHUTDOWN_WAIT_CONNECTIONS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x02: SHUTDOWN_WAIT_TRANSACTIONS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x08: SHUTDOWN_WAIT_UPDATES</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x10: SHUTDOWN_WAIT_ALL_BUFFERS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x11: SHUTDOWN_WAIT_CRITICAL_BUFFERS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0xFE: KILL_QUERY</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0xFF: KILL_CONNECTION</td> 
  </tr> 
 </tbody> 
</table>

**COM\_STATISTICS 消息报文**

**功能**：查看MySQL服务的统计信息（例如运行时间、每秒查询次数等）。执行`mysqladmin status`命令时发送该消息，无参数。

**COM\_PROCESS\_INFO 消息报文**

**功能**：获取当前活动的线程（连接）列表。等同于SQL语句`SHOW PROCESSLIST`，或是执行`mysqladmin processlist`命令时发送该消息，无参数。

**COM\_PROCESS\_KILL 消息报文**

**功能**：要求服务器中断某个连接。等同于SQL语句`KILL`。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>连接ID号（小字节序）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_DEBUG 消息报文**

**功能**：要求服务器将调试信息保存下来，保存的信息多少依赖于编译选项设置（debug=no|yes|full）。执行`mysqladmin debug`命令时发送该消息，无参数。

**COM\_PING 消息报文**

**功能**：该消息用来测试连通性，同时会将服务器的无效连接（超时）计数器清零。执行`mysqladmin ping`命令时发送该消息，无参数。

**COM\_CHANGE\_USER 消息报文**

**功能**：在不断连接的情况下重新登陆，该操作会销毁MySQL服务器端的会话上下文（包括临时表、会话变量等）。有些连接池用这种方法实现清除会话上下文。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>用户名（字符串以NULL结尾）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>密码（挑战数）</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>MySQL 3.23 版本：Null-Terminated String（长度9字节）</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>MySQL 4.1 版本：Length Coded String（长度1+21字节）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据库名称（Null-Terminated String）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>字符编码</td> 
  </tr> 
 </tbody> 
</table>

**COM\_BINLOG\_DUMP 消息报文**

**功能**：该消息是备份连接时由从服务器向主服务器发送的最后一个请求，主服务器收到后，会响应一系列的报文，每个报文都包含一个二进制日志事件。如果主服务器出现故障时，会发送一个EOF报文。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>二进制日志数据的起始位置（小字节序）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>二进制日志数据标志位（目前未使用，永远为0x00）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>从服务器的服务器ID值（小字节序）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>二进制日志的文件名称（可选，默认值为主服务器上第一个有效的文件名）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_TABLE\_DUMP 消息报文**

**功能**：将数据表从主服务器复制到从服务器中，执行SQL语句`LOAD TABLE ... FROM MASTER`时发送该消息。目前该消息已过时，不再使用。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>数据库名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据表名称（Length Coded String）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_REGISTER\_SLAVE 消息报文**

**功能**：在从服务器`report_host`变量设置的情况下，当备份连接时向主服务器发送的注册消息。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>从服务器ID值（小字节序）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>主服务器IP地址（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>主服务器用户名（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>主服务器密码（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>主服务器端口号</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>安全备份级别（由MySQL服务器<code>rpl_recovery_rank</code>变量设置，暂时未使用）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>主服务器ID值（值恒为0x00）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_PREPARE 消息报文**

**功能**：预处理SQL语句，使用带有"?"占位符的SQL语句时发送该消息。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>带有"?"占位符的SQL语句（字符串到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_EXECUTE 消息报文**

**功能**：执行预处理语句。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>预处理语句的ID值</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>标志位</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x00: CURSOR_TYPE_NO_CURSOR</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x01: CURSOR_TYPE_READ_ONLY</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x02: CURSOR_TYPE_FOR_UPDATE</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>0x04: CURSOR_TYPE_SCROLLABLE</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>保留（值恒为0x01）</td> 
  </tr> 
  <tr> 
   <td>如果参数数量大于0</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>空位图（Null-Bitmap，长度 = (参数数量 + 7) / 8 字节）</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>参数分隔标志</td> 
  </tr> 
  <tr> 
   <td>如果参数分隔标志值为1</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>每个参数的类型值（长度 = 参数数量 * 2 字节）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>每个参数的值</td> 
  </tr> 
 </tbody> 
</table>

**COM\_LONG\_DATA 消息报文**

该消息报文有两种形式，一种用于发送二进制数据，另一种用于发送文本数据。

**功能**：用于发送二进制（BLOB）类型的数据（调用`mysql_stmt_send_long_data`函数）。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>预处理语句的ID值（小字节序）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>参数序号（小字节序）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据负载（数据到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**功能**：用于发送超长字符串类型的数据（调用`mysql_send_long_data`函数）

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>预处理语句的ID值（小字节序）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>参数序号（小字节序）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>数据类型（未使用）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据负载（数据到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_CLOSE\_STMT 消息报文**

**功能**：销毁预处理语句。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>预处理语句的ID值（小字节序）</td> 
  </tr> 
 </tbody> 
</table>

**COM\_RESET\_STMT 消息报文**

**功能**：将预处理语句的参数缓存清空。多数情况和`COM_LONG_DATA`一起使用。

**COM\_SET\_OPTION 消息报文**

**功能**：设置语句选项，选项值为`/include/mysql_com.h`头文件中定义的`enum_mysql_set_option`枚举类型：

*  MYSQL\_OPTION\_MULTI\_STATEMENTS\_ON
 *  MYSQL\_OPTION\_MULTI\_STATEMENTS\_OFF

**COM\_FETCH\_STMT 消息报文**

**功能**：获取预处理语句的执行结果（一次可以获取多行数据）。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>4</td> 
   <td>预处理语句的ID值（小字节序）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>数据的行数（小字节序）</td> 
  </tr> 
 </tbody> 
</table>

### 服务器响应报文（服务器 -> 客户端） ###

当客户端发起认证请求或命令请求后，服务器会返回相应的执行结果给客户端。客户端在收到响应报文后，需要首先检查第1个字节的值，来区分响应报文的类型。

<table> 
 <thead> 
  <tr> 
   <th>响应报文类型</th> 
   <th>第1个字节取值范围</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>OK 响应报文</td> 
   <td>0x00</td> 
  </tr> 
  <tr> 
   <td>Error 响应报文</td> 
   <td>0xFF</td> 
  </tr> 
  <tr> 
   <td>Result Set 报文</td> 
   <td>0x01 - 0xFA</td> 
  </tr> 
  <tr> 
   <td>Field 报文</td> 
   <td>0x01 - 0xFA</td> 
  </tr> 
  <tr> 
   <td>Row Data 报文</td> 
   <td>0x01 - 0xFA</td> 
  </tr> 
  <tr> 
   <td>EOF 报文</td> 
   <td>0xFE</td> 
  </tr> 
 </tbody> 
</table>

注：响应报文的第1个字节在不同类型中含义不同，比如在OK报文中，该字节并没有实际意义，值恒为0x00；而在Result Set报文中，该字节又是长度编码的二进制数据结构（Length Coded Binary）中的第1字节。

**响应报文**

客户端的命令执行正确时，服务器会返回OK响应报文。

**MySQL 4.0 及之前的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>OK报文，值恒为0x00</td> 
  </tr> 
  <tr> 
   <td>1-9</td> 
   <td>受影响行数（Length Coded Binary）</td> 
  </tr> 
  <tr> 
   <td>1-9</td> 
   <td>索引ID值（Length Coded Binary）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>服务器状态</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>服务器消息（字符串到达消息尾部时结束，无结束符）</td> 
  </tr> 
 </tbody> 
</table>

**MySQL 4.1 及之后的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>OK报文，值恒为0x00</td> 
  </tr> 
  <tr> 
   <td>1-9</td> 
   <td>受影响行数（Length Coded Binary）</td> 
  </tr> 
  <tr> 
   <td>1-9</td> 
   <td>索引ID值（Length Coded Binary）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>服务器状态</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>告警计数</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>服务器消息（字符串到达消息尾部时结束，无结束符，可选）</td> 
  </tr> 
 </tbody> 
</table>

**受影响行数**：当执行`INSERT`/`UPDATE`/`DELETE`语句时所影响的数据行数。

**索引ID值**：该值为`AUTO_INCREMENT`索引字段生成，如果没有索引字段，则为0x00。注意：当`INSERT`插入语句为多行数据时，该索引ID值为第一个插入的数据行索引值，而非最后一个。

**服务器状态**：客户端可以通过该值检查命令是否在事务处理中。

**告警计数**：告警发生的次数。

**服务器消息**：服务器返回给客户端的消息，一般为简单的描述性字符串，可选字段。

**响应报文**

**MySQL 4.0 及之前的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>Error报文，值恒为0xFF</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>错误编号（小字节序）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>服务器消息</td> 
  </tr> 
 </tbody> 
</table>

**MySQL 4.1 及之后的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>Error报文，值恒为0xFF</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>错误编号（小字节序）</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>服务器状态标志，恒为’#'字符</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>服务器状态（5个字符）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>服务器消息</td> 
  </tr> 
 </tbody> 
</table>

**错误编号**：错误编号值定义在源代码`/include/mysqld_error.h`头文件中。

**服务器状态**：服务器将错误编号通过`mysql_errno_to_sqlstate`函数转换为状态值，状态值由5字节的ASCII字符组成，定义在源代码`/include/sql_state.h`头文件中。

**服务器消息**：错误消息字符串到达消息尾时结束，长度可以由消息头中的长度值计算得出。消息长度为0-512字节。

**Result Set 消息**

当客户端发送查询请求后，在没有错误的情况下，服务器会返回结果集（Result Set）给客户端。

Result Set 消息分为五部分，结构如下：

<table> 
 <thead> 
  <tr> 
   <th>结构</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>[Result Set Header]</td> 
   <td>列数量</td> 
  </tr> 
  <tr> 
   <td>[Field]</td> 
   <td>列信息（多个）</td> 
  </tr> 
  <tr> 
   <td>[EOF]</td> 
   <td>列结束</td> 
  </tr> 
  <tr> 
   <td>[Row Data]</td> 
   <td>行数据（多个）</td> 
  </tr> 
  <tr> 
   <td>[EOF]</td> 
   <td>数据结束</td> 
  </tr> 
 </tbody> 
</table>

**Result Set Header 结构**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1-9</td> 
   <td>Field结构计数（Length Coded Binary）</td> 
  </tr> 
  <tr> 
   <td>1-9</td> 
   <td>额外信息（Length Coded Binary）</td> 
  </tr> 
 </tbody> 
</table>

**Field结构计数**：用于标识Field结构的数量，取值范围0x00-0xFA。

**额外信息**：可选字段，一般情况下不应该出现。只有像`SHOW COLUMNS`这种语句的执行结果才会用到额外信息（标识表格的列数量）。

**Field 结构**

Field为数据表的列信息，在Result Set中，Field会连续出现多次，次数由Result Set Header结构中的IField结构计数值决定。

**MySQL 4.0 及之前的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>数据表名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>列（字段）名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>列（字段）长度（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>列（字段）类型（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>列（字段）标志（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>整型值精度</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>默认值（Length Coded String）</td> 
  </tr> 
 </tbody> 
</table>

**MySQL 4.1 及之后的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>目录名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据库名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据表名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>数据表原始名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>列（字段）名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>列（字段）原始名称（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>填充值</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>字符编码</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>列（字段）长度</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>列（字段）类型</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>列（字段）标志</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>整型值精度</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>填充值（0x00）</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>默认值（Length Coded String）</td> 
  </tr> 
 </tbody> 
</table>

**目录名称**：在4.1及之后的版本中，该字段值为"def"。

**数据库名称**：数据库名称标识。

**数据表名称**：数据表的别名（`AS`之后的名称）。

**数据表原始名称**：数据表的原始名称（`AS`之前的名称）。

**列（字段）名称**：列（字段）的别名（`AS`之后的名称）。

**列（字段）原始名称**：列（字段）的原始名称（`AS`之前的名称）。

**字符编码**：列（字段）的字符编码值。

**列（字段）长度**：列（字段）的长度值，真实长度可能小于该值，例如`VARCHAR(2)`类型的字段实际只能存储1个字符。

**列（字段）类型**：列（字段）的类型值，取值范围如下（参考源代码`/include/mysql_com.h`头文件中的`enum_field_type`枚举类型定义）：

<table> 
 <thead> 
  <tr> 
   <th>类型值</th> 
   <th>名称</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0x00</td> 
   <td>FIELD_TYPE_DECIMAL</td> 
  </tr> 
  <tr> 
   <td>0x01</td> 
   <td>FIELD_TYPE_TINY</td> 
  </tr> 
  <tr> 
   <td>0x02</td> 
   <td>FIELD_TYPE_SHORT</td> 
  </tr> 
  <tr> 
   <td>0x03</td> 
   <td>FIELD_TYPE_LONG</td> 
  </tr> 
  <tr> 
   <td>0x04</td> 
   <td>FIELD_TYPE_FLOAT</td> 
  </tr> 
  <tr> 
   <td>0x05</td> 
   <td>FIELD_TYPE_DOUBLE</td> 
  </tr> 
  <tr> 
   <td>0x06</td> 
   <td>FIELD_TYPE_NULL</td> 
  </tr> 
  <tr> 
   <td>0x07</td> 
   <td>FIELD_TYPE_TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>0x08</td> 
   <td>FIELD_TYPE_LONGLONG</td> 
  </tr> 
  <tr> 
   <td>0x09</td> 
   <td>FIELD_TYPE_INT24</td> 
  </tr> 
  <tr> 
   <td>0x0A</td> 
   <td>FIELD_TYPE_DATE</td> 
  </tr> 
  <tr> 
   <td>0x0B</td> 
   <td>FIELD_TYPE_TIME</td> 
  </tr> 
  <tr> 
   <td>0x0C</td> 
   <td>FIELD_TYPE_DATETIME</td> 
  </tr> 
  <tr> 
   <td>0x0D</td> 
   <td>FIELD_TYPE_YEAR</td> 
  </tr> 
  <tr> 
   <td>0x0E</td> 
   <td>FIELD_TYPE_NEWDATE</td> 
  </tr> 
  <tr> 
   <td>0x0F</td> 
   <td>FIELD_TYPE_VARCHAR (new in MySQL 5.0)</td> 
  </tr> 
  <tr> 
   <td>0x10</td> 
   <td>FIELD_TYPE_BIT (new in MySQL 5.0)</td> 
  </tr> 
  <tr> 
   <td>0xF6</td> 
   <td>FIELD_TYPE_NEWDECIMAL (new in MYSQL 5.0)</td> 
  </tr> 
  <tr> 
   <td>0xF7</td> 
   <td>FIELD_TYPE_ENUM</td> 
  </tr> 
  <tr> 
   <td>0xF8</td> 
   <td>FIELD_TYPE_SET</td> 
  </tr> 
  <tr> 
   <td>0xF9</td> 
   <td>FIELD_TYPE_TINY_BLOB</td> 
  </tr> 
  <tr> 
   <td>0xFA</td> 
   <td>FIELD_TYPE_MEDIUM_BLOB</td> 
  </tr> 
  <tr> 
   <td>0xFB</td> 
   <td>FIELD_TYPE_LONG_BLOB</td> 
  </tr> 
  <tr> 
   <td>0xFC</td> 
   <td>FIELD_TYPE_BLOB</td> 
  </tr> 
  <tr> 
   <td>0xFD</td> 
   <td>FIELD_TYPE_VAR_STRING</td> 
  </tr> 
  <tr> 
   <td>0xFE</td> 
   <td>FIELD_TYPE_STRING</td> 
  </tr> 
  <tr> 
   <td>0xFF</td> 
   <td>FIELD_TYPE_GEOMETRY</td> 
  </tr> 
 </tbody> 
</table>

**列（字段）标志**：各标志位定义如下（参考源代码`/include/mysql_com.h`头文件中的宏定义）：

<table> 
 <thead> 
  <tr> 
   <th>标志位</th> 
   <th>名称</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0x0001</td> 
   <td>NOT_NULL_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0002</td> 
   <td>PRI_KEY_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0004</td> 
   <td>UNIQUE_KEY_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0008</td> 
   <td>MULTIPLE_KEY_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0010</td> 
   <td>BLOB_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0020</td> 
   <td>UNSIGNED_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0040</td> 
   <td>ZEROFILL_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0080</td> 
   <td>BINARY_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0100</td> 
   <td>ENUM_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0200</td> 
   <td>AUTO_INCREMENT_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0400</td> 
   <td>TIMESTAMP_FLAG</td> 
  </tr> 
  <tr> 
   <td>0x0800</td> 
   <td>SET_FLAG</td> 
  </tr> 
 </tbody> 
</table>

**数值精度**：该字段对`DECIMAL`和`NUMERIC`类型的数值字段有效，用于标识数值的精度（小数点位置）。

**默认值**：该字段用在数据表定义中，普通的查询结果中不会出现。

**附**：Field结构的相关处理函数：

*  客户端：`/client/client.c`源文件中的`unpack_fields`函数
 *  服务器：`/sql/sql_base.cc`源文件中的`send_fields`函数

**EOF 结构**

EOF结构用于标识Field和Row Data的结束，在预处理语句中，EOF也被用来标识参数的结束。

**MySQL 4.0 及之前的版本**

**MySQL 4.1 及之后的版本**

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>EOF值（0xFE）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>告警计数</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>状态标志位</td> 
  </tr> 
 </tbody> 
</table>

**告警计数**：服务器告警数量，在所有数据都发送给客户端后该值才有效。

**状态标志位**：包含类似`SERVER_MORE_RESULTS_EXISTS`这样的标志位。

**注**：由于EOF值与其它Result Set结构共用1字节，所以在收到报文后需要对EOF包的真实性进行校验，校验条件为：

*  第1字节值为0xFE
 *  包长度小于9字节

**附**：EOF结构的相关处理函数：

*  服务器：`protocol.cc`源文件中的`send_eof`函数

**Row Data 结构**

在Result Set消息中，会包含多个Row Data结构，每个Row Data结构又包含多个字段值，这些字段值组成一行数据。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>n</td> 
   <td>字段值（Length Coded String）</td> 
  </tr> 
  <tr> 
   <td>…</td> 
   <td>（一行数据中包含多个字段值）</td> 
  </tr> 
 </tbody> 
</table>

**字段值**：行数据中的字段值，字符串形式。

**附**：Row Data结构的相关处理函数：

*  客户端：`/client/client.c`源文件中的`read_rows`函数

**Row Data 结构（二进制数据）**

该结构用于传输二进制的字段值，既可以是服务器返回的结果，也可以是由客户端发送的（当执行预处理语句时，客户端使用Result Set消息来发送参数及数据）。

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>结构头（0x00）</td> 
  </tr> 
  <tr> 
   <td>(列数量 + 7 + 2) / 8</td> 
   <td>空位图</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>字段值</td> 
  </tr> 
  <tr> 
   <td>…</td> 
   <td>（一行数据中包含多个字段值）</td> 
  </tr> 
 </tbody> 
</table>

**空位图**：前2个比特位被保留，值分别为0和1，以保证不会和OK、Error包的首字节冲突。在MySQL 5.0及之后的版本中，这2个比特位的值都为0。

**字段值**：行数据中的字段值，二进制形式。

**PREPARE\_OK 响应报文（Prepared Statement）**

用于响应客户端发起的预处理语句报文，组成结构如下：

<table> 
 <thead> 
  <tr> 
   <th>结构</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>[PREPARE_OK]</td> 
   <td>PREPARE_OK结构</td> 
  </tr> 
  <tr> 
   <td>如果参数数量大于0</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>[Field]</td> 
   <td>与Result Set消息结构相同</td> 
  </tr> 
  <tr> 
   <td>[EOF]</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>如果列数大于0</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>[Field]</td> 
   <td>与Result Set消息结构相同</td> 
  </tr> 
  <tr> 
   <td>[EOF]</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

其中 PREPARD\_OK 的结构如下：

<table> 
 <thead> 
  <tr> 
   <th>字节</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>OK报文，值为0x00</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>预处理语句ID值</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>列数量</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>参数数量</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>填充值（0x00）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>告警计数</td> 
  </tr> 
 </tbody> 
</table>

**Parameter 响应报文（Prepared Statement）**

预处理语句的值与参数正确对应后，服务器会返回 Parameter 报文。

**类型**：与 Field 结构中的字段类型相同。

**标志**：与 Field 结构中的字段标志相同。

**数值精度**：与 Field 结构中的数值精度相同。

**字段长度**：与 Field 结构中的字段长度相同。

## 代码分析 ##

议程
    协议头
    协议类型 网络协议相关函数 NET缓冲 VIO缓冲 MySQL API

**协议头**

● 数据变成在网络里传输的数据,需要额外的在头部添加4 个字节的包头.

. packet length(3字节), 包体的长度

. packet number(1字节), 从0开始的递增的

● sql “select 1” 的网络协议是？

**协议头**

● packet length三个字节意味着MySQL packet最大16M大于16M则被分包(net\_write\_command, my\_net\_write)

● packet number分包从0开始,依次递增.每一次执行sql, packet\_number清零(sql/net\_serv.c:net\_clear)

**协议类型**

● handshake

● auth

● ok|error

● resultset

○ header

○ field

○ eof

○ row

● command packet

**连接时的交互**

**协议说明**

● 协议内字段分三种形式

○ 固定长度(include/my\_global.h)

■ uint\*korr 解包 \*

■ int\*store 封包

○ length coded binary(sql-common/pack.c)

■ net\_field\_length 解包

■ net\_store\_length 封包

○ null-terminated string

● length coded binary

○ 避免binary unsafe string, 字符串的长度保存在字符串的前面

■ length<251 1 byte

■ length <256^2 3 byte(第一个byte是252)

■ length<256^3 4byte(第一个byte是253)

■ else 9byte(第一个byte是254)

**handshake packet**

● 该协议由服务端发送客户端

● 括号内为字节数,字节数为n为是null-terminated string;字节数为大写的N表示length code binary.

● salt就是scramble.分成两个部分是为了兼容4.1版本

● sql\_connect.cc:check\_connection

● sql\_client.c:mysql\_real\_connect

**auth packet**

● 该协议是从客户端对密码使用scramble加密后发送到服务端

● 其中databasename是可选的.salt就是加密后的密码.

● sql\_client.c:mysql\_real\_connect

● sql\_connect.c:check\_connection

**ok packet**

● ok包,命令和insert,update,delete的返回结果

● 包体首字节为0.

● insert\_id, affect\_rows也是一并发过来.

● src/protocol.cc:net\_send\_ok

**error packet**

● 错误的命令,非法的sql的返回包

● 包体首字节为255.

● error code就是CR\_\*\*\*,include/errmsg.h  
● sqlstate marker是\#

● sqlstate是错误状态,include/sql\_state.h

● message是错误的信息

● sql/protocol.cc:net\_send\_error\_packet

**resultset packet**

● 结果集的数据包,由多个packet组合而成

● 例如查询一个结构集,顺序如下:  
○ header  
○ field1…fieldN  
○ eof  
○ row1…rowN  
○ eof

● sql/client.c:cli\_read\_query\_result

● 下面是一个sql "select \* from d"查询结果集的例子,结果 集是6行，3个字段  
○ 公式：假设结果集有N行, M个字段.则包的个数为，header(1) + field (M) + eof(1) + row(N) + eof(1)  
○ 所以这个例子的MySQL packet的个数是12个

**resultset packet - header**

● field packet number决定了接下来的field packet的个数.

● 一个返回6行记录,3个字段的查询语句

**resultset packet - field**

● 结果集中一个字段一个field packet.

● tables\_alias是sql语句里表的别名,org\_table才是表的真 实名字.

● sql/protocol.cc:Protocol::send\_fields

● sql/client.c:cli\_read\_query\_result

**resultset packet - eof**

● eof包是用于分割field packet和row packet.

● 包体首字节为254

● sql/protocol.cc:net\_send\_eof

**resultset packet - row**

● row packet里才是真正的数据包.一行数据一个packet.

● row里的每个字段都是length coded binary

● 字段的个数在header packet里

● sql/client.c:cli\_read\_rows

**command packet**

● 命令包,包括我们的sql语句还有一些常见的命令.

● 包体首字母表示命令的类型(include/mysql\_com.h),大 部分命令都是COM\_QUERY.

**网络协议关键函数**

● net\_write\_command(sql/net\_serv.cc)所有的sql最终调用这个命令发送出去.

● my\_net\_write(sql/net\_serv.cc)连接阶段的socket write操作调用这个函数.

● my\_net\_read读取包,会判断包大小,是否是分包

● my\_real\_read解析MySQL packet,第一次读取4字节,根据packet length再读取余下来的长度

● cli\_safe\_read客户端解包函数,包含了my\_net\_read

**NET缓冲**

● 每次socket操作都会先把数据写,读到net->buff,这是一 个缓冲区, 减少系统调用调用的次数.

● 当写入的数据和buff内的数据超过buff大小才会发出一次 write操作,然后再把要写入的buff里插入数, 写入不会 导致buff区区域扩展.(sql/net\_serv.cc: net\_write\_buff).

● net->buff大小初始net->max\_packet, 读取会导致会导致 buff的realloc最大net->max\_packet\_size

● 一次sql命令的结束都会调用net\_flush,把buff里的数据 都写到socket里.

**VIO缓冲**

● 从my\_read\_read可以看出每次packet读取都是按需读取， 为了减少系统调用,vio层面加了一个read\_buffer.

● 每次读取前先判断vio->read\_buffer所需数据的长度是 否足够.如果存在则直接copy. 如果不够,则触发一次 socket read 读取2048个字(vio/viosocket.c: vio\_read\_buff)

**MySQL API**

● 数据从mysql\_send\_query处发送给服务端,实际调用的是 net\_write\_command.

● cli\_read\_query\_result解析header packet, field packet,获 得field\_count的个数

● mysql\_store\_result解析了row packet,并存储在result- >data里

● myql\_fetch\_row其实遍历result->data

**PACKET NUMBER**

在做proxy的时候在这里迷糊过,翻了几遍代码才搞明白，细节如下： 客户端服务端的net->pkt\_nr都从0开始.接受包时比较packet number 和net->pkt\_nr是否相等,否则报packet number乱序,连接报错;相等则pkt\_nr自增.发送包时把net->pkt\_nr作为packet number发送,然后对net->pkt\_nr进行自增保持和对端的同步.

**接收包**

sql/net_serv.c:my_real_read
         if (net->buff[net->where_b + 3] != (uchar) net->pkt_nr)

**发送包**

sql/net_serv.c:my_net_write
       int3store(buff,len);
       buff[3]= (uchar) net->pkt_nr++;

我们来几个具体场景的packet number, net->pkt\_nr的变化

**连接**

c ———–> s 0  connect
     c <—-0——s 1  handshake
     c —–1—–>s 1  auth
     c <—–2——s 0  ok

开始两方都为0,服务端发送handshake packet(pkt=0)之后自增为1,然后等待对端发送过来pkt=1的包

**查询**

每次查询,服务客户端都会对net->pkt\_nr进行清零

include/mysql_com.h
     #define net_new_transaction(net) ((net)->pkt_nr=0)
    sql/sql_parse.cc:do_command
       net_new_transaction(net);
    sql/client.c:cli_advanced_command
       net_clear(&mysql->net, (command != COM_QUIT));

开始两方net->pkt\_nr皆为0, 命令发送后客户端端为1,服务端开始发送分包,分包的pkt\_nr的依次递增,客户端的net->pkt\_nr也随之增加.

c ——0—–> s 0  query
     c <—-1——s 2  resultset
     c <—-2——s 3  resultset

**解包的细节**

my\_net\_read负责解包，首先读取4个字节，判断packet number是否等于net->pkt\_nr然后再次读取packet\_number长度的包体。

伪代码如下：

remain=4
    for(i = 0; i < 2; i++) {
        //数据是否读完
        while (remain>0)  {
            length = read(fd, net->buff, remain)
            remain = remain - length
        }
        //第一次
        if (i=0) {
            remain = uint3korr(net->buff+net->where_b);
        }
    }

**网络层优化**

从ppt里可以看到,一个resultset packet由多个包组成,如果每次读写包都导致系统调用那肯定是不合理,常规优化方法:写大包加预读

**NET->BUFF**

每个包发送到网络或者从网络读包都会先把数据包保存在net->buff里,待到net->buff满了或者一次命令结束才会通过socket发出给对端.net->buff有个初始大小(net->max\_packet),会随读取数据的增多而扩展.

**VIO->READ\_BUFFER**

每次从网络读包,并不是按包的大小读取,而是会尽量读取2048个字节,这样一个resultset包的读取不会再引起多次的系统调用了.header packet读取完毕后, 接下来的field,eof, row apcket读取仅仅需要从vio-read\_buffer拷贝指定字节的数据即可.

**MYSQL API说明**

api和MySQL客户端都会使用sql/client.c这个文件,解包的过程都是使用sql/client.c:cli\_read\_query\_result.

mysql\_store\_result来解析row packet,并把数据存储到res->data里,此时所有数据都存内存里了.

mysql\_fetch\_row仅仅是使用内部的游标,遍历result->data里的数据

if (!res->data_cursor)
    {
        DBUG_PRINT("info",("end of data"));
        DBUG_RETURN(res->current_row=(MYSQL_ROW) NULL);
    }
    tmp = res->data_cursor->data;
    res->data_cursor = res->data_cursor->next;
    DBUG_RETURN(res->current_row=tmp);

mysql\_free\_result是把result->data指定的行数据释放掉.

[e7a84d24b1a2342ebcc186ed3138c5ec.png]: /images/20210901/e80f5f32a41f42c7b5bf058be677fef7.png
[f98839fd0611dcfc8b3b878e81cc42f2.png]: /images/20210901/2821b9ec57074ac687c6f6444033daf1.png
[d0e287ac6b443c809ae4ea491bbdb505.png]: /images/20210901/0abef90f922f497ab205f2ff6400a048.png
[5e0f75b90a72a3a901339ec60e562f9b.png]: /images/20210901/58422188136b4dfd85925dc45a1a8ca0.png
[6a5ffe611bced954532104eb49acb437.png]: /images/20210901/529658d4a0dc4b2ea20e490163d9549a.png