当前位置：首页 > article >正文

【MySQL基础篇】十四、MySQL的C语言API使用

article 2025/1/11 11:20:12

文章目录

Ⅰ.安装 MySQL C API
- 1、方法一（不推荐）
- 2、方法二（推荐）
Ⅱ. 连接数据库的步骤
Ⅲ. MySQL API 介绍
- - 1、初始化连接环境
  - 2、连接`mysql`服务器
  - 3、获取和设置字符编码
  - 4、选择连接的数据库（可不选）
  - 5、执行`sql`语句
  - 6、获取结果集
  - 7、获取结果集的行数、列数、列字段名称
  - 8、从结果集中获取一行数据
  - 9、获取从结果集中检索的当前行的列字段值的长度
  - 10、资源回收
  - 11、打印错误信息
  - 12、事务操作
Ⅳ. MySQL API 的使用

Ⅰ.安装 MySQL C API

1、方法一（不推荐）

这里我们要使用 C 语言连接 mysql 的话，需要使用 mysql 官网提供的库，大家可以去官网下载。

并且要正确使用，我们需要做一些准备工作：

保证 mysql 服务有效
在官网上下载合适自己平台的 mysql connect 库，以备后用

在这里插入图片描述

2、方法二（推荐）

但其实我们也不需要这么麻烦，我们之前在通过 yum 安装 mysql 的时候，其实已经帮我们安装好了这些库文件，如下所示：

yum install -y mysql-community-server;

如果安装完上面的包后还没找到库文件的话，那我们可以直接安装下面的工具包：

yum install -y mysql-community-devel;

所以我们 更推荐这种 yum 安装方法，要是采用上面那种方法的话还需要我们自己去配置动静态库，那太麻烦了！

安装完后我们是可以查到头文件的：

在这里插入图片描述

我们也可以简单的写个代码测试一下是否安装成功：

#include <iostream>
#include <mysql/mysql.h>
int main()
{
    // 通过mysql_get_client_info()函数来验证我们的引入是否成功，成功的话会打印mysql的版本号
    std::cout << "mysql client Version: \n" << mysql_get_client_info() << std::endl;
    return 0;
}

// 在编译的时候，需要指定动态库的位置：-L后面跟的是动态库的路径，-l后面跟的是动态库名称
[liren@VM-8-7-centos vscode_test]$ g++ -o test test.cc -L/usr/lib64/mysql/ -lmysqlclient         
[liren@VM-8-7-centos vscode_test]$ ./test 
mysql client Version: 
5.7.43

至于配置动态库的路径，可以参考动静态库笔记自行尝试！

Ⅱ. 连接数据库的步骤

众所周知，MySQL 数据库是一个典型的 C/S 结构，即：客户端和服务器端。

如果我们部署好了 MySQL 服务器，想要在客户端访问服务器端的数据，在编写程序的时候就可以通过官方提供的 C 语言的 API 来实现，因为我们总不能说在程序中开个子进程去使用 SQL 语句是吧，所以直接通过 API 来调用是最省事的！

在程序中连接 MySQL 服务器，主要分为已经几个步骤：

客户端初始化过程：
1. 初始化 mysql 操作句柄
2. 连接 mysql 服务器，要提供如下连接数据:
  - 服务器的 ip 地址
  - 服务器监听的端口（默认端口是 3306）
  - 连接服务器使用的用户名（默认是 root），和这个用户对应的密码
  - 要操作的数据库的名字
3. 设置客户端的字符集
4. 选择想要的操作的数据库
客户端对数据库中数据的操作：
1. 对于 新增、修改、删除操作：
  - 这三个操作都是只要 sql 语句执行成功了，数据库中的数据就发生了改变，不需要反馈结果。
  - 需要对执行的结果进行判断
    - 成功：提交事务
    - 失败：数据回滚
2. 对于 查询操作：
  - 这个操作就不一样了，因为需要首先执行 sql 语句成功，此时查询结果还是服务器上面，我们 需要进行对结果集的访问：
    1. 获取查询结果集中的结果条数
    2. 遍历获取结果集 -> 得到了要查询的数据
    3. 释放结果集（结果集是动态开辟的，要释放，不然会内存泄露）
释放 mysql 操作句柄

Ⅲ. MySQL API 介绍

对于以上的操作步骤，在 MySQL 提供的 API 中都有对应的操作函数。我们可以在官网查到这些接口的信息：官方接口文档。

而下面我们要讲的接口，是最基本的使用的接口，其它的接口如需去官方查询！

在使用 mysql c api 之前，需要引入下面的头文件：

#include <mysql/mysql.h>

