yyjson项目构建与测试完全指南

yyjson项目构建与测试完全指南

yyjson The fastest JSON library in C 项目地址: https://gitcode.com/gh_mirrors/yy/yyjson

yyjson是一个高性能的C语言JSON库，本文将从技术角度详细介绍如何构建、集成和测试yyjson项目。

一、项目集成方式

yyjson提供了多种集成方式，适合不同开发场景：

1. 源代码集成（最简单方式）

yyjson采用ANSI C(C99)编写，兼容严格的C89标准，具有极佳的跨平台特性。只需将以下两个文件添加到您的项目中：

• yyjson.h - 头文件
• yyjson.c - 实现文件

该库已在多种编译器和架构上测试通过：

• 编译器：gcc、clang、msvc、tcc
• 架构：x86、arm、ppc、riscv、s390x

2. 包管理器集成

yyjson支持主流包管理器，方便在大型项目中使用：

vcpkg方式

vcpkg install yyjson

conan/xmake方式

类似vcpkg，具体命令请参考各包管理器文档

3. CMake集成（推荐方式）

CMake提供了最灵活的构建方式，支持多种定制选项。

二、CMake构建详解

1. 基础构建

# 克隆仓库
git clone yyjson.git
mkdir build && cd build

# 构建静态库
cmake .. && cmake --build .

# 构建动态库
cmake .. -DBUILD_SHARED_LIBS=ON && cmake --build .

2. 关键CMake选项

yyjson提供了丰富的构建选项：

| 选项 | 说明 | |------|------| | YYJSON_BUILD_TESTS | 构建测试用例 | | YYJSON_BUILD_FUZZER | 构建模糊测试 | | YYJSON_ENABLE_COVERAGE | 启用代码覆盖率 | | YYJSON_ENABLE_VALGRIND | 启用内存检查 | | YYJSON_DISABLE_READER | 禁用JSON解析功能 | | YYJSON_DISABLE_WRITER | 禁用JSON生成功能 | | YYJSON_DISABLE_FAST_FP_CONV | 禁用快速浮点数转换 |

3. 作为依赖项使用

在您的CMake项目中集成yyjson：

# 方式1：本地集成
add_subdirectory(vendor/yyjson)
target_link_libraries(your_target PRIVATE yyjson)

# 方式2：自动下载（CMake 3.11+）
include(FetchContent)
FetchContent_Declare(yyjson GIT_REPOSITORY yyjson.git)
FetchContent_MakeAvailable(yyjson)
target_link_libraries(your_target PRIVATE yyjson)

三、测试与验证

1. 基础测试

cmake .. -DYYJSON_BUILD_TESTS=ON
cmake --build .
ctest --output-on-failure

2. 高级测试方式

内存检查（Valgrind）

cmake .. -DYYJSON_BUILD_TESTS=ON -DYYJSON_ENABLE_VALGRIND=ON

代码消毒（Sanitizer）

cmake .. -DYYJSON_BUILD_TESTS=ON -DYYJSON_ENABLE_SANITIZE=ON

代码覆盖率

# GCC版本
cmake .. -DYYJSON_BUILD_TESTS=ON -DYYJSON_ENABLE_COVERAGE=ON
lcov -c -d ./CMakeFiles --include "*/yyjson.*" -o cov.info
genhtml cov.info -o ./cov_report

# Clang版本
export LLVM_PROFILE_FILE=cov/profile-%p.profraw
llvm-profdata merge -sparse cov/profile-*.profraw -o coverage.profdata
llvm-cov show ... > coverage.html

3. 模糊测试

cmake .. -DYYJSON_BUILD_FUZZER=ON -DCMAKE_C_COMPILER=clang
./fuzzer -dict=fuzzer.dict ./corpus

四、编译时优化选项

yyjson提供了多种编译时选项，可根据需求裁剪功能：

1. 禁用读取器 (YYJSON_DISABLE_READER=1)

   • 减少约60%二进制大小
   • 适用于仅需JSON生成的场景

2. 禁用写入器 (YYJSON_DISABLE_WRITER=1)

   • 减少约30%二进制大小
   • 适用于仅需JSON解析的场景

3. 禁用快速浮点转换 (YYJSON_DISABLE_FAST_FP_CONV=1)

   • 使用标准库的strtod/snprintf
   • 减少30%大小但性能下降

4. 禁用非标准JSON支持 (YYJSON_DISABLE_NON_STANDARD=1)

   • 禁用Inf/NaN、注释等非标准特性
   • 减少10%大小并小幅提升性能

5. 禁用UTF-8验证 (YYJSON_DISABLE_UTF8_VALIDATION=1)

   • 提升3-7%非ASCII字符串处理速度
   • 需确保输入字符串已是合法UTF-8

五、文档生成

使用Doxygen生成API文档：

cmake .. -DYYJSON_BUILD_DOC=ON
cmake --build .
# 生成的HTML位于build/doxygen/html目录

六、跨平台构建示例

# Windows Visual Studio
cmake .. -G "Visual Studio 16 2019" -A x64

# macOS Xcode
cmake .. -G Xcode

# iOS开发
cmake .. -G Xcode -DCMAKE_SYSTEM_NAME=iOS

# 指定编译器
cmake .. -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++

通过本文介绍的各种构建和测试方法，开发者可以根据项目需求选择最适合的yyjson集成方式，在性能、大小和功能之间取得最佳平衡。

yyjson The fastest JSON library in C 项目地址: https://gitcode.com/gh_mirrors/yy/yyjson