C# 扩展 DataTable 转换为 JSON 格式

阿澈
阿澈
发布时间:2026-10-14| 3人浏览过
原创

在使用 .NET 开发过程中,经常需要将 DataTable 中的表格数据序列化为 JSON 字符串,以便在前端或 API 中直接调用。本文将展示如何通过 C# 扩展方法实现这一功能,从而简化数据处理流程。

实现思路与目标

DataTable 是 ADO.NET 中常用的数据存储结构,但其原生序列化通常较为繁琐。为了获取更简洁、标准的 JSON 格式(例如 {"tableName": [...]}),我们可以创建一个静态辅助类,并通过 this 关键字为 DataTable 添加扩展方法。该方法的核心逻辑是遍历数据表的每一行和每一列,手动拼接 JSON 字符串。

准备条件

在进行代码编写前,请确保项目中已引入以下命名空间:

  • System.Data:用于处理 DataTable。
  • System.Text:用于使用 StringBuilder 提高字符串拼接效率。

第1步:编写扩展类与方法

新建一个静态类(如 DataTableExtender),在其中定义名为 ToJson 的扩展方法。该方法接收两个参数:DataTable 实例和表名 tbName。

重要参数说明:

  • dt:要转换的数据源。
  • tbName:生成的 JSON 数组外层包裹的对象键名。
namespace PadWebServices.Model
{
    public static class DataTableExtender
    {
        /// <summary>
        /// 将 DataTable 转换为指定格式的 JSON 字符串
        /// </summary>
        /// <param name="dt">数据表</param>
        /// <param name="tbName">JSON键名</param>
        /// <returns>JSON字符串</returns>
        public static string ToJson(this DataTable dt, string tbName)
        {
            StringBuilder JsonString = new StringBuilder();
            
            // 安全检查:非空且包含数据
            if (dt != null && dt.Rows.Count > 0)
            {
                JsonString.Append("{ ");
                JsonString.Append(\"\" + tbName + "\":[ ");
                
                for (int i = 0; i < dt.Rows.Count; i++)
                {
                    JsonString.Append("{ ");
                    for (int j = 0; j < dt.Columns.Count; j++)
                    {
                        // 处理逗号分隔符:最后一项不加分号
                        if (j < dt.Columns.Count - 1)
                        {
                            JsonString.Append(\"\"" + dt.Columns[j].ColumnName.ToString() + "\\":" + \"\\\"" + dt.Rows[i][j].ToString() + \"\\\",\"");
                        }
                        else if (j == dt.Columns.Count - 1)
                        {
                            JsonString.Append(\"\"" + dt.Columns[j].ColumnName.ToString() + "\\":" + \"\\\"" + dt.Rows[i][j].ToString() + \"\\\"");
                        }
                    }
                    
                    // 判断是否是最后一行
                    if (i == dt.Rows.Count - 1)
                    {
                        JsonString.Append("} ");
                    }
                    else
                    {
                        JsonString.Append("}, ");
                    }
                }
                JsonString.Append("]} ");
                return JsonString.ToString();
            }
            else
            {
                return null;
            }
        }
    }
}
相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。