0

0

C# 文件内容的数据验证 C#如何使用JSON Schema或XML Schema验证文件结构

煙雲

煙雲

发布时间:2026-02-24 10:40:04

|

411人浏览过

|

来源于php中文网

原创

newtonsoft.json + jsonschema 验证需用 jobject.load() 加载 json 并调用 isvalid(),配合 jschema.parse() 解析 schema;须缓存线程安全的 jschema 实例,启用 path 获取 jsonpath 错误定位,避免反序列化绕过验证。

c# 文件内容的数据验证 c#如何使用json schema或xml schema验证文件结构

Newtonsoft.Json + JsonSchema 验证 JSON 文件结构

JSON Schema 验证在 C# 里不是 .NET 原生能力,得靠第三方库。目前最稳、文档最全、支持 Draft-04/06/07 的仍是 Newtonsoft.Json 生态里的 Newtonsoft.Json.Schema(注意:它已**停止维护**,但仍在大量生产项目中跑着;别用 NuGet 上标“preview”的新包,那是个半成品)。

常见错误是直接反序列化再手工比字段——这不算验证,只是“没崩”,漏掉类型错、必填项空、枚举越界等深层问题。

  • 安装时只加 Newtonsoft.JsonNewtonsoft.Json.Schema 两个包,别混 System.Text.Json 相关的验证逻辑,它们不兼容
  • Schema 文件必须是合法 JSON,且顶层是对象(不能是数组),否则 JSchema.Parse() 会抛 ArgumentException
  • 验证前先用 JObject.Load() 读文件,别用 JsonConvert.DeserializeObject<t>()</t>,后者会跳过 schema 检查直接转强类型
  • 示例片段:
    JObject data = JObject.Load(File.OpenText("input.json"));
    JSchema schema = JSchema.Parse(File.ReadAllText("schema.json"));
    IList<ValidationError> errors = new List<ValidationError>();
    bool valid = data.IsValid(schema, out errors);
    if (!valid) { foreach (var e in errors) Console.WriteLine(e.ToString()); }

XML 文件用 XmlSchemaSet + XmlReaderSettings 做结构校验

.NET 自带的 XML Schema(XSD)验证足够可靠,关键在设置 XmlReaderSettings 时别漏掉 ValidationType = ValidationType.SchemaSchemas.Add(),否则等于没开验证。

容易踩的坑是把 XSD 文件路径写错,或 XSD 里用了 xs:import 却没把被引用的 schema 一并 Add() 进去,这时会报 XmlSchemaException:“无法解析引用的命名空间”。

360AI导航
360AI导航

360导航旗下的AI网址导航站,精选互联网资源最全的AI人工智能网站

下载
  • 确保 XSD 文件编码为 UTF-8(无 BOM),否则 XmlSchema.Read() 可能静默失败
  • 如果 XML 有命名空间,XSD 中的 targetNamespace 必须和 XML 的 xmlns 完全一致,字符大小写敏感
  • 验证时用 XmlReader.Create(stream, settings) 包一层,不要直接 XDocument.Load(),后者不触发 schema 校验
  • 示例关键行:
    var settings = new XmlReaderSettings { ValidationType = ValidationType.Schema };
    settings.Schemas.Add("", "schema.xsd"); // 空字符串表示默认命名空间
    settings.ValidationEventHandler += (s, e) => Console.WriteLine(e.Message);
    using var reader = XmlReader.Create("data.xml", settings);

别在运行时动态编译 Schema(尤其是 JSON)

Newtonsoft.Json.SchemaJSchema.Parse() 内部会做语法树构建和类型推导,对大 Schema(>50KB)或高频调用场景(如 API 网关层),每次 Parse 都是明显性能瓶颈。有人图省事写成单例缓存,结果发现并发下 JSchema 实例不是线程安全的,偶尔验证结果错乱。

  • 正确做法:启动时一次性 Parse() 并缓存 JSchema 实例,用 ConcurrentDictionary<string jschema></string> 按文件名或哈希索引
  • XML 的 XmlSchemaSet 是线程安全的,可以放心单例复用
  • 如果 Schema 来自用户上传,务必加长度限制(如 max 256KB)和超时(CancellationToken),防止恶意构造的嵌套 schema 导致栈溢出

验证失败时,错误信息够不够定位?

默认的 ValidationError(JSON)或 XmlSchemaValidationException(XML)只告诉你“哪一行错了”,但不说明“为什么错”。比如 "age": "abc" 在要求 integer 的字段上,JSON Schema 错误信息可能是 “Expected integer, got string”,但不会指出是 $.user.profile.age 这个路径。

要拿到完整 JSONPath 或 XPath,必须手动遍历验证错误集合,拼接上下文。XML 方便些,异常里自带 LineNumberLinePosition;JSON 则得靠 ValidationError.Path 字段(需开启 JSchema.GenerationOptions = SchemaGenerationOptions.None 并确保原始 JSON 用 JObject 加载)。

  • JSON 场景下,检查 errors.Select(e => e.Path) 是否为空——为空说明是顶层语法错(比如多逗号),不是结构错
  • XML 场景下,ValidationEventArgs.Exception.LineNumber 是字节流位置,不是文件行号;若 XML 有 DTD 或注释,实际行号可能偏移
  • 别依赖错误消息做自动化修复(比如自动转类型),验证环节只负责报错,清洗逻辑放前面

验证逻辑本身不难写,难的是让错误可追溯、性能不掉队、边界情况不崩——尤其当 Schema 来自外部或随配置热更时,路径处理、缓存生命周期、命名空间对齐这些点,一个没卡准,就变成线上排查黑洞。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

448

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

323

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

850

2023.08.02

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1932

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2109

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1134

2024.11.28

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1228

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.6万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号