Newtonsoft Json.NET is a de facto standard JSON library in .NET ecosystem. But it doesn't support Unity3D, so it's a little bit hard to use JSON.NET just after getting Json.NET package. This package is for Unity3D programmers that need to use latest Json.NET in Unity3D.
Visit Release page to get latest Json.NET unity-package.
To use this library in IL2CPP build settings, you need to add link.xml to your project's asset folder. For detailed information about link.xml, read unity manual about this.
Unity3D has old-fashioned and bizarre .NET Framework like these :)
Because Newtonsoft Json.NET doesn't handle these limitations, errors will welcome you when you use official Json.NET dll targetting .NET 3.5 Framework.
Following works are done to make Json.NET support Unity3D.
For Unity.Lite version, additional works are done to make more lite.
Tests in Json.NET are updated to be able to run under UnityEditor Test Runner. All tests pass under Microsoft .NET 3.5 but with UnityEditor some of them fail because there are not-implemented features and bugs in Unity3D-Mono framework.
Test Result:
Profile | :white_check_mark: Passed | :x: Failed | :white_circle: Ignored |
---|---|---|---|
Microsoft.NET | 1605 | 0 | 1 |
Unity3D-Mono | 1592 | 13 | 1 |
Detailed Description is here to tell you what failed and why.
This library is tested on Unity 4.7, 5.2 and 5.3. For AOT environment like iOS, you need to use IL2CPP instead of obsolute Mono-AOT because IL2CPP handles generic code better than Mono-AOT. With Mono-AOT configuration, AOT related exception would be thrown.
For windows store build, there is a compatibility issue related with UWP. If you have a problem, please read workaround for UWP.
MissingMethodException
is thrown for ComponentModel.TypeConverter
.MissingMethodException: Method not found:
Default constructor not found...ctor() of System.ComponentModel.TypeConverter.
Make sure that link.xml
is added to your project.
ExecutionEngineException
is thrown in calling CreateValueInternal
.xecutionEngineException:
Attempting to call method 'CLASS::.cctor' for which no ahead of time (AOT) code was generated.
at System.Reflection.MonoCMethod.Invoke (...)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal
This exception is thrown because Unity3D strips out unnecessary classes which are actually used by serialization.
To fix this problem, just put new CLASS()
in your code to prevent Unity3D from removing the class.
Reference: TroubleShootingIPhone
ArgumentNullException
is thrown in calling CreateParameterizedConstructor
.ArgumentNullException: Argument cannot be null.
Parameter name: method
at Newtonsoft.Json.Utilities.ValidationUtils.ArgumentNotNull (...)
at Newtonsoft.Json.Utilities.LateBoundReflectionDelegateFactory.CreateParameterizedConstructor (...)
This is similar with the previous case. But this case is tricky because this is
caused by Json.NET internal classes such as CollectionWrapper<T>
.
To fix this problem, put AotHelper.EnsureList<T>()
if you use HashSet<T>
or AotHelper.EnsureDictionary<TKey, TValue>()
if you use Dictionary<TKey, TValue>
in working class.