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

注：部分来自于互联网，感谢数据库大牛前辈们的默默付出！

交互过程

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

握手认证阶段

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

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

命令执行阶段

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

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

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

基本类型

整型值

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

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

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

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

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

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

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

报文结构

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

消息头

报文长度

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

序号

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

消息体

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

报文类型

登陆认证交互报文

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

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

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

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

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

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

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

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

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

MySQL 4.0 及之前的版本

MySQL 4.1 及之后的版本

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

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

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

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

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

数据库名称：当客户端的权能标志为 CLIENT_CONNECT_WITH_DB 被置位时，该字段必须出现。

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

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

参数：内容是用户在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。

COM_QUERY 消息报文

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

COM_FIELD_LIST 消息报文

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

COM_CREATE_DB 消息报文

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

COM_DROP_DB 消息报文

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

COM_REFRESH 消息报文

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

COM_SHUTDOWN 消息报文

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

COM_STATISTICS 消息报文

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

COM_PROCESS_INFO 消息报文

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

COM_PROCESS_KILL 消息报文

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

COM_DEBUG 消息报文

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

COM_PING 消息报文

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

COM_CHANGE_USER 消息报文

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

COM_BINLOG_DUMP 消息报文

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

COM_TABLE_DUMP 消息报文

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

COM_REGISTER_SLAVE 消息报文

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

COM_PREPARE 消息报文

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

COM_EXECUTE 消息报文

功能：执行预处理语句。

COM_LONG_DATA 消息报文

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

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

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

COM_CLOSE_STMT 消息报文

功能：销毁预处理语句。

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 消息报文

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

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

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

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

响应报文

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

MySQL 4.0 及之前的版本

MySQL 4.1 及之后的版本

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

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

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

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

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

响应报文

MySQL 4.0 及之前的版本

MySQL 4.1 及之后的版本

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

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

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

Result Set 消息

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

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

Result Set Header 结构

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

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

Field 结构

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

MySQL 4.0 及之前的版本

MySQL 4.1 及之后的版本

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

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

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

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

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

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

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

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

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

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

数值精度：该字段对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 及之后的版本

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

状态标志位：包含类似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结构又包含多个字段值，这些字段值组成一行数据。

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

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

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

Row Data 结构（二进制数据）

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

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

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

PREPARE_OK 响应报文（Prepared Statement）

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

其中 PREPARD_OK 的结构如下：

Parameter 响应报文（Prepared Statement）

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

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

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

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

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

代码分析

协议头

● 数据变成在网络里传输的数据,需要额外的在头部添加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进行自动保持和对端的同步.

接收包