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

基于esp32-s3，写一个实现json键值对数据创建和读写解析c例程

news 来源：原创 2025/4/24 9:16:05

以下是一个基于 ESP32 - S3 使用 ESP - IDF 框架实现 JSON 键值对数据创建、读写和解析的 C 语言例程。

环境准备

确保你已经安装了 ESP - IDF 开发环境，并且可以正常编译和烧录代码到 ESP32 - S3 开发板。

代码示例

#include <stdio.h>
#include <string.h>
#include "esp_log.h"
#include "cJSON.h"// 日志标签
static const char *TAG = "JSON_EXAMPLE";// 创建 JSON 键值对数据
char* create_json_data() {// 创建一个新的 JSON 对象cJSON *root = cJSON_CreateObject();if (root == NULL) {ESP_LOGE(TAG, "Failed to create JSON object");return NULL;}// 添加键值对到 JSON 对象cJSON_AddStringToObject(root, "name", "John Doe");cJSON_AddNumberToObject(root, "age", 30);cJSON_AddBoolToObject(root, "is_student", false);// 将 JSON 对象转换为字符串char *json_string = cJSON_Print(root);if (json_string == NULL) {ESP_LOGE(TAG, "Failed to print JSON object");cJSON_Delete(root);return NULL;}// 删除 JSON 对象cJSON_Delete(root);return json_string;
}// 解析 JSON 数据
void parse_json_data(const char *json_string) {// 解析 JSON 字符串cJSON *root = cJSON_Parse(json_string);if (root == NULL) {const char *error_ptr = cJSON_GetErrorPtr();if (error_ptr != NULL) {ESP_LOGE(TAG, "Error before: %s", error_ptr);}return;}// 读取键值对cJSON *name = cJSON_GetObjectItemCaseSensitive(root, "name");cJSON *age = cJSON_GetObjectItemCaseSensitive(root, "age");cJSON *is_student = cJSON_GetObjectItemCaseSensitive(root, "is_student");if (cJSON_IsString(name) && (name->valuestring != NULL)) {ESP_LOGI(TAG, "Name: %s", name->valuestring);}if (cJSON_IsNumber(age)) {ESP_LOGI(TAG, "Age: %d", age->valueint);}if (cJSON_IsBool(is_student)) {ESP_LOGI(TAG, "Is Student: %s", cJSON_IsTrue(is_student) ? "true" : "false");}// 删除解析后的 JSON 对象cJSON_Delete(root);
}void app_main(void) {// 创建 JSON 数据char *json_string = create_json_data();if (json_string != NULL) {ESP_LOGI(TAG, "Created JSON data: %s", json_string);// 解析 JSON 数据parse_json_data(json_string);// 释放 JSON 字符串内存cJSON_free(json_string);}
}

代码解释

引入头文件：引入了 stdio.h、string.h、esp_log.h 和 cJSON.h 头文件，分别用于标准输入输出、字符串处理、ESP - IDF 日志和 JSON 处理。
创建 JSON 数据：create_json_data() 函数创建一个新的 JSON 对象，并添加键值对。然后将 JSON 对象转换为字符串并返回。
解析 JSON 数据：parse_json_data() 函数解析传入的 JSON 字符串，并读取其中的键值对。最后打印出读取到的值。
主函数：在 app_main() 函数中，调用 create_json_data() 函数创建 JSON 数据，打印创建的 JSON 字符串，然后调用 parse_json_data() 函数解析 JSON 数据。最后释放 JSON 字符串占用的内存。

编译和运行

将上述代码保存为一个 .c 文件，例如 main.c，并将其放置在 ESP - IDF 项目的 main 目录下。然后在终端中进入项目目录，执行以下命令进行编译和烧录：

idf.py build
idf.py -p /dev/ttyUSB0 flash monitor

请将 /dev/ttyUSB0 替换为你的 ESP32 - S3 开发板所使用的串口设备。

注意事项

本示例使用了 cJSON 库，该库是一个轻量级的 JSON 解析库，已经集成在 ESP - IDF 中。
在使用 cJSON 库时，需要注意内存管理，避免内存泄漏。例如，在创建 JSON 对象和打印 JSON 字符串后，需要调用 cJSON_Delete() 和 cJSON_free() 函数释放内存。

=================================================================

以下是几个在 C 语言中多行书写包含字符串和整型混合值的 JSON 键值对数据的例子，分别展示了不同的实现方式。

方式一：利用相邻字符串常量自动拼接特性

#include <stdio.h>int main() {const char *json_data = "{""\"name\": \"John Doe\",""\"age\": 30,""\"city\": \"New York\",""\"id\": 12345,""\"email\": \"johndoe@example.com\"""}";printf("%s\n", json_data);return 0;
}

代码解释：

编译器会自动把相邻的字符串常量拼接成一个完整的字符串。这里将 JSON 的各个键值对拆分成多行书写，其中 "name" 和 "city"、"email" 的值是字符串，而 "age" 和 "id" 的值是整型。
最后使用 printf 函数将拼接好的 JSON 字符串输出。

方式二：使用字符串拼接函数

#include <stdio.h>
#include <string.h>int main() {char json[512] = "{ ";// 拼接字符串值的键值对strcat(json, "\"name\": \"John Doe\", ");// 拼接整型值的键值对char age_str[10];sprintf(age_str, "\"age\": %d, ", 30);strcat(json, age_str);strcat(json, "\"city\": \"New York\", ");char id_str[10];sprintf(id_str, "\"id\": %d, ", 12345);strcat(json, id_str);strcat(json, "\"email\": \"johndoe@example.com\" ");strcat(json, "}");printf("%s\n", json);return 0;
}

代码解释：

首先定义一个足够大的字符数组 json 用于存储拼接后的 JSON 字符串，并初始化为 { 作为 JSON 对象的起始。
对于字符串值的键值对，直接使用 strcat 函数进行拼接。
对于整型值的键值对，先使用 sprintf 函数将整型值转换为字符串格式，再将其拼接到 json 数组中。
最后拼接上结束的花括号 }，并使用 printf 函数输出最终的 JSON 字符串。

方式三：使用宏定义辅助拼接

#include <stdio.h>#define JSON_KEY_VALUE(key, value) "\"" #key "\": " #value ","int main() {const char *json_data = "{"JSON_KEY_VALUE(name, "John Doe")JSON_KEY_VALUE(age, 30)JSON_KEY_VALUE(city, "New York")JSON_KEY_VALUE(id, 12345)"\"email\": \"johndoe@example.com\"""}";printf("%s\n", json_data);return 0;
}