上位机开发实战手册 041. 序列化选型指南1.1 常见格式对比表格式/库优点缺点适用场景JSON Newtonsoft.Json灵活、生态成熟、多态支持第三方依赖配置复杂历史项目、Web APIJSON System.Text.Json现代、高性能、UTF-8行为与 Json.NET 不同现代 .NET 项目XML XmlSerializer可读、WCF 兼容属性契约、复杂厂商 XML、SOAPCSV CsvHelper简单、易编辑功能有限数据导入导出Protobuf高性能、紧凑需要 .protogRPC、内部 RPCINI/TOML人类可读功能简单简单配置BinaryFormatter简单严重安全风险禁止新用2. Newtonsoft.Json 详解2.1 安装与引用NuGet: Newtonsoft.Json命名空间Newtonsoft.Json官方文档https://www.newtonsoft.com/json2.2 核心 API 详解JsonConvert.SerializeObject(object)参数要序列化的对象返回值JSON 字符串示例varrecipenewRecipe{Name配方A,Setpoint100.5m};stringjsonJsonConvert.SerializeObject(recipe);// 输出{Name:配方A,Setpoint:100.5}JsonConvert.SerializeObject(object, JsonSerializerSettings)参数对象、设置返回值JSON 字符串设置常用项Formatting格式化Indented缩进None紧凑NullValueHandlingnull 值处理Include/IgnoreDefaultValueHandling默认值处理Include/IgnoreMissingMemberHandling缺失成员处理Ignore/ErrorReferenceLoopHandling循环引用处理Ignore/ErrorJsonConvert.DeserializeObject(string)参数JSON 字符串返回值T 类型对象异常JsonSerializationException示例ReciperecipeJsonConvert.DeserializeObjectRecipe(json);JsonConvert.DeserializeObject(string, Type)参数JSON 字符串、目标类型返回值object2.3 JsonSerializerSettings 配置详解varsettingsnewJsonSerializerSettings{// 格式化FormattingFormatting.Indented,// null 值处理NullValueHandlingNullValueHandling.Ignore,// 默认值处理DefaultValueHandlingDefaultValueHandling.Ignore,// 缺失成员处理MissingMemberHandlingMissingMemberHandling.Error,// 日期处理DateFormatHandlingDateFormatHandling.IsoDateFormat,DateParseHandlingDateParseHandling.DateTimeOffset,// 浮点精度FloatFormatHandlingFloatFormatHandling.Symbol,// 循环引用ReferenceLoopHandlingReferenceLoopHandling.Ignore,// 文化信息CultureCultureInfo.InvariantCulture};// 添加自定义转换器settings.Converters.Add(newStringEnumConverter());settings.Converters.Add(newDecimalRoundingConverter(2));2.4 特性Attribute详解[JsonProperty(“json_name”)]作用指定 JSON 字段名示例[JsonProperty(device_id)]publicstringDeviceId{get;set;}[JsonIgnore]作用跳过该属性示例[JsonIgnore]publicboolIsDirty{get;set;}[JsonConverter(typeof(ConverterType))]作用指定自定义转换器示例[JsonConverter(typeof(StringEnumConverter))]publicEquipmentStateState{get;set;}[JsonProperty(Required Required.Always)]作用指定必填字段示例[JsonProperty(RequiredRequired.Always)]publicstringName{get;set;}2.5 动态读取 JObject/JTokenusingNewtonsoft.Json.Linq;// 解析 JSONJObjectrootJObject.Parse(json);// 读取字段stringdeviceId(string)root[deviceId];double?value(double?)root.SelectToken(result.measurement.value);// 遍历所有属性foreach(JPropertypropertyinroot.Properties()){Console.WriteLine(${property.Name}:{property.Value});}// 动态创建varobjnewJObject{[name]设备1,[status]online,[timestamp]DateTimeOffset.UtcNow};2.6 安全注意事项不要启用 TypeNameHandling.All使用 ISerializationBinder 限制反序列化类型不可信数据一律视为有害限制 JSON 大小和深度3. System.Text.Json 详解3.1 与 Newtonsoft.Json 的区别特性System.Text.JsonNewtonsoft.Json默认大小写敏感不敏感枚举处理按数字按字符串需配置字段默认忽略包含性能更高略低类型现代 .NET 内置第三方3.2 核心 API 详解JsonSerializer.Serialize(TValue, JsonSerializerOptions)参数对象、选项返回值JSON 字符串示例varoptionsnewJsonSerializerOptions{WriteIndentedtrue,PropertyNameCaseInsensitivetrue,DefaultIgnoreConditionJsonIgnoreCondition.WhenWritingNull};stringjsonJsonSerializer.Serialize(recipe,options);JsonSerializer.Deserialize(string, JsonSerializerOptions)参数JSON 字符串、选项返回值T 类型对象示例ReciperecipeJsonSerializer.DeserializeRecipe(json,options);JsonSerializerOptions 配置varoptionsnewJsonSerializerOptions{// 缩进WriteIndentedtrue,// 属性名不区分大小写PropertyNameCaseInsensitivetrue,// 属性名大小写转换PropertyNamingPolicyJsonNamingPolicy.CamelCase,// null 值处理DefaultIgnoreConditionJsonIgnoreCondition.WhenWritingNull,// 编码器EncoderJavaScriptEncoder.UnsafeRelaxedJsonEscaping};// 添加枚举转换器options.Converters.Add(newJsonStringEnumConverter());3.3 特性详解[JsonPropertyName(“json_name”)]指定 JSON 名称[JsonIgnore]跳过属性[JsonConverter(typeof(ConverterType))]自定义转换器[JsonInclude]包含字段[JsonNumberHandling]数字处理方式3.4 文档对象模型DOMusingSystem.Text.Json;usingSystem.Text.Json.Nodes;// 解析JsonObjectobjJsonNode.Parse(json).AsObject();stringdeviceId(string)obj[deviceId];// 创建varobjnewJsonObject{[name]设备1,[status]online,[timestamp]DateTimeOffset.UtcNow};4. XML 序列化4.1 XmlSerializer 详解usingSystem.Xml.Serialization;// 序列化varserializernewXmlSerializer(typeof(Recipe));using(varwriternewStreamWriter(recipe.xml,false,newUTF8Encoding(false))){serializer.Serialize(writer,recipe);}// 反序列化using(varreadernewStreamReader(recipe.xml,Encoding.UTF8)){Recipeloaded(Recipe)serializer.Deserialize(reader);}4.2 常用特性[XmlRoot(“RootName”)]根元素名[XmlElement(“ElementName”)]元素名[XmlAttribute(“AttrName”)]属性名[XmlArray(“ArrayName”)]数组名[XmlIgnore]忽略字段4.3 安全注意禁用 DTDXmlReaderSettings.DtdProcessing DtdProcessing.Prohibit禁用外部实体限制 XML 大小5. CSV 文件处理5.1 CsvHelper 详解usingCsvHelper;usingSystem.Globalization;// 读取using(varreadernewStreamReader(data.csv,Encoding.UTF8))using(varcsvnewCsvReader(reader,CultureInfo.InvariantCulture)){varrecordscsv.GetRecordsMeasurementRecord().ToList();}// 写入using(varwriternewStreamWriter(data.csv,false,newUTF8Encoding(true)))using(varcsvnewCsvWriter(writer,CultureInfo.InvariantCulture)){csv.WriteRecords(measurements);}5.2 映射类publicclassMeasurementRecord{[CsvColumn(时间)]publicDateTimeTimestamp{get;set;}[CsvColumn(数值)]publicdoubleValue{get;set;}[CsvColumn(单位)]publicstringUnit{get;set;}}5.3 手工 CSV 解析// 简单场景字段不含逗号、引号varcolumnsline.Split(new[]{,},StringSplitOptions.RemoveEmptyEntries);// 复杂场景使用 CsvHelper 或自定义解析器6. 配置文件处理6.1 appsettings.json{Device:{Host:192.168.1.10,Port:502,ConnectTimeoutSeconds:3},Database:{Path:data/device.db}}6.2 强类型配置类publicclassDeviceOptions{publicconststringSectionNameDevice;publicstringHost{get;set;}127.0.0.1;publicintPort{get;set;}502;publicintConnectTimeoutSeconds{get;set;}3;}6.3 Microsoft.Extensions.Configuration// 注册配置builder.Configuration.SetBasePath(AppContext.BaseDirectory).AddJsonFile(appsettings.json,optional:false,reloadOnChange:true).AddEnvironmentVariables(prefix:DEVICE_);// 绑定配置builder.Services.ConfigureDeviceOptions(builder.Configuration.GetSection(DeviceOptions.SectionName));// 使用配置publicclassDeviceService{privatereadonlyDeviceOptions_options;publicDeviceService(IOptionsDeviceOptionsoptions){_optionsoptions.Value;}}6.4 INI 文件处理// 简单 INI 处理publicstaticclassIniFileHelper{[DllImport(kernel32.dll,CharSetCharSet.Unicode)]privatestaticexternintGetPrivateProfileString(stringsection,stringkey,stringdefaultValue,StringBuilderreturnValue,intreturnSize,stringfileName);publicstaticstringGetValue(stringpath,stringsection,stringkey,stringdefaultValue){varsbnewStringBuilder(255);GetPrivateProfileString(section,key,defaultValue,sb,255,path);returnsb.ToString();}}7. 完整实战示例7.1 配方配置管理publicclassRecipeManager{privatereadonlystring_configPath;privatereadonlyJsonSerializerSettings_settings;publicRecipeManager(stringconfigPath){_configPathconfigPath;_settingsnewJsonSerializerSettings{FormattingFormatting.Indented,NullValueHandlingNullValueHandling.Ignore,MissingMemberHandlingMissingMemberHandling.Error,Converters{newStringEnumConverter()}};}// 读取配方publicRecipeLoad(){if(!File.Exists(_configPath))thrownewFileNotFoundException(配方文件不存在,_configPath);stringjsonFile.ReadAllText(_configPath);returnJsonConvert.DeserializeObjectRecipe(json,_settings);}// 保存配方原子写入publicvoidSave(Reciperecipe){stringjsonJsonConvert.SerializeObject(recipe,_settings);// 临时文件 替换防止写入失败损坏配置stringtempPath_configPath.tmp;File.WriteAllText(tempPath,json);try{File.Replace(tempPath,_configPath,destinationBackupFileName:null);}catch{if(File.Exists(tempPath))File.Delete(tempPath);throw;}}// 验证配方publicValidationResultValidate(Reciperecipe){if(recipenull)returnValidationResult.Fail(配方不能为空);if(string.IsNullOrWhiteSpace(recipe.Name))returnValidationResult.Fail(配方名称不能为空);if(recipe.Setpoint0||recipe.Setpoint1000)returnValidationResult.Fail(设定值必须在 0-1000 范围内);returnValidationResult.Success();}}publicclassRecipe{[JsonProperty(name,RequiredRequired.Always)]publicstringName{get;set;};[JsonProperty(description)]publicstringDescription{get;set;};[JsonProperty(setpoint)]publicdecimalSetpoint{get;set;}[JsonProperty(state)][JsonConverter(typeof(StringEnumConverter))]publicRecipeStateState{get;set;}[JsonProperty(parameters)]publicDictionarystring,decimalParameters{get;set;}new();}publicenumRecipeState{Draft,Active,Archived}publicclassValidationResult{publicboolIsValid{get;}publicstringErrorMessage{get;}privateValidationResult(boolisValid,stringerrorMessage){IsValidisValid;ErrorMessageerrorMessage;}publicstaticValidationResultSuccess()new(true,);publicstaticValidationResultFail(stringmessage)new(false,message);}