c如何编写json接口

使用C语言编写JSON接口：从入门到实践

在当今的软件开发中，JSON（JavaScript Object Notation）已成为数据交换的主流格式之一，因其轻量级、易解析的特点被广泛应用于Web服务、移动应用和物联网等场景，虽然C语言本身并不直接支持JSON处理，但通过借助第三方库，我们可以高效地编写JSON接口，实现数据的序列化（将C结构体转换为JSON字符串）和反序列化（将JSON字符串解析为C结构体），本文将详细介绍如何使用C语言编写JSON接口，包括环境搭建、核心库选择、序列化与反序列化实现,以及一个完整的示例。

JSON接口开发的核心需求

编写JSON接口的核心任务包括：

1. 序列化：将C语言中的数据结构（如结构体、数组）转换为JSON字符串，便于网络传输或存储。
2. 反序列化：将接收到的JSON字符串解析为C语言数据结构，便于程序处理。
3. 错误处理：确保JSON格式正确，并在解析或生成过程中捕获异常。

为实现这些功能，我们需要选择合适的JSON处理库，C语言中常用的JSON库包括：

• cJSON：轻量级、易上手，支持JSON的生成、解析和修改，是C语言JSON处理的“瑞士军刀”。
• Jansson：功能丰富，性能较好，支持严格的JSON规范检查。
• yajl：流式解析器，适合处理大JSON文件，内存占用低。

cJSON因简单易用、文档齐全，成为初学者的首选，本文将以cJSON为例,讲解JSON接口的开发流程。

环境搭建：安装cJSON库

获取cJSON源码

cJSON是开源项目，可通过GitHub获取最新源码：

git clone https://github.com/DaveGamble/cJSON.git

编译安装

Linux/macOS系统

进入cJSON目录，执行以下命令编译并安装：

cd cJSON
mkdir build && cd build
cmake ..  
make
sudo make install

安装后，头文件cjson.h会位于/usr/local/include，库文件libcjson.a和libcjson.so会位于/usr/local/lib。

Windows系统（以MinGW为例）

1. 下载cJSON源码压缩包并解压。
2. 使用GCC编译：

   gcc -c cJSON.c -o cJSON.o
   ar rcs libcjson.a cJSON.o

3. 将cjson.h和libcjson.a复制到你的项目目录中。

项目配置

在编译你的C程序时，需要链接cJSON库，在Linux下使用gcc编译：

gcc your_program.c -I/path/to/cjson/include -L/path/to/cjson/lib -lcjson -o your_program

-I指定头文件路径，-L指定库文件路径，-lcjson链接cJSON库。

核心功能实现：序列化与反序列化

cJSON基本数据结构

cJSON通过链表结构表示JSON数据，核心类型包括：

• cJSON_NULL：null值
• cJSON_FALSE/cJSON_TRUE：布尔值
• cJSON_NUMBER：数字（支持int、double等）
• cJSON_STRING：字符串
• cJSON_ARRAY：数组
• cJSON_OBJECT：对象

每个节点通过cJSON结构体表示，包含类型、值、子节点等信息。

序列化：将C数据转为JSON字符串

示例1：生成简单的JSON对象

假设我们要生成以下JSON：

{
    "name": "Alice",
    "age": 25,
    "is_student": true,
    "scores": [90, 85, 88]
}

代码实现：

#include <stdio.h>
#include <stdlib.h>
#include "cjson.h"
int main() {
    // 创建JSON对象
    cJSON *root = cJSON_CreateObject();
    // 添加键值对
    cJSON_AddStringToObject(root, "name", "Alice");
    cJSON_AddNumberToObject(root, "age", 25);
    cJSON_AddBoolToObject(root, "is_student", cJSON_True);
    // 创建数组并添加到对象
    cJSON *scores = cJSON_CreateArray();
    cJSON_AddItemToArray(scores, cJSON_CreateNumber(90));
    cJSON_AddItemToArray(scores, cJSON_CreateNumber(85));
    cJSON_AddItemToArray(scores, cJSON_CreateNumber(88));
    cJSON_AddItemToObject(root, "scores", scores);
    // 生成JSON字符串（格式化输出）
    char *json_str = cJSON_Print(root);
    printf("Generated JSON:\n%s\n", json_str);
    // 释放内存
    free(json_str);
    cJSON_Delete(root);
    return 0;
}

