From 32f882b5d60f8654ba9b831199512048a45a7207 Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Mon, 21 May 2018 11:17:19 +1200 Subject: [PATCH] Fixed serializing abstract base class ISerializable on .NET Core (#1712) --- Src/Newtonsoft.Json.Tests/Issues/Issue1682.cs | 102 ++++++++++++++++++ .../Serialization/DefaultContractResolver.cs | 11 +- .../JsonSerializerInternalReader.cs | 5 + 3 files changed, 114 insertions(+), 4 deletions(-) create mode 100644 Src/Newtonsoft.Json.Tests/Issues/Issue1682.cs diff --git a/Src/Newtonsoft.Json.Tests/Issues/Issue1682.cs b/Src/Newtonsoft.Json.Tests/Issues/Issue1682.cs new file mode 100644 index 00000000..ce8868ef --- /dev/null +++ b/Src/Newtonsoft.Json.Tests/Issues/Issue1682.cs @@ -0,0 +1,102 @@ +#region License +// Copyright (c) 2007 James Newton-King +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +#endregion + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Reflection; +using System.Reflection.Emit; +using System.Runtime.Serialization; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Newtonsoft.Json.Serialization; +using Newtonsoft.Json.Utilities; +#if DNXCORE50 +using Xunit; +using Test = Xunit.FactAttribute; +using Assert = Newtonsoft.Json.Tests.XUnitAssert; +#else +using NUnit.Framework; +#endif + +namespace Newtonsoft.Json.Tests.Issues +{ + [TestFixture] + public class Issue1682 : TestFixtureBase + { + [Test] + public void Test_Serialize() + { + string s1 = JsonConvert.SerializeObject(new ConcreteSerializable()); + Assert.AreEqual("{}", s1); + + string s2 = JsonConvert.SerializeObject(new ClassWithSerializableProperty()); + Assert.AreEqual(@"{""Serializable"":null}", s2); + } + + [Test] + public void Test_Deserialize() + { + ExceptionAssert.Throws( + () => { JsonConvert.DeserializeObject("{}"); }, + "Could not create an instance of type Newtonsoft.Json.Tests.Issues.Issue1682+BaseSerializable. Type is an interface or abstract class and cannot be instantiated. Path '', line 1, position 2."); + } + + public class ClassWithSerializableProperty + { + public BaseSerializable Serializable { get; } + } + + [Serializable] + public class ConcreteSerializable : BaseSerializable + { + public ConcreteSerializable() + { + } + + protected ConcreteSerializable(SerializationInfo info, StreamingContext context) + : base(info, context) + { + } + } + + [Serializable] // it won't blow up after removing that attribute + public abstract class BaseSerializable : ISerializable //or that interface, or when we will remove "abstract" keyword + { + public BaseSerializable() + { + } + + //it won't fail when that constructor is missing + protected BaseSerializable(SerializationInfo info, StreamingContext context) + { + } + + public void GetObjectData(SerializationInfo info, StreamingContext context) + { + } + } + } +} \ No newline at end of file diff --git a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs index 5fe7e13b..de0c07d9 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs @@ -1093,12 +1093,15 @@ namespace Newtonsoft.Json.Serialization JsonISerializableContract contract = new JsonISerializableContract(objectType); InitializeContract(contract); - ConstructorInfo constructorInfo = contract.NonNullableUnderlyingType.GetConstructor(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance, null, new[] { typeof(SerializationInfo), typeof(StreamingContext) }, null); - if (constructorInfo != null) + if (contract.IsInstantiable) { - ObjectConstructor creator = JsonTypeReflector.ReflectionDelegateFactory.CreateParameterizedConstructor(constructorInfo); + ConstructorInfo constructorInfo = contract.NonNullableUnderlyingType.GetConstructor(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance, null, new[] {typeof(SerializationInfo), typeof(StreamingContext)}, null); + if (constructorInfo != null) + { + ObjectConstructor creator = JsonTypeReflector.ReflectionDelegateFactory.CreateParameterizedConstructor(constructorInfo); - contract.ISerializableCreator = creator; + contract.ISerializableCreator = creator; + } } return contract; diff --git a/Src/Newtonsoft.Json/Serialization/JsonSerializerInternalReader.cs b/Src/Newtonsoft.Json/Serialization/JsonSerializerInternalReader.cs index a37888f3..12d53453 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonSerializerInternalReader.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonSerializerInternalReader.cs @@ -1706,6 +1706,11 @@ namespace Newtonsoft.Json.Serialization ThrowUnexpectedEndException(reader, contract, serializationInfo, "Unexpected end when deserializing object."); } + if (!contract.IsInstantiable) + { + throw JsonSerializationException.Create(reader, "Could not create an instance of type {0}. Type is an interface or abstract class and cannot be instantiated.".FormatWith(CultureInfo.InvariantCulture, contract.UnderlyingType)); + } + if (contract.ISerializableCreator == null) { throw JsonSerializationException.Create(reader, "ISerializable type '{0}' does not have a valid constructor. To correctly implement ISerializable a constructor that takes SerializationInfo and StreamingContext parameters should be present.".FormatWith(CultureInfo.InvariantCulture, objectType));