前言
幾乎所有.NET序列化程序的實現基礎都是反射。下列代碼是Newtonsoft.Json的實現:
protectedvirtualJsonPropertyCreateProperty(MemberInfomember,MemberSerializationmemberSerialization) { JsonPropertyproperty=newJsonProperty(); property.PropertyType=ReflectionUtils.GetMemberUnderlyingType(member); property.DeclaringType=member.DeclaringType; property.ValueProvider=CreateMemberValueProvider(member); property.AttributeProvider=newReflectionAttributeProvider(member); ...... }
反射為某些場景提供了強大的功能,但相對于直接編碼,在運行性能上較差,例如Newtonsoft.Json就用緩存進行了優化:
publicvirtualJsonContractResolveContract(Typetype) { ValidationUtils.ArgumentNotNull(type,nameof(type)); return_contractCache.Get(type); }
而在.NET 6中,為System.Text.Json提供了Source Generator,可以在編譯時就生成序列化源代碼。
Demo
使用方法非常簡單。
只需實現一個繼承自JsonSerializerContext的類,并聲明JsonSerializable,指定序列化的類型:
[JsonSerializable(typeof(WeatherForecast))] internalpartialclassWeatherForecastContext:JsonSerializerContext { }
然后,就可以將自動生成的
WeatherForecastContext.Default.WeatherForecast對象作為參數用于序列化:
varstr=JsonSerializer.Serialize(newWeatherForecast { TemperatureC=Random.Shared.Next(-20,55), Summary=Summaries[Random.Shared.Next(Summaries.Length)] },WeatherForecastContext.Default.WeatherForecast); varobj=JsonSerializer.Deserialize(str,WeatherForecastContext.Default.WeatherForecast);
單步跟蹤,可以看到生成的序列化代碼如下,
privatestaticvoidWeatherForecastSerializeHandler(global::System.Text.Json.Utf8JsonWriterwriter,global::WebApplication1.WeatherForecast?value) { if(value==null) { writer.WriteNullValue(); return; } writer.WriteStartObject(); writer.WriteNumber(PropName_TemperatureC,value.TemperatureC); writer.WriteNumber(PropName_TemperatureF,value.TemperatureF); writer.WriteString(PropName_Summary,value.Summary); writer.WriteEndObject(); }
另外,還可以使用
JsonSourceGenerationOptionsAttribute對生成的序列化代碼進行一定調整,比如屬性名大小寫:
[JsonSourceGenerationOptions(PropertyNamingPolicy=JsonKnownNamingPolicy.CamelCase)] [JsonSerializable(typeof(WeatherForecast))] internalpartialclassWeatherForecastContext:JsonSerializerContext { }
結論
在編譯時生成源代碼可為.NET應用程序帶來許多好處,包括提高性能。官方提供的測試結果表明提高了接近40%,有興趣的朋友可以驗證一下: