-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
- Loading branch information
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 SaladLab | ||
|
||
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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Note | ||
|
||
## Assembly Size | ||
|
||
Newtonsoft Json.NET 8.0.2 | ||
- NET45: Json.NET for .NET45 | ||
- NET35: Json.NET for .NET35 | ||
- Unity = NET35 with Unity support | ||
- UnityLite = Unity - Json.Linq - Bson | ||
|
||
| | NET45 | NET35 | Unity | UnityLite | | ||
| :--------- | ------: | ------: | ------: | --------: | | ||
| String | 66,256 | 58,372 | 44,528 | 35,448 | | ||
| Blob | 44,116 | 34,628 | 25,268 | 19,668 | | ||
| UserString | 52,736 | 47,168 | 37,632 | 28,580 | | ||
| Guid | 16 | 16 | 16 | 16 | | ||
| Table | 153,708 | 117,064 | 87,212 | 61,576 | | ||
| Method | 169,310 | 154,787 | 119,086 | 89,958 | | ||
| Etc | 35,074 | 31,357 | 21,106 | 14,098 | | ||
| Total | 521,216 | 443,392 | 334,848 | 249,344 | | ||
| Relative | 100% | 85% | 64% | 47% | |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
[![Build status](https://ci.appveyor.com/api/projects/status/slry7u0dy894pevo/branch/master?svg=true)](https://ci.appveyor.com/project/veblush/json-net-unity3d/branch/master) | ||
|
||
# Newtonsoft Json.NET for Unity3D | ||
|
||
[Newtonsoft Json.NET](http://www.newtonsoft.com/json) 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](https://www.nuget.org/packages/Newtonsoft.Json/). | ||
This package is for Unity3D programmers that need to use latest Json.NET in Unity3D. | ||
|
||
## Where can I get it? | ||
|
||
Visit [Release](https://github.com/SaladLab/Json.Net.Unity3D/releases) | ||
page to get latest Json.NET unity-package. | ||
|
||
To use this library in IL2CPP build settings, you need to add | ||
[link.xml](https://github.com/SaladLab/Json.Net.Unity3D/blob/master/src/UnityPackage/Assets/link.xml) to your project's asset folder. | ||
For detailed information about link.xml, read unity [manual](http://docs.unity3d.com/Manual/iphone-playerSizeOptimization.html) about this. | ||
|
||
## What's the deal? | ||
|
||
Unity3D has old-fashioned and bizarre .NET Framework like these :) | ||
- Basically based on .NET Framework 3.5 ([forked Mono 2.6](https://github.com/Unity-Technologies/mono/commits/unity-staging)) | ||
- Runtime lacks some types in .NET Framework 3.5 (like System.ComponentModel.AddingNewEventHandler) | ||
- For iOS, dynamic code emission is forbidden by Apple AppStore. | ||
|
||
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. | ||
|
||
## What's done? | ||
|
||
Following works are done to make Json.NET support Unity3D. | ||
|
||
- Based on Newtonsoft Json.NET 9. | ||
- Disable IL generation to work well under AOT environment like iOS. | ||
- Remove code related with System.ComponentModel. | ||
- Remove System.Data and EntityKey support. | ||
- Remove XML support. | ||
- Remove DiagnosticsTraceWriter support. | ||
- Workaround for differences between Microsoft.NET & Unity3D-Mono.NET | ||
|
||
For Unity.Lite version, additional works are done to make more lite. | ||
|
||
- Remove JsonLinq, JPath (JToken, ...) | ||
- Remove Bson | ||
|
||
## Unit Test | ||
|
||
Tests in Json.NET are updated to be able to run under | ||
[UnityEditor Test Runner](http://docs.unity3d.com/Manual/testing-editortestsrunner.html). | ||
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](./docs/UnitTest.md) to tell you what failed and why. | ||
|
||
## Unity Compatibility | ||
|
||
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](./docs/UwpWorkaround.md). | ||
|
||
## FAQ | ||
|
||
#### Q: `MissingMethodException` is thrown for `ComponentModel.TypeConverter`. | ||
|
||
```csharp | ||
MissingMethodException: Method not found: | ||
Default constructor not found...ctor() of System.ComponentModel.TypeConverter. | ||
``` | ||
|
||
Make sure that `link.xml` is added to your project. | ||
|
||
#### Q: `ExecutionEngineException` is thrown in calling `CreateValueInternal`. | ||
|
||
```csharp | ||
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](https://docs.unity3d.com/Manual/TroubleShootingIPhone.html) | ||
|
||
#### Q: `ArgumentNullException` is thrown in calling `CreateParameterizedConstructor`. | ||
|
||
```csharp | ||
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. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
|
||
The managed BZIP2 code included in Ionic.BZip2.dll and Ionic.Zip.dll is | ||
modified code, based on the bzip2 code in the Apache commons compress | ||
library. | ||
|
||
The original BZip2 was created by Julian Seward, and is licensed under | ||
the BSD license. | ||
|
||
The following license applies to the Apache code: | ||
----------------------------------------------------------------------- | ||
|
||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.