Newtonsoft.Json属性控制全攻略：从忽略到重命名的5种高级用法
Newtonsoft.Json属性控制全攻略：从忽略到重命名的5种高级用法
在C#开发中，处理JSON数据几乎成了日常工作的标配。Newtonsoft.Json（现也称Json.NET）作为.NET生态中最受欢迎的JSON库，其灵活性和强大功能让开发者爱不释手。但你是否真正掌握了它那些藏在细节里的高级特性？今天我们就来深入探讨那些能让你的JSON处理更优雅、更高效的属性控制技巧。
1. 属性忽略的艺术
属性忽略看似简单，实则暗藏玄机。最基本的用法是通过[JsonIgnore]特性标记不需要序列化的属性：
public class UserProfile { public string Username { get; set; } [JsonIgnore] public string PasswordHash { get; set; } // 安全考虑，不序列化 }但实际开发中，我们经常遇到更复杂的情况。比如，某个属性可能在某些场景下需要序列化，在其他场景下又需要忽略。这时可以使用ShouldSerialize方法模式：
public class Order { public decimal TotalAmount { get; set; } public bool IsDiscounted { get; set; } public bool ShouldSerializeTotalAmount() { return !IsDiscounted; // 只有在未打折时才序列化总金额 } }更灵活的方式是使用条件序列化：
public class Product { public string Name { get; set; } public decimal Price { get; set; } [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public decimal? DiscountedPrice { get; set; } // 为null时不序列化 }提示：
NullValueHandling.Ignore不仅能减少JSON体积，还能避免前端处理不必要的null值。
2. 属性重命名的巧妙应用
JSON属性名与C#属性名不一致时，[JsonProperty]就派上用场了。这在对接第三方API时特别常见：
public class WeatherData { [JsonProperty("temp_c")] public decimal TemperatureCelsius { get; set; } [JsonProperty("wind_kph")] public decimal WindSpeed { get; set; } }更高级的用法是动态重命名。假设我们需要根据当前文化设置决定使用哪个字段名：
public class LocalizedProduct { private string _name; [JsonProperty("name")] public string Name { get => CultureInfo.CurrentCulture.Name == "zh-CN" ? $"产品_{_name}" : _name; set => _name = value; } }对于枚举值的序列化控制，Newtonsoft.Json也提供了优雅的解决方案：
public enum UserRole { [JsonProperty("admin")] Administrator, [JsonProperty("user")] StandardUser, [JsonProperty("guest")] GuestUser } public class User { public UserRole Role { get; set; } }3. 默认值处理的智慧
处理默认值能显著优化JSON数据大小和清晰度。Newtonsoft.Json提供了多种方式控制默认值的序列化行为。
最基本的用法是指定默认值：
public class Settings { [DefaultValue(10)] public int MaxRetryCount { get; set; } = 10; }更精细的控制可以通过DefaultValueHandling实现：
public class Configuration { [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)] public int CacheSize { get; set; } // 默认值0时不序列化 [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)] public bool EnableLogging { get; set; } = true; // 反序列化时会填充默认值 }对于复杂对象的默认值处理，可以结合ShouldSerialize方法：
public class ReportOptions { public DateTime StartDate { get; set; } = DateTime.Today.AddMonths(-1); public DateTime EndDate { get; set; } = DateTime.Today; public bool ShouldSerializeStartDate() => StartDate != DateTime.Today.AddMonths(-1); public bool ShouldSerializeEndDate() => EndDate != DateTime.Today; }4. 序列化与反序列化的不对称控制
有时我们需要属性在序列化时被忽略，但在反序列化时能够接收值。这种不对称控制可以通过私有属性和[JsonProperty]的组合实现：
public class SecureData { [JsonIgnore] public string ApiKey { get; set; } [JsonProperty("api_key")] private string ApiKeyForDeserialization { set => ApiKey = Decrypt(value); // 反序列化时解密 } private string Decrypt(string value) => /* 解密逻辑 */; }另一种常见场景是只读属性的处理：
public class CalculatedResult { public decimal Value1 { get; set; } public decimal Value2 { get; set; } [JsonProperty] public decimal Sum => Value1 + Value2; // 序列化但不反序列化 // 防止反序列化时出错 private decimal SumForDeserialization { set { /* 忽略或特殊处理 */ } } }对于集合属性，我们可能希望反序列化时总是新建集合而非替换现有引用：
public class Team { private List<Member> _members = new List<Member>(); [JsonProperty(ObjectCreationHandling = ObjectCreationHandling.Reuse)] public List<Member> Members { get => _members; set => _members = value ?? new List<Member>(); } }5. 高级自定义与性能优化
当内置特性无法满足需求时，我们可以通过自定义JsonConverter实现完全控制：
public class UnixDateTimeConverter : JsonConverter { public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { var date = (DateTime)value; writer.WriteValue((date - new DateTime(1970,1,1)).TotalSeconds); } public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { return new DateTime(1970,1,1).AddSeconds((long)reader.Value); } public override bool CanConvert(Type objectType) => objectType == typeof(DateTime); } public class Event { [JsonConverter(typeof(UnixDateTimeConverter))] public DateTime Timestamp { get; set; } }对于性能敏感的场景，可以使用契约解析器(ContractResolver)预先定义序列化规则：
public class LowercaseContractResolver : DefaultContractResolver { protected override string ResolvePropertyName(string propertyName) { return propertyName.ToLower(); } } // 使用方式 var settings = new JsonSerializerSettings { ContractResolver = new LowercaseContractResolver() }; var json = JsonConvert.SerializeObject(obj, settings);最后，别忘了利用ReferenceLoopHandling处理循环引用问题：
var settings = new JsonSerializerSettings { ReferenceLoopHandling = ReferenceLoopHandling.Ignore, PreserveReferencesHandling = PreserveReferencesHandling.Objects };