聊聊 MySQL Server 可執(zhí)行注釋，你懂了嗎？
前言
MySQL Server當前支持如下3種注釋風格：
- 以'#'開頭的單行注釋
- 以'-- '開頭的單行注釋
- C語言風格的單行/多行注釋
如下SQL腳本給出了3種注釋風格的示例：
/* 這是一個
多行注釋
示例
*/
select 1 from dual;
select 2 from dual; # 單行注釋用例1
select 3 from dual; -- 單行注釋用例2
可執(zhí)行注釋
為了支持在不同數(shù)據(jù)庫之間的可移植性，MySQL Server針對C風格的注釋在解析上做了一些擴展，當注釋滿足如下風格時，MySQL Server將會解析并執(zhí)行注釋中的代碼：
/*! MySQL-specific code */通過比較如下兩個帶注釋的SQL語句的執(zhí)行結果可以比較直觀地看出可執(zhí)行注釋語句的行為：
# 普通注釋，'+1' 被忽略
mysql> select 1 /* +1 */;
+---+
| 1 |
+---+
| 1 |
+---+
# 可執(zhí)行注釋，'+1' 被當成語句的一部分
mysql> select 1 /*! +1 */;
+-------+
| 1 +1 |
+-------+
| 2 |
+-------+
借助這一特性，我們就有機會編寫具備較好移植性的SQL語句, 在使用MySQL獨有特性的同時，保證了SQL語句在其它數(shù)據(jù)庫也能夠成功被執(zhí)行：
create table t1（col1 int） /*! engine=MyISAM */;
select /*! STRAIGHT_JOIN */ col1 from t1;
...
/*!version-number SQL*/
在日常使用中，我們還會經(jīng)?？吹饺缦赂袷降淖⑨屨Z句：
/*!50003 SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE */
/*!80000 SET SESSION information_schema_stats_expiry=0 */
/*!50013 DEFINER=`root`@`localhost` SQL SECURITY DEFINER */
/*!后跟的5位數(shù)字為版本指示器，其與數(shù)據(jù)庫版本的對應規(guī)則為：
'/' '*' '!', followed by exactly
第1位：主版本號(VERSION_MAJOR),
第2, 3位：小版本號(VERSION_MINOR),
第4, 5位：Patch號(VERSION_PATCH)
示例：
32302 -> 3.23.02
50738 -> 5.7.38
80025 -> 8.0.25
以上述第一個注釋語句為例，它的含義可以描述為：當MySQL數(shù)據(jù)庫版本為5.0.3或更高版本時，將SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE讀取出來參與SQL語法解析，并最終被執(zhí)行；當MySQL版本低于5.0.3時，該行語句被當成一個普通的注釋。不難看出，帶version_number的可執(zhí)行注釋，是為了解決不同的MySQL版本之間的兼容問題。以8.0.23版本新增的Invisible Columnsw為例, 如下建表語句在8.0.23版本之前將無法執(zhí)行：
CREATE TABLE t1 (i INT, j DATE INVISIBLE);
如下的語句改造則保證了建表語句的向下版本兼容：
CREATE TABLE t1 (i INT, j DATE /*!80023 INVISIBLE */);
實際上，在我們常用的工具mysqldump也借用這個特性，使得產(chǎn)生的SQL能夠兼容不同的數(shù)據(jù)庫版本：
/*mysqldump 代碼片段*/
dump_fputs(
sql_file,
"/*!50717 SELECT COUNT(*) INTO @rocksdb_has_p_s_session_variables"
" FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA ="
" 'performance_schema' AND TABLE_NAME = 'session_variables'"
" */;\n"
"/*!50717 SET @rocksdb_get_is_supported = IF"
" (@rocksdb_has_p_s_session_variables, 'SELECT COUNT(*) INTO"
" @rocksdb_is_supported FROM performance_schema.session_variables"
" WHERE VARIABLE_NAME=\\'rocksdb_bulk_load\\'', 'SELECT 0') */;\n"
"/*!50717 PREPARE s FROM @rocksdb_get_is_supported */;\n"
"/*!50717 EXECUTE s */;\n"
"/*!50717 DEALLOCATE PREPARE s */;\n"
"/*!50717 SET @rocksdb_enable_bulk_load = IF"
" (@rocksdb_is_supported, 'SET SESSION rocksdb_bulk_load = 1',"
" 'SET @rocksdb_dummy_bulk_load = 0') */;\n"
"/*!50717 PREPARE s FROM @rocksdb_enable_bulk_load */;\n"
"/*!50717 EXECUTE s */;\n"
"/*!50717 DEALLOCATE PREPARE s */;\n");
check_io(sql_file);
在show create table等語句中我們也能看到類似的應用(sql/sql_show.cc)：
mysql> create table t1 (i int, j date invisible);
Query OK, 0 rows affected (0.03 sec)
mysql> show create table t1;
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table | Create Table |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| t1 | CREATE TABLE `t1` (
`i` int DEFAULT NULL,
`j` date DEFAULT NULL /*!80023 INVISIBLE */
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.01 sec)
結語
MySQL Server提供的可執(zhí)行注釋功能，在橫向跨數(shù)據(jù)庫和縱向跨版本兼容上都為數(shù)據(jù)庫用戶提供了較大支持，是一個比較便利的特性。功能實現(xiàn)上，MySQL Server是在詞法解析階段先對語句做了一遍攔截，針對/*!按具體情況做了特殊處理，如有興趣您可以參考MySQL的詞法解析相關源碼。注：以8.0.25版本為例，它的相關解析放在sql_lex.cc的lex_one_token()中，在其中您也能看見MySQL詞法解析器是怎么對optimizer hints comments(格式: /*+ optimizer_hints */ ）進行處理的。