关键函数说明

• cJSON_CreateObject()：创建JSON对象节点。
• cJSON_AddStringToObject()/cJSON_AddNumberToObject()/cJSON_AddBoolToObject()：向对象中添加键值对。
• cJSON_CreateArray()：创建JSON数组节点。
• cJSON_AddItemToArray()：向数组中添加元素。
• cJSON_Print()：将JSON对象格式化为字符串（带缩进）；cJSON_PrintUnformatted()生成无缩字符串。
• cJSON_Delete()：释放JSON对象及其子节点的内存（必须调用，避免内存泄漏）。

反序列化：将JSON字符串解析为C数据

示例2：解析JSON字符串

假设我们有以下JSON字符串：

{
    "name": "Bob",
    "age": 30,
    "is_student": false,
    "address": {
        "city": "Beijing",
        "zip": 100000
    }
}

解析代码：

#include <stdio.h>
#include <stdlib.h>
#include "cjson.h"
int main() {
    const char *json_str = "{\"name\":\"Bob\",\"age\":30,\"is_student\":false,\"address\":{\"city\":\"Beijing\",\"zip\":100000}}";
    // 解析JSON字符串
    cJSON *root = cJSON_Parse(json_str);
    if (!root) {
        printf("JSON parse error: %s\n", cJSON_GetErrorPtr());
        return 1;
    }
    // 获取字段值
    cJSON *name = cJSON_GetObjectItem(root, "name");
    cJSON *age = cJSON_GetObjectItem(root, "age");
    cJSON *is_student = cJSON_GetObjectItem(root, "is_student");
    cJSON *address = cJSON_GetObjectItem(root, "address");
    if (cJSON_IsString(name) && cJSON_IsNumber(age) && cJSON_IsBool(is_student) && cJSON_IsObject(address)) {
        printf("Name: %s\n", name->valuestring);
        printf("Age: %d\n", age->valueint);
        printf("Is Student: %s\n", is_student->valueint ? "true" : "false");
        // 解析嵌套对象
        cJSON *city = cJSON_GetObjectItem(address, "city");
        cJSON *zip = cJSON_GetObjectItem(address, "zip");
        if (cJSON_IsString(city) && cJSON_IsNumber(zip)) {
            printf("City: %s\n", city->valuestring);
            printf("Zip: %d\n", zip->valueint);
        }
    }
    // 释放内存
    cJSON_Delete(root);
    return 0;
}

关键函数说明

• cJSON_Parse()：解析JSON字符串，返回JSON对象指针；解析失败时返回NULL，可通过cJSON_GetErrorPtr()获取错误信息。
• cJSON_GetObjectItem()：从JSON对象中根据键名获取子节点。
• cJSON_IsString()/cJSON_IsNumber()/cJSON_IsBool()/cJSON_IsObject()：判断节点类型。
• 节点值访问：valuestring（字符串）、valueint（整数）、valuedouble（浮点数）、valueint（布尔值，1为true，0为false）。

编写完整的JSON接口：HTTP服务器示例

下面我们通过一个简单的HTTP服务器示例，展示如何结合cJSON实现JSON接口，该接口接收用户提交的JSON数据（包含姓名和年龄），处理后返回响应。

功能描述

• 请求：POST /api/user，JSON格式：{"name":"Alice","age":25}
• 响应：成功时返回{"status":"success","message":"User added"}，失败时返回{"status":"error","message":"Invalid data"}

代码实现（使用libevent作为HTTP服务器框架）

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cjson.h"
#include