cJson 开发者文档手册

简介

cJson 是 VBMAN 框架提供的 JSON 处理类，基于 VBA-JSON v2.3.1 改进封装。它提供了简单易用的 API 来解析和生成 JSON 数据，支持嵌套对象、数组、文件操作等功能。

文档导航

文档	说明	适合读者
index.md	概述和主要特性	所有开发者
quickstart.md	5 分钟快速上手指南	新手开发者
api-reference.md	完整的 API 参考手册	所有开发者
examples.md	详细的代码示例集	所有开发者
best-practices.md	最佳实践和注意事项	进阶开发者
faq.md	常见问题解答	所有开发者

快速开始

安装引用

确保项目中已添加对 VBMAN 库的引用。

最简单的示例

'创建 JSON 对象
With New VBMANLIB.cJson
    .Item("name") = "张三"
    .Item("age") = 25
    MsgBox .Encode(, 2, True)
End With

输出：

{
  "name": "张三",
  "age": 25
}

解析 JSON 字符串（使用 Root 访问）

Dim JsonText As String
JsonText = "{""name"":""张三"",""age"":25}"

With New VBMANLIB.cJson
    .Decode JsonText
    '使用 Root（默认成员）访问 - 推荐方式
    MsgBox .Root("name")  '输出：张三
    '或简写为：
    MsgBox $("name")     '输出：张三
End With

核心特性

• 类型映射清晰：Dictionary（字典）↔ JSON 对象 {...}，Collection（集合）↔ JSON 数组 [...]
• 节点创建与成员设置分离：NewItem/NewItems 创建子节点，Item/Items 在节点上增改成员
• 默认成员：Root 是默认成员，可直接用 Json("key") 访问，支持链式嵌套
• 支持嵌套：无限层级的 JSON 对象和数组嵌套
• 文件操作：支持从文件加载和保存 JSON 数据
• 编码解码：支持 JSON 字符串与 VB 对象的相互转换
• 格式化输出：支持自定义缩进格式化 JSON 字符串
• 中文支持：支持中文原样显示（不进行 Unicode 转码）
• 数组下标：集合数组下标从 1 开始（符合 VB 习惯）

重要提示

1. 类型对应：Dictionary（字典）对应 JSON 对象 {...}，Collection（集合）对应 JSON 数组 [...]
2. Root 是默认成员：可直接用 Json("key") 访问，等同于 Json.Root("key")，用于链式读写
3. NewItem/NewItems 创建节点：NewItem 创建子对象节点，NewItems 创建子数组节点
4. Item/Items 增改成员：Item 在对象节点上设置键值对，Items 在数组节点上添加元素
5. 数组下标从 1 开始：VB 的 Collection 对象下标从 1 开始，与 JavaScript 不同
6. 全局实例共享数据：VBMAN.Json 是全局实例，数据会在多次使用间保留，必要时调用 .Clear() 清理

作者信息

• 作者: 邓伟
• QQ: 215879458
• 基于: VBA-JSON v2.3.1 by Tim Hall (https://github.com/VBA-tools/VBA-JSON)

许可证

本文档遵循项目许可证。

---

最后更新: 2026年3月7日