其在不同操作系统中对应的 动态库：

Windows：libmysql.dll

Linux：libmysqlclient.so

1、初始化连接环境

要使用库，必须先进行初始化！

// 参数：mysql一般给null即可
// 返回值: 该函数将分配、初始化、并返回新对象。通过返回的这个对象去连接MySQL的服务器
	MYSQL* mysql_init(MYSQL* mysql);

2、连接`mysql`服务器

初始化完毕之后，必须先链接数据库，再进行后续操作。

/*
    返回值: 
        成功：返回 MYSQL*连接句柄, 对于成功的连接，返回值与第1个参数的值相同。返回值指向的内存和第一个参数指针指向的内存一样
        失败：返回 NULL
        句柄：是 windows 中的一个概念, 句柄可以理解为一个实例(或者对象)
*/ 
MYSQL* mysql_real_connect(
        MYSQL *mysql,           	// mysql_init() 函数的返回值
        const char* host,       	// mysql服务器的主机地址, 写IP地址即可。如果是localhost、null -> 代表本地连接
        const char* user,       	// 连接mysql服务器的用户名, 默认：root 
        const char* passwd,     	// 连接mysql服务器用户对应的密码, 如root用户的密码
        const char* db,         	// 要使用的数据库的名字
        unsigned int port,      	// 连接的mysql服务器监听的端口，如果为0, 使用mysql的默认端口3306
        const char* unix_socket,	// 本地套接字, 不使用指定为 NULL
        unsigned long client_flag	// 客户端标志位，通常指定为0
);

第一个参数 mysql 是一个非常重要的变量（mysql_init 的返回值），其内部非常丰富，有 port、dbname、charset 等连接基本参数。它也包含了一个叫 st_mysql_methods 的结构体变量，该变量里面保存着很多函数指针，这些函数指针将会在数据库连接成功以后的各种数据操作中被调用。

3、获取和设置字符编码

建立好连接之后，获取英文没有问题，但是如果获取中文就是乱码，所以要设置连接的默认字符集为 utf8，原始连接默认是 latin1 编码！

// 获取api默认使用的字符编码，为当前连接返回默认的字符集
// 返回值: 默认字符集
	const char* mysql_character_set_name(MYSQL* mysql) 

// 设置api使用的字符集，第二个参数 csname 就是要设置的字符集 -> 支持中文: utf8
// 返回值：成功返回0， 失败返回非0
	int mysql_set_character_set(MYSQL* mysql, char* csname);

4、选择连接的数据库（可不选）

这个操作不做也是可以的，因为上面我们使用 mysql_real_connect() 函数的时候已经指明了对应的数据库！

/*
    功能：选择操作的数据库
    参数说明:
        mysql：初始化完成的句柄
           db：要切换选择的数据库名称
    返回值：成功返回0， 失败返回非0
*/ 
	int mysql_select_db(MYSQL* mysql, const char* db)

5、执行`sql`语句

/*
    功能：执行一个sql语句, 添删查改的sql语句都可以
    参数:
        - mysql: mysql_real_connect() 的返回值
        - query: 一个可以执行的sql语句, 结尾的位置不需要加;
    返回值: 
        - 如果查询成功，返回0。如果是查询, 结果集在mysql对象中
        - 如果出现错误，返回非0。 
*/
	int mysql_query(MYSQL* mysql, const char* query);

6、获取结果集

上面 sql 执行完以后，如果是 查询语句，我们当然还要读取数据，如果 update、insert 等语句，那么就看下操作是否成功即可。

我们来看看如何获取查询结果：如果 mysql_query 返回成功，那么我们就通过下面这个函数来读取结果。

其函数原型如下：

// 将结果集从mysql(参数) 对象中取出
// 返回值: 具有多个结果的MYSQL_RES结果集合。如果出现错误，返回NULL。 
	MYSQL_RES* mysql_store_result(MYSQL* mysql);

该函数会调用 mysql 变量中的 st_mysql_methods 中的 read_rows 函数指针来获取查询的结果。

返回值 MYSQL_RES 类型其实对应一块 malloc 的内存空间，里边保存着这个 查询之后得到的结果集，所以我们要调用下面的 mysql_free_result() 函数进行结果集的释放，不然是肯定会造成 内存泄漏 的。

而如何读取结果集中的数据，需要使用下面的函数！

7、获取结果集的行数、列数、列字段名称

// 获取结果集中的行数
// 参数：result--保存到本地的结果集地址
// 返回值：结果集中数据的条数
	uint64_t mysql_num_rows(MYSQL_RES* result);

// 获取结果集中的列数
// 参数: 调用 mysql_store_result() 得到的返回值
// 返回值: 结果集中的列数
	unsigned int mysql_num_fields(MYSQL_RES* result);

// 参数: 调用 mysql_store_result() 得到的返回值
// 返回值: MYSQL_FIELD* 指向一个结构体数组
// 通过这个函数得到结果集中所有列的名字
	MYSQL_FIELD* mysql_fetch_fields(MYSQL_RES* result);

上面返回值 MYSQL_FIELD 对应的是一个结构体，其中存放的是很多关于表的属性！这是在 mysql.h 中定义如下:

// mysql.h
// 结果集中的每一个列对应一个 MYSQL_FIELD
typedef struct st_mysql_field {
    char *name;                 /* 列名-> 字段的名字 */
    char *org_name;             /* Original column name, if an alias */
    char *table;                /* Table of column if column was a field */
    char *org_table;            /* Org table name, if table was an alias */
    char *db;                   /* Database for table */
    char *catalog;              /* Catalog for table */
    char *def;                  /* Default value (set by mysql_list_fields) */
    unsigned long length;       /* Width of column (create length) */
    unsigned long max_length;   /* Max width for selected set */
    unsigned int name_length;
    unsigned int org_name_length;                                                                                        
    unsigned int table_length;
    unsigned int org_table_length;
    unsigned int db_length;
    unsigned int catalog_length;
    unsigned int def_length;
    unsigned int flags;         /* Div flags */
    unsigned int decimals;      /* Number of decimals in field */
    unsigned int charsetnr;     /* Character set */
    enum enum_field_types type; /* Type of field. See mysql_com.h for types */
    void *extension;
} MYSQL_FIELD;

该函数的使用举例：

// 得到存储头信息的数组的地址
MYSQL_FIELD* fields = mysql_fetch_fields(res);
// 得到列数
int num = mysql_num_fields(res);
// 遍历得到每一列的列名
for(int i=0; i<num; ++i)
 printf("当前列的名字: %s\n", fields[i].name);

8、从结果集中获取一行数据

用于从结果集中获取一行数据，并将其存储在一个数组中，也就是说如果想遍历整个结果集，则 需要对该函数进行循环调用！

// 返回值MYSQL_ROW是二级指针，也就是char**，相当于将得到了一个字符串数组
	typedef char** MYSQL_ROW;

	MYSQL_ROW mysql_fetch_row(MYSQL_RES* result);
/*
    参数: 
        - result: 通过查询得到的结果集
    返回值: 
        - 成功: 得到了当前记录中每个字段的值
        - 失败: NULL, 说明数据已经读完了
*/

9、获取从结果集中检索的当前行的列字段值的长度

这个函数获得每个字段的实际字节数，从而帮助我们处理存储在字段中的数据！

/* 
   返回结果集内当前行的列字段值的长度:
      1. 如果打算复制字段值，使用该函数能避免调用strlen()。
      2. 如果结果集包含二进制数据，必须使用该函数来确定数据的大小，原因在于，对于包含Null字符的任何字段，strlen()将返回错误的结果。
      
   参数: result是通过查询得到的结果集
   返回值：无符号长整数的数组，每个元素表示对应列字段的大小。如果出现错误，返回NULL。
*/
	unsigned long* mysql_fetch_lengths(MYSQL_RES* result);

10、资源回收

// 释放结果集
// 参数说明：result是保存到本地的结果集地址
	void mysql_free_result(MYSQL_RES* result);

// 关闭mysql实例
// 参数说明：mysql是初始化完成的句柄
	void mysql_close(MYSQL* mysql);

11、打印错误信息

// 返回错误的描述
	const char* mysql_error(MYSQL* mysql);

// 返回错误的编号
	unsigned int mysql_errno(MYSQL* mysql);

12、事务操作

mysql 中 默认进行自动交事务，因为自动提交事务，会对我们的操作造成影响。

而如果我们操作的步骤比较多，集合的开始和结束需要用户自己去设置，需要改为手动方式提交事务！

/*
    参数:
        如果模式为1，启用autocommit模式；如果模式为0，禁止autocommit模式。
    返回值
        如果成功，返回0，如果出现错误，返回非0值。
*/	
	my_bool mysql_autocommit(MYSQL* mysql, my_bool mode) 

// 事务提交
// 返回值: 成功返回0, 失败返回非0  
	my_bool mysql_commit(MYSQL* mysql);
    
// 数据回滚
// 返回值: 成功返回0, 失败返回非0
	my_bool mysql_rollback(MYSQL* mysql)

Ⅳ. MySQL API 的使用

首先创建测试数据库：

mysql> create database if not exists gobang;
Query OK, 1 row affected (0.03 sec)

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| gobang             |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
5 rows in set (0.00 sec)

mysql> use gobang;
Database changed
mysql> create table if not exists stu(
    -> stu_num int primary key auto_increment,   # 学号
    -> name varchar(32),						 # 姓名
    -> age int,									 # 年龄
    -> chinese decimal(5,2),					 # 成绩
    -> english decimal(5,2),
    -> math decimal(5,2));
Query OK, 0 rows affected (0.30 sec)

mysql> show tables
    -> ;
+------------------+
| Tables_in_gobang |
+------------------+
| stu              |
+------------------+
1 row in set (0.00 sec)

mysql> desc stu;
+---------+--------------+------+-----+---------+----------------+
| Field   | Type         | Null | Key | Default | Extra          |
+---------+--------------+------+-----+---------+----------------+
| stu_num | int(11)      | NO   | PRI | NULL    | auto_increment |
| name    | varchar(32)  | YES  |     | NULL    |                |
| age     | int(11)      | YES  |     | NULL    |                |
| chinese | decimal(5,2) | YES  |     | NULL    |                |
| english | decimal(5,2) | YES  |     | NULL    |                |
| math    | decimal(5,2) | YES  |     | NULL    |                |
+---------+--------------+------+-----+---------+----------------+
6 rows in set (0.02 sec)

然后再编写一下 Makefile 文件：

mysql:mysql.c
	gcc -o $@ $^ -L/usr/lib64/mysql/ -lmysqlclient  #-L后面跟的是动态库的路径，-l后面跟的是动态库名称

最后再来实现一下增删改查操作：

#include <stdio.h>
#include <string.h>
#include <mysql/mysql.h>

#define HOST "127.0.0.1"  // 不允许使用公网地址，所以用本地换回
#define USER "root"
#define PASSWD ""
#define DBNAME "gobang"
#define PORT 3306

int main()
{
    // 1.初始化mysql句柄
    MYSQL* mysql = mysql_init(NULL);
    if(mysql == NULL)
    {
        printf("mysql init fail!\n");
        return -1;
    }

    // 2.连接mysql服务器
    if(mysql_real_connect(mysql, HOST, USER, PASSWD, DBNAME, PORT, NULL, 0) == NULL)
    {
        printf("mysql connect fail：%s\n", mysql_errno(mysql)); // 打印错误信息
        mysql_close(mysql); // 记得关闭句柄
        return -1;
    }

    // 3.设置客户端字符集
    if(mysql_set_character_set(mysql, "utf8") != 0)
    {
        printf("client set character fail：%s\n", mysql_errno(mysql)); // 打印错误信息
        mysql_close(mysql); // 记得关闭句柄
        return -1;
    }

    // 4.选择要操作的数据库（其实也可以不用，因为在初始化的时候已经指定了要选择的数据库）
    if(mysql_select_db(mysql, DBNAME) != 0)
    {
        printf("select database fail：%s\n", mysql_errno(mysql)); // 打印错误信息
        mysql_close(mysql); // 记得关闭句柄
        return -1;
    }

    // 5.执行sql语句
    // char* sql = "insert stu value(null, '利刃', 1314, 100, 150, 149)"; // 增
    // char* sql = "update stu set math=math-40 where stu_num=1;";       // 改
    // char* sql = "delete from stu where stu_num=1;";                   // 删
    char* sql = "select * from stu;"; // 查，需要配合下面的第6、7、8步
    int n = mysql_query(mysql, sql);
    if(n != 0)
    {
        printf("%s: sql query fail：%s\n", sql, mysql_errno(mysql)); // 打印错误信息
        mysql_close(mysql); // 记得关闭句柄
        return -1;
    }

    // 6.如果sql语句是查询语句，需要保存结果到本地
    MYSQL_RES* res = mysql_store_result(mysql);
    if(res == NULL)
    {
        mysql_close(mysql); // 记得关闭句柄
        return -1;
    }

    // 7.获取结果集中的结果条数：行数和列数
    int num_row = mysql_num_rows(res);
    int num_field = mysql_num_fields(res);

    // 8.遍历保存到本地的结果集
    for(int i = 0; i < num_row; ++i)
    {
        MYSQL_ROW row = mysql_fetch_row(res);
        for(int j = 0; j < num_field; ++j)
        {
            printf("%s\t", row[j]);
        }
        printf("\n");
    }

    // 9.释放结果集
    mysql_free_result(res);

    // 10.关闭连接，释放mysql句柄
    mysql_close(mysql);
    return 0;
}