C语言如何连接MySQL数据库API？

目录

1. 概述: 什么是 MySQL C API？为什么使用它？
2. 环境准备: 如何安装和配置开发环境。
3. 核心概念与流程: 连接、执行、获取结果、断开连接的基本步骤。
4. 关键 API 函数详解: 连接、执行、结果处理等核心函数。
5. 完整代码示例: 一个简单的 C 程序，实现连接、查询和打印结果。
6. 最佳实践与注意事项: 错误处理、资源释放、预处理语句等。
7. 替代方案: 为什么以及何时考虑其他库？

MySQL C API 是一组函数，允许 C/C++ 程序与 MySQL 数据库服务器进行交互，它是 MySQL 客户端工具（如 mysql, mysqldump）和许多语言绑定（如 Python 的 mysql-connector-python，PHP 的 mysqli）的基础。

为什么在 C 语言中使用 MySQL API？

• 高性能: 直接调用底层库，没有额外的中间层开销，性能最高。
• 系统底层开发: 适用于编写高性能的服务器、守护进程或嵌入式应用程序。
• 精细控制: 可以对数据库连接、查询执行和结果处理进行完全的控制。
• 跨平台: libmysqlclient 支持多种操作系统，如 Linux, macOS, Windows。

环境准备

在开始编码之前,你需要确保你的系统上安装了必要的开发包。

Linux (以 Debian/Ubuntu 为例)

你需要安装 libmysqlclient-dev 包，它包含了编译 C 程序所需的头文件（.h）和库文件（.a 或 .so）。

# 更新包列表
sudo apt-get update
# 安装开发库
sudo apt-get install libmysqlclient-dev

macOS (使用 Homebrew)

如果你使用 Homebrew，可以直接安装 MySQL 客户端，它会自动包含开发文件。

brew install mysql

Windows

1. 下载 MySQL Connector/C: 访问 MySQL 官网下载页面：MySQL Connector/C。
2. 安装: 运行安装程序，它会将头文件和库文件安装到指定目录（C:\Program Files\MySQL\MySQL Connector C 6.1.x\）。
3. 配置开发环境:
   • 在你的 IDE（如 Visual Studio）中，包含头文件目录。
   • 链接库文件（libmysql.lib）。
   • 将库文件所在的目录添加到系统的库路径中。

核心概念与流程

使用 C API 与数据库交互的基本流程非常固定，通常遵循以下步骤：

1. 包含头文件: #include <mysql.h>
2. 初始化连接: 创建一个 MYSQL 结构体实例，并使用 mysql_init() 初始化它。
3. 连接服务器: 使用 mysql_real_connect() 函数连接到 MySQL 服务器。
4. 执行 SQL 语句: 使用 mysql_query() 或 mysql_real_query() 执行 SQL 命令。
5. 处理结果:
   • 对于 SELECT 查询，使用 mysql_store_result() 或 mysql_use_result() 获取结果集，然后遍历结果集，使用 mysql_fetch_row() 逐行获取数据。
   • 对于 INSERT/UPDATE/DELETE 等非查询语句，使用 mysql_affected_rows() 获取受影响的行数。
6. 释放结果集: 如果获取了结果集，使用 mysql_free_result() 释放内存。
7. 关闭连接: 使用 mysql_close() 关闭与数据库的连接。
8. 清理资源: MYSQL 结构体本身会在程序退出时由操作系统回收，但最佳实践是显式关闭连接。

关键 API 函数详解

连接相关

• MYSQL *mysql_init(MYSQL *mysql): 初始化一个 MYSQL 对象，如果传入 NULL，它会分配一个新的 MYSQL 对象并返回。
• MYSQL *mysql_real_connect(MYSQL *mysql, const char *host, const char *user, const char *passwd, const char *db, unsigned int port, const char *unix_socket, unsigned long client_flag)
  • 核心连接函数。
  • mysql: 由 mysql_init() 返回的指针。
  • host: 服务器地址（如 "localhost"）。
  • user: 用户名。
  • passwd: 密码。
  • db: 默认连接的数据库名（可为 NULL，后续再选）。
  • port: 端口号（通常为 3306）。
  • unix_socket: Unix 域套接字路径（通常为 NULL）。
  • client_flag: 客户端标志（通常为 0）。
  • 返回值: 成功返回 MYSQL 指针，失败返回 NULL。

执行与结果处理

• int mysql_query(MYSQL *mysql, const char *stmt_str): 执行一个 SQL 语句，语句必须是有效的以 \0 结尾的 C 字符串，对于包含二进制数据或有特殊字符的语句，应使用 mysql_real_query。
• MYSQL_RES *mysql_store_result(MYSQL *mysql): 将整个结果集从服务器读取到客户端内存，这对于大多数简单查询非常方便，如果结果集很大，可能会消耗大量内存。
• MYSQL_RES *mysql_use_result(MYSQL *mysql): 不立即读取结果集，而是返回一个指向结果集的指针，数据会在你调用 mysql_fetch_row() 时逐行获取，这节省了内存，但会保持与服务器的连接，直到所有数据被读取完。
• MYSQL_ROW mysql_fetch_row(MYSQL_RES *result): 从结果集中获取下一行数据。MYSQL_ROW 实际上是一个 char **（字符串数组），当没有更多行时，返回 NULL。
• unsigned int mysql_num_fields(MYSQL_RES *result): 获取结果集中的列数。
• my_ulonglong mysql_affected_rows(MYSQL *mysql): 对于 INSERT, UPDATE, DELETE 语句，返回受影响的行数。
• void mysql_free_result(MYSQL_RES *result): 释放由 mysql_store_result() 或 mysql_use_result() 分配的结果集内存。必须调用！
• void mysql_close(MYSQL *mysql): 关闭数据库连接并释放 MYSQL 结构体。

错误处理

• unsigned int mysql_errno(MYSQL *mysql): 返回最近一次调用的 MySQL API 函数的错误代码。
• const char *mysql_error(MYSQL *mysql): 返回最近一次调用的 MySQL API 函数的错误信息（字符串）。

重要提示: 几乎所有的 C API 函数在失败时都会返回一个错误状态（如 NULL 或 0），mysql_errno() 和 mysql_error() 会捕获这个错误。每次调用 API 后都应该检查返回值并处理错误。

完整代码示例

下面是一个完整的示例,它连接到 MySQL，查询一个表，并打印结果。

#include <stdio.h>
#include <stdlib.h>
#include <mysql.h> // 包含 MySQL API 头文件
// 定义数据库连接信息
#define DB_HOST "localhost"
#define DB_USER "your_username"
#define DB_PASS "your_password"
#define DB_NAME "test_db"
void finish_with_error(MYSQL *con) {
    fprintf(stderr, "Error: %s\n", mysql_error(con));
    mysql_close(con);
    exit(1);
}
int main(int argc, char **argv) {
    // 1. 初始化连接句柄
    MYSQL *con = mysql_init(NULL);
    if (con == NULL) {
        fprintf(stderr, "mysql_init() failed\n");
        exit(1);
    }
    // 2. 连接到数据库服务器
    if (mysql_real_connect(con, DB_HOST, DB_USER, DB_PASS, DB_NAME, 0, NULL, 0) == NULL) {
        finish_with_error(con);
    }
    printf("Connected to database successfully!\n");
    // 3. 执行 SQL 查询
    if (mysql_query(con, "SELECT id, name, age FROM users")) {
        finish_with_error(con);
    }
    // 4. 获取结果集
    MYSQL_RES *result = mysql_store_result(con);
    if (result == NULL) {
        finish_with_error(con);
    }
    // 5. 获取列数
    int num_fields = mysql_num_fields(result);
    // 6. 遍历结果集
    MYSQL_ROW row;
    while ((row = mysql_fetch_row(result))) {
        // 打印每一行的每一列
        for(int i = 0; i < num_fields; i++) {
            printf("%s\t", row[i] ? row[i] : "NULL");
        }
        printf("\n");
    }
    // 7. 释放结果集
    mysql_free_result(result);
    // 8. 关闭连接
    mysql_close(con);
    printf("Data selected successfully!\n");
    return 0;
}

如何编译和运行:

1. 确保你的数据库中有一个 test_db 数据库，并且其中有一个 users 表。

   CREATE DATABASE IF NOT EXISTS test_db;
   USE test_db;
   CREATE TABLE IF NOT EXISTS users (
       id INT AUTO_INCREMENT PRIMARY KEY,
       name VARCHAR(50) NOT NULL,
       age INT
   );
   INSERT INTO users (name, age) VALUES ('Alice', 30), ('Bob', 25), ('Charlie', 35);

2. 编译: 使用 -lmysqlclient 选项链接 MySQL 客户端库。

   gcc -o mysql_app mysql_app.c -lmysqlclient

3. 运行:

   ./mysql_app

预期输出:

Connected to database successfully!
1   Alice   30
2   Bob 25
3   Charlie 35
Data selected successfully!

最佳实践与注意事项

错误处理

如示例所示,每次调用 API 后都必须检查其返回值，并使用 mysql_error() 打印有意义的错误信息，这是 C API 编程中最重要的一点。

资源释放

• mysql_free_result(): 如果你调用了 mysql_store_result() 或 mysql_use_result()，必须在用完后调用 mysql_free_result() 来释放内存，否则会导致内存泄漏。
• mysql_close(): 程序结束时，务必关闭所有打开的数据库连接。

预处理语句

为了防止 SQL 注入和提高性能，对于动态 SQL，应该使用预处理语句。

• 相关函数:
  • mysql_stmt_prepare(): 准备一个 SQL 语句。
  • mysql_stmt_bind_param(): 绑定参数。
  • mysql_stmt_execute(): 执行预处理语句。
  • mysql_stmt_bind_result(): 绑定结果变量。
  • mysql_stmt_fetch(): 获取结果。

预处理语句比直接拼接 SQL 字符串更安全、更高效。

多线程

libmysqlclient 不是线程安全的，如果你在多线程程序中使用它，必须为每个线程创建独立的 MYSQL 连接句柄，并且不能在线程间共享它，或者，你可以使用 mysql_thread_init() 和 mysql_thread_end() 来手动管理线程，但这很复杂，最佳实践是每个线程一个连接。

替代方案

虽然 libmysqlclient 是官方标准，但有时你可能需要考虑其他库：

1. MySQL Connector/C++: 如果你正在使用 C++，官方提供了基于 C++ 的连接器，它提供了更现代的、面向对象的接口（如 sql::Connection, sql::Statement），使用起来比 C API 更安全、更方便。
2. 第三方库 (如 mysql++, libpqxx for PostgreSQL): 这些库通常是对 C API 的更高层封装，旨在提供更易用的 C++ 接口。
3. ORM (Object-Relational Mapping) 库: 对于复杂的应用程序，使用 ORM 可以让你用对象操作来代替直接的 SQL，从而提高开发效率和代码可维护性，虽然 C 语言中没有像 Java Hibernate 或 Python SQLAlchemy 那样成熟的 ORM，但有一些小型项目存在。

对于大多数 C 语言项目，直接使用 libmysqlclient 是一个非常可靠和高效的选择，只要你能遵循其编程规范。