萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 資料庫 >> MySQL 教學

Golang cgo 調用 MySQL C 庫完整實戰:從編譯到查詢的兩種模式

前言

Go 標準庫 database/sql + go-sql-driver/mysql 已足夠應對絕大多數場景。但在以下情況需直接調用 C 庫:

  • 嵌入式環境,需靜態鏈接 libmysqlclient 減少依賴。
  • 調用 MySQL C API 獨有功能(如 mysql_options(MYSQL_READ_DEFAULT_GROUP)、mysql_stmt_* 底層預處理)。
  • 既有 C/C++ 代碼庫遷移,需複用邏輯。

本文基於 macOS (Darwin) 環境,展示兩種模式:純 C 封裝函數 與 Go 直接調用 C API。

環境準備

# macOS 安裝 MySQL 客戶端庫
brew install mysql-client

# 確認頭文件與庫路徑
ls /usr/local/opt/mysql-client/include/mysql.h
ls /usr/local/opt/mysql-client/lib/libmysqlclient.dylib

模式一:封裝 C 函數,Go 僅調用入口

所有 MySQL 邏輯寫在 C 函數 get_mysql_query() 中,Go 只負責啟動。

package main

/*
#cgo darwin CFLAGS: -I/usr/local/opt/mysql-client/include
#cgo darwin LDFLAGS: -L/usr/local/opt/mysql-client/lib -lmysqlclient

#include 
#include 
#include 

void get_mysql_query() {
    MYSQL *mysql = mysql_init(NULL);
    mysql_options(mysql, MYSQL_READ_DEFAULT_GROUP, "libmysqld_client");

    MYSQL *conn = mysql_real_connect(mysql, "127.0.0.1", "root", "password", "myblog", 0, NULL, 0);
    if (!conn) {
        fprintf(stderr, "Connect failed: %s\n", mysql_error(mysql));
        exit(1);
    }

    if (mysql_query(conn, "SELECT * FROM wp_users")) {
        fprintf(stderr, "Query failed: %s\n", mysql_error(conn));
        exit(1);
    }

    MYSQL_RES *result = mysql_store_result(conn);
    if (!result) {
        fprintf(stderr, "Store result failed: %s\n", mysql_error(conn));
        exit(1);
    }

    int num_fields = mysql_num_fields(result);
    MYSQL_ROW row;
    MYSQL_FIELD *field;

    while ((row = mysql_fetch_row(result))) {
        for (int i = 0; i < num_fields; i++) {
            field = mysql_fetch_field_direct(result, i);
            if (field) {
                printf("field_name: %s, field_value: %s\n", field->name, row[i] ? row[i] : "NULL");
            }
        }
    }

    mysql_free_result(result);
    mysql_close(conn);
    mysql_library_end();
}
*/
import "C"
import "fmt"

func main() {
    fmt.Println("=== 呼叫 C 封裝函數查詢 ===")
    C.get_mysql_query()
}

模式二:Go 直接操作 MySQL C API(更靈活)

在 Go 中逐步調用 mysql_init、mysql_real_connect、mysql_query 等,需處理指針轉換與記憶體管理。

package main

/*
#cgo darwin CFLAGS: -I/usr/local/opt/mysql-client/include
#cgo darwin LDFLAGS: -L/usr/local/opt/mysql-client/lib -lmysqlclient

#include 
#include 
*/
import "C"
import (
    "fmt"
    "unsafe"
)

const maxSize = 1 << 20 // 1M 足夠應對字段名/值長度

func main() {
    // 1. 初始化
    mysql := C.mysql_init(nil)
    if mysql == nil {
        panic("mysql_init failed")
    }
    defer C.mysql_close(mysql)
    defer C.mysql_library_end()

    // 2. 連接
    host := C.CString("127.0.0.1")
    user := C.CString("root")
    pass := C.CString("password")
    db := C.CString("myblog")
    defer C.free(unsafe.Pointer(host))
    defer C.free(unsafe.Pointer(user))
    defer C.free(unsafe.Pointer(pass))
    defer C.free(unsafe.Pointer(db))

    conn := C.mysql_real_connect(mysql, host, user, pass, db, 0, nil, 0)
    if conn == nil {
        err := C.GoString(C.mysql_error(mysql))
        panic("connect failed: " + err)
    }

    // 3. 查詢
    query := C.CString("SELECT * FROM wp_users")
    defer C.free(unsafe.Pointer(query))
    if C.mysql_query(conn, query) != 0 {
        err := C.GoString(C.mysql_error(conn))
        panic("query failed: " + err)
    }

    // 4. 獲取結果集
    result := C.mysql_store_result(conn)
    if result == nil {
        err := C.GoString(C.mysql_error(conn))
        panic("store_result failed: " + err)
    }
    defer C.mysql_free_result(result)

    numFields := int(C.mysql_num_fields(result))
    if numFields == 0 {
        fmt.Println("無結果集")
        return
    }

    // 5. 取得字段元資料(需在 fetch_row 前)
    fields := C.mysql_fetch_fields(result)
    // fields 是 MYSQL_FIELD* 陣列,長度 numFields

    // 6. 取得字段長度指針陣列
    lengths := C.mysql_fetch_lengths(result)
    // lengths 是 unsigned long* 陣列

    // 7. 逐行讀取
    for {
        row := C.mysql_fetch_row(result)
        if row == nil {
            break // 讀完
        }
        // row 是 **char 陣列,長度 numFields
        rowPtr := (*[maxSize]*C.char)(unsafe.Pointer(row))
        lenPtr := (*[maxSize]C.ulong)(unsafe.Pointer(lengths))
        fieldPtr := (*[maxSize]C.MYSQL_FIELD)(unsafe.Pointer(fields))

        for i := 0; i < numFields; i++ {
            fname := C.GoStringN(fieldPtr[i].name, C.int(fieldPtr[i].name_length))
            var fval string
            if rowPtr[i] != nil {
                fval = C.GoStringN(rowPtr[i], C.int(lenPtr[i]))
            } else {
                fval = "NULL"
            }
            fmt.Printf("field_name: %s, field_value: %s\n", fname, fval)
        }
    }
}

關鍵技術點總結

項目說明
cgo 指令獨立行import "C" 必須單獨一行,前方註釋區塊不可有空行隔開
無 C.NULLGo 中用 nil 對應 C 的 NULL 指針
字串轉換C.CString() 配合 defer C.free(unsafe.Pointer(s)) 防止洩漏
指針轉切片用 (*[maxSize]T)(unsafe.Pointer(ptr)) 將 C 陣列映射為 Go 可索引結構
mysql_fetch_fields vs mysql_fetch_field前者一次取得所有字段陣列,後者逐個迭代;Go 中推薦前者配合 unsafe.Pointer 批次處理
編譯標籤跨平台建構時用 // +build linux,darwin 區分 #cgo LDFLAGS

編譯與執行

# 設定 CGO 路徑(視實際安裝位置調整)
export CGO_CFLAGS="-I/usr/local/opt/mysql-client/include"
export CGO_LDFLAGS="-L/usr/local/opt/mysql-client/lib -lmysqlclient"

go build -o mysql_cgo_demo main.go
./mysql_cgo_demo

避坑指南

  • 多執行緒安全: libmysqlclient 非執行緒安全,Go 協程並發調用需加鎖或使用連接池。
  • 記憶體洩漏: 每個 C.CString 必須 C.free;mysql_store_result 必須 mysql_free_result。
  • 編碼一致性: 連接時指定 SET NAMES utf8mb4,或在 my.cnf 設定 default-character-set=utf8mb4。
  • 靜態鏈接: CGO_LDFLAGS="-static -lmysqlclient" 可產出無動態依賴的二進制,但需注意 glibc 版本相容性。
copyright © 萬盛學電腦網 all rights reserved