Windows 上開發 MySQL UDF (User-Defined Function)：Visual C++ 專案建置完整步驟

MySQL UDF 允許以 C/C++ 擴充伺服器功能。Windows 版需建置 DLL，本文記錄 Visual C++ 6.0/Visual Studio 專案建置完整流程。

開發環境需求

• Visual C++ 6.0 或 Visual Studio (含 C++ 桌面開發工作負載)。
• MySQL 原始碼套件 (含 include 目錄、libmysql.lib)。
• MySQL 服務正在執行 (測試用)。

專案建立步驟 (VC++ 6.0 經典流程)

1. 開啟 mysqld.dsw 工作區 (或建立新方案)。
2. 新增專案：Win32 Dynamic-Link Library，名稱 my_udf → An Empty DLL Project。
3. 新增 my_udf.cpp：

#include 
#include 
#include 

extern "C" {
  char *my_name(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error);
}

char *my_name(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error) {
  char *me = "my name";
  return me;
}

4. 新增模組定義檔 my_udf.def：

LIBRARY UDF_EXAMPLE
DESCRIPTION 'Example Using UDF with VC'
VERSION 1.0
EXPORTS
  my_name

5. 專案屬性設定：
   • C/C++ → General → Additional Include Directories：加入 MySQL include 目錄路徑 (如 ..\include)。
   • C/C++ → Preprocessor → Preprocessor Definitions：加入 HAVE_DLOPEN。
   • Linker → General → Output File：my_udf.dll。
6. 建置 (F7) 產生 my_udf.dll。
7. 部署：複製 my_udf.dll 至系統路徑目錄 (如 C:\Windows\System32 或 MySQL bin 目錄)。
8. 註冊 UDF：

mysql> CREATE FUNCTION my_name RETURNS STRING SONAME 'my_udf.dll';
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT my_name();
+-----------+
| my_name() |
+-----------+
| my name   |
+-----------+

關鍵結構體說明

完整 UDF 生命週期函數

my_bool my_name_init(UDF_INIT *initid, UDF_ARGS *args, char *message) {
  if (args->arg_count != 0) { strcpy(message, "my_name() takes no arguments"); return 1; }
  initid->max_length = 20;
  return 0;
}

void my_name_deinit(UDF_INIT *initid) {
  // 釋放 initid->ptr 分配的記憶體
}

char *my_name(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error) {
  return "my name";
}

註冊時：CREATE FUNCTION my_name RETURNS STRING SONAME 'my_udf.dll' 會自動呼叫 _init/_deinit (若存在)。

現代建議 (2024+)

• 使用 CMake + Visual Studio 2022 建置，支援 x64、Debug/Release 配置。
• MySQL 8.0+ 建議開發元件/服務 (Component/Service) 或負載函數 替代傳統 UDF，隔離度更高、不易導致伺服器崩潰。
• 測試時啟用 --skip-grant-tables 並加載 plugin_dir 指定目錄，避免污染生產環境。