├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ ├── publish.yml │ └── test.yml ├── .gitignore ├── JsonKnownTypes.sln ├── LICENSE ├── README.md ├── resources ├── json.net.png ├── v0.3.0.png └── v0.4.1.png ├── src └── JsonKnownTypes │ ├── AttributesManager.cs │ ├── DiscriminatorValues.cs │ ├── DiscriminatorValuesManager.cs │ ├── Exceptions │ └── JsonKnownTypesException.cs │ ├── JsonDiscriminatorAttribute.cs │ ├── JsonDiscriminatorSettings.cs │ ├── JsonKnownProxyWriter.cs │ ├── JsonKnownThisTypeAttribute.cs │ ├── JsonKnownTypeAttribute.cs │ ├── JsonKnownTypeFallbackAttribute.cs │ ├── JsonKnownTypes.csproj │ ├── JsonKnownTypesCache.cs │ ├── JsonKnownTypesConverter.cs │ ├── JsonKnownTypesSettingsManager.cs │ ├── Properties │ └── AssemblyInfo.cs │ └── Utils │ └── Mapper.cs └── tests ├── JsonKnownTypes.Benchmark ├── JsonKnownTypes.Benchmark.csproj └── Program.cs └── JsonKnownTypes.UnitTests ├── ClassInClass.cs ├── ClassInItself.cs ├── DeserializeTest.cs ├── DiscriminatorValuesTest.cs ├── FallbackType.cs ├── InheritedWithManyTypes.cs ├── InterfaceInInterface.cs ├── JsonKnownTypes.UnitTests.csproj ├── LongTypesHierarchy.cs ├── SettingsTest.cs ├── TypesHierarchy.cs ├── WithBaseAbstractClass.cs ├── WithBaseClass.cs ├── WithBaseClassWithException.cs ├── WithBaseInterface.cs └── WithChildrenClasses.cs /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: dmitry-bym 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: dmitry-bym 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Nuget package 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | build-test-pack: 9 | 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v2 15 | 16 | - name: Restore dependencies 17 | run: dotnet restore 18 | 19 | - name: Build 20 | run: dotnet build --no-restore --configuration Release 21 | 22 | - name: Pack 23 | run: dotnet pack ./src/JsonKnownTypes/JsonKnownTypes.csproj --output nupkgs --no-build --configuration Release -p:PackageVersion=${{ github.event.release.tag_name }} 24 | 25 | - name: Push 26 | run: dotnet nuget push ./nupkgs/JsonKnownTypes.${{ github.event.release.tag_name }}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} 27 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build-and-test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v2 15 | 16 | - name: Restore dependencies 17 | run: dotnet restore 18 | 19 | - name: Build 20 | run: dotnet build --no-restore --configuration Release 21 | 22 | - name: Test 23 | run: dotnet test --no-build --verbosity normal --configuration Release 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Thumbs.db 2 | # Photoshop PSD files 3 | *.psd 4 | 5 | # Configuration file 6 | Application.config 7 | appsecrets.json 8 | 9 | # Build Folders (you can keep bin if you'd like, to store dlls and pdbs) 10 | [Bb]in/ 11 | [Oo]bj/ 12 | 13 | # mstest test results 14 | TestResults 15 | 16 | ## Ignore IDE files 17 | .vs/ 18 | .idea/ 19 | 20 | # User-specific files 21 | *.suo 22 | *.user 23 | *.sln.docstates 24 | 25 | # Build results 26 | [Dd]ebug/ 27 | [Rr]elease/ 28 | x64/ 29 | *_i.c 30 | *_p.c 31 | *.ilk 32 | *.meta 33 | *.obj 34 | *.pch 35 | *.pdb 36 | *.pgc 37 | *.pgd 38 | *.rsp 39 | *.sbr 40 | *.tlb 41 | *.tli 42 | *.tlh 43 | *.tmp 44 | *.log 45 | *.vspscc 46 | *.vssscc 47 | .builds 48 | 49 | # Visual C++ cache files 50 | ipch/ 51 | *.aps 52 | *.ncb 53 | *.opensdf 54 | *.sdf 55 | 56 | # Visual Studio profiler 57 | *.psess 58 | *.vsp 59 | *.vspx 60 | 61 | # Guidance Automation Toolkit 62 | *.gpState 63 | 64 | # ReSharper is a .NET coding add-in 65 | _ReSharper* 66 | 67 | # DocProject is a documentation generator add-in 68 | DocProject/buildhelp/ 69 | DocProject/Help/*.HxT 70 | DocProject/Help/*.HxC 71 | DocProject/Help/*.hhc 72 | DocProject/Help/*.hhk 73 | DocProject/Help/*.hhp 74 | DocProject/Help/Html2 75 | DocProject/Help/html 76 | 77 | # Click-Once directory 78 | publish 79 | 80 | # Publish Web Output 81 | *.Publish.xml 82 | 83 | # NuGet Packages Directory 84 | **/packages/* 85 | !repositories.config 86 | 87 | # Windows Azure Build Output 88 | csx 89 | *.build.csdef 90 | 91 | # Windows Store app package directory 92 | AppPackages/ 93 | 94 | # Others 95 | [Bb]in 96 | [Oo]bj 97 | sql 98 | TestResults 99 | [Tt]est[Rr]esult* 100 | *.Cache 101 | ClientBin 102 | [Ss]tyle[Cc]op.* 103 | ~$* 104 | *.dbmdl 105 | Generated_Code #added for RIA/Silverlight projects 106 | -------------------------------------------------------------------------------- /JsonKnownTypes.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.29806.167 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonKnownTypes", "src\JsonKnownTypes\JsonKnownTypes.csproj", "{B629F0C4-EAE9-4965-AC47-61DBD4A800D7}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonKnownTypes.UnitTests", "tests\JsonKnownTypes.UnitTests\JsonKnownTypes.UnitTests.csproj", "{3DE82BA5-F66A-4E39-AC18-427D22778E32}" 9 | EndProject 10 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonKnownTypes.Benchmark", "tests\JsonKnownTypes.Benchmark\JsonKnownTypes.Benchmark.csproj", "{F8736333-CFCC-4C27-9199-7EC2134AE462}" 11 | EndProject 12 | Global 13 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 14 | Debug|Any CPU = Debug|Any CPU 15 | Release|Any CPU = Release|Any CPU 16 | EndGlobalSection 17 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 18 | {B629F0C4-EAE9-4965-AC47-61DBD4A800D7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 19 | {B629F0C4-EAE9-4965-AC47-61DBD4A800D7}.Debug|Any CPU.Build.0 = Debug|Any CPU 20 | {B629F0C4-EAE9-4965-AC47-61DBD4A800D7}.Release|Any CPU.ActiveCfg = Release|Any CPU 21 | {B629F0C4-EAE9-4965-AC47-61DBD4A800D7}.Release|Any CPU.Build.0 = Release|Any CPU 22 | {3DE82BA5-F66A-4E39-AC18-427D22778E32}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 23 | {3DE82BA5-F66A-4E39-AC18-427D22778E32}.Debug|Any CPU.Build.0 = Debug|Any CPU 24 | {3DE82BA5-F66A-4E39-AC18-427D22778E32}.Release|Any CPU.ActiveCfg = Release|Any CPU 25 | {3DE82BA5-F66A-4E39-AC18-427D22778E32}.Release|Any CPU.Build.0 = Release|Any CPU 26 | {F8736333-CFCC-4C27-9199-7EC2134AE462}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 27 | {F8736333-CFCC-4C27-9199-7EC2134AE462}.Debug|Any CPU.Build.0 = Debug|Any CPU 28 | {F8736333-CFCC-4C27-9199-7EC2134AE462}.Release|Any CPU.ActiveCfg = Release|Any CPU 29 | {F8736333-CFCC-4C27-9199-7EC2134AE462}.Release|Any CPU.Build.0 = Release|Any CPU 30 | EndGlobalSection 31 | GlobalSection(SolutionProperties) = preSolution 32 | HideSolutionNode = FALSE 33 | EndGlobalSection 34 | GlobalSection(ExtensibilityGlobals) = postSolution 35 | SolutionGuid = {3A3709DD-2FB8-4AE8-8474-7F78EA160167} 36 | EndGlobalSection 37 | EndGlobal 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Dmitry Kaznacheev 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # JsonKnownTypes .Net Standard 2 | [![nuget](https://img.shields.io/nuget/v/JsonKnownTypes?style=flat-square)](https://www.nuget.org/packages/JsonKnownTypes) 3 | [![downloads](https://img.shields.io/nuget/dt/JsonKnownTypes?style=flat-square)](https://www.nuget.org/packages/JsonKnownTypes) 4 | [![lisence](https://img.shields.io/badge/lisence-MIT-green?style=flat-square)](https://github.com/dmitry-bym/JsonKnownTypes/blob/master/LICENSE) 5 | 6 | Helps to serialize and deserialize polymorphic types. Adds discriminator to json. 7 | 8 | - [Documentation](#Documentation) 9 | - [Breaking changes](#Breaking-changes) 10 | - [How to help us?](#How-to-help-us) 11 | - [License](#License) 12 | 13 | ### Comparison with other solutions 14 | Check this issue https://github.com/dmitry-bym/JsonKnownTypes/issues/35 15 | 16 | ## Swashbuckle Support 17 | To add discriminator to swagger(OpenAPI) scheme use this package [JsonKnownTypes.Swashbuckle](https://github.com/dmitry-bym/JsonKnownTypes.Swashbuckle) 18 | 19 | ## Requirements 20 | - NET Standard 2.0 compatible project 21 | - [Json.NET](https://github.com/JamesNK/Newtonsoft.Json) by Newtonsoft 22 | 23 | ## Documentation 24 | ### Getting started 25 | The simplest way to use it is to add one attribute to base class or interface: 26 | ```c# 27 | [JsonConverter(typeof(JsonKnownTypesConverter))] 28 | public class BaseClass 29 | { 30 | public string Summary { get; set; } 31 | } 32 | 33 | public class ChildClass : BaseClass 34 | { 35 | public string Detailed { get; set; } 36 | } 37 | ``` 38 | Serialization and Deserialization: 39 | ```c# 40 | var entityJson = JsonConvert.SerializeObject(entity); 41 | var obj = DeserializeObject(entityJson) 42 | ``` 43 | Json representation: 44 | ```json 45 | { "Summary":"someValue", "$type":"BaseClass" } 46 | { "Summary":"someValue", "Detailed":"someValue", "$type":"ChildClass" } 47 | ``` 48 | ### Using with Interfaces or Abstract classes 49 | Also, you can use it with interfaces or abstract classes: 50 | #### Interface 51 | ```c# 52 | [JsonConverter(typeof(JsonKnownTypesConverter))] 53 | public interface IInterface { ... } 54 | 55 | public class ChildClass : IInterface { ... } 56 | ``` 57 | Json representation: 58 | ``` 59 | { ... "$type":"ChildClass" } 60 | ``` 61 | #### Abstract class 62 | ```c# 63 | [JsonConverter(typeof(JsonKnownTypesConverter))] 64 | public abstract class AbstractClass { ... } 65 | 66 | public class ChildClass : AbstractClass { ... } 67 | ``` 68 | Json representation: 69 | ``` 70 | { ... "$type":"ChildClass" } 71 | ``` 72 | ### JsonKnownType 73 | If you need to add a custom discriminator use `JsonKnownType` attribute. 74 | By default, `"$type"` is used for discriminator property name, if you need to change that use `JsonDiscriminator` attribute. 75 | ```c# 76 | [JsonConverter(typeof(JsonKnownTypesConverter))] 77 | [JsonDiscriminator(Name = "myType")] //add custom discriminator name 78 | [JsonKnownType(typeof(BaseClass1Heir))] //could be deleted if you didn't turn off UseClassNameAsDiscriminator 79 | [JsonKnownType(typeof(BaseClass2Heir), "myDiscriminator")] 80 | public class BaseClass { ... } 81 | 82 | public class BaseClass1Heir : BaseClass { ... } 83 | 84 | public class BaseClass2Heir : BaseClass { ... } 85 | ``` 86 | Json representation: 87 | ``` 88 | { ... , "myType":"BaseClass" } 89 | 90 | { ... , "myType":"BaseClass1Heir" } 91 | 92 | { ... , "myType":"myDiscriminator" } 93 | ``` 94 | ### JsonKnownThisType 95 | Add a discriminator for type which is used with it: 96 | ```c# 97 | [JsonConverter(typeof(JsonKnownTypesConverter))] 98 | [JsonKnownThisType("do_you_know_that")] 99 | public class BaseClass { ... } 100 | 101 | [JsonKnownThisType("html_is_programming_language")] 102 | public class BaseClass1Heir : BaseClass { ... } 103 | 104 | [JsonKnownThisType("just_joke=)")] 105 | public class BaseClass2Heir : BaseClass { ... } 106 | ``` 107 | Json representation: 108 | ``` 109 | { ... , "$type":"do_you_know_that" } 110 | 111 | { ... , "$type":"html_is_programming_language" } 112 | 113 | { ... , "$type":"just_joke=)" } 114 | ``` 115 | ### Configuration 116 | To change default discriminator settings use: 117 | ```c# 118 | JsonKnownTypesSettingsManager.DefaultDiscriminatorSettings = new JsonDiscriminatorSettings 119 | { 120 | DiscriminatorFieldName = "name", 121 | UseClassNameAsDiscriminator = false 122 | }; 123 | ``` 124 | > `DiscriminatorFieldName` change default `"$type"` name to yours 125 | 126 | > If `UseClassNameAsDiscriminator` is `false` you should add `JsonKnownType` or `JsonKnownThisType` attribute for each relative class manually otherwise it will throw an exception. 127 | 128 | If you want to add derived types from another assembly you can set custom type resolver `Func`: 129 | ```c# 130 | JsonKnownTypesSettingsManager.GetDerivedByBase = parent => parent.Assembly.GetTypes(); 131 | ``` 132 | ### Use manually 133 | ```c# 134 | public class BaseClass { ... } 135 | public class BaseAbstractClass1Heir : BaseClass { ... } 136 | public class BaseAbstractClass2Heir : BaseClass { ... } 137 | ``` 138 | ```c# 139 | var converter = new JsonKnownTypesConverter() 140 | 141 | var entityJson = JsonConvert.SerializeObject(entity, converter); 142 | var obj = DeserializeObject(entityJson, converter) 143 | ``` 144 | > You have to pass a converter directly to method if you do not use `JsonConverter` attribute. 145 | ### Fallback type deserialization 146 | Normally you will receive an exception during deserialization of models marked with unknown or 147 | unspecified type discriminator. If you need an exception-free way you can use `JsonKnownTypeFallback` attribute. 148 | In that case entities marked with unknown or missing type discriminator will be deserialized to specified fallback type. 149 | See example. 150 | 151 | Assume you have a bunch of events coming from webhook/frontend/etc.: 152 | ```json5 153 | [ 154 | { id: "abc", opType: "op_start" }, 155 | { id: "bcd", opType: "on_save" }, 156 | { id: "cde", opType: "op_update" }, 157 | { id: "def", opType: "op_end" } 158 | ] 159 | ``` 160 | Then in your application you can do the following to handle only events you are only interested of: 161 | ```c# 162 | [JsonConverter(typeof(JsonKnownTypesConverter))] 163 | [JsonDiscriminator(Name = "opType")] 164 | [JsonKnownType(typeof(OperationStarted), "op_start")] 165 | [JsonKnownType(typeof(OperationEnded), "op_end")] 166 | [JsonKnownTypeFallback(typeof(UnsupportedOperation))] 167 | public abstract class OperationBase 168 | { 169 | public string Id { get; set; } 170 | } 171 | 172 | public class OperationStarted : OperationBase { } 173 | public class OperationEnded : OperationBase { } 174 | public class UnsupportedOperation : OperationBase { } 175 | ``` 176 | 177 | ### Breaking changes 178 | Documented API can be changed, because it is `zero` version still. And I'm trying to find better solution and always add some fixes and this fixes also can change some behavior. 179 | 180 | There are a lot of undocumented public API and you can use it but i can change it any time. 181 | 182 | So when you install new version check all of these. 183 | 184 | ## How to help us? 185 | 186 | I need feedback, if you have suggestion or some issue create an issue and describe it, even if you think it's not critical. 187 | 188 | Also you can buy me a coffee 🤗 189 | 190 | Buy Me A Coffee 191 | 192 | ## License 193 | 194 | Authored by: Dmitry Kaznacheev (dmitry-bym) 195 | 196 | This project is under MIT license. You can obtain the license copy [here](https://github.com/dmitry-bym/JsonKnownTypes/blob/master/LICENSE). 197 | 198 | This work using work of James Newton-King, author of Json.NET. https://www.newtonsoft.com/json 199 | -------------------------------------------------------------------------------- /resources/json.net.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmitry-bym/JsonKnownTypes/f86feddcad0a3ab53b2d93f0ac33aacf054f7606/resources/json.net.png -------------------------------------------------------------------------------- /resources/v0.3.0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmitry-bym/JsonKnownTypes/f86feddcad0a3ab53b2d93f0ac33aacf054f7606/resources/v0.3.0.png -------------------------------------------------------------------------------- /resources/v0.4.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmitry-bym/JsonKnownTypes/f86feddcad0a3ab53b2d93f0ac33aacf054f7606/resources/v0.4.1.png -------------------------------------------------------------------------------- /src/JsonKnownTypes/AttributesManager.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | internal static class AttributesManager 6 | { 7 | internal static JsonKnownTypeAttribute[] GetJsonKnownAttributes(Type type) => 8 | (JsonKnownTypeAttribute[])Attribute.GetCustomAttributes(type, typeof(JsonKnownTypeAttribute)); 9 | 10 | internal static JsonKnownThisTypeAttribute GetJsonKnownThisAttribute(Type type) => 11 | (JsonKnownThisTypeAttribute)Attribute.GetCustomAttribute(type, typeof(JsonKnownThisTypeAttribute)); 12 | 13 | internal static JsonDiscriminatorAttribute GetJsonDiscriminatorAttribute(Type type) => 14 | (JsonDiscriminatorAttribute)Attribute.GetCustomAttribute(type, typeof(JsonDiscriminatorAttribute)); 15 | 16 | internal static JsonKnownTypeFallbackAttribute GetJsonKnownTypeFallbackAttribute(Type type) => 17 | (JsonKnownTypeFallbackAttribute)Attribute.GetCustomAttribute(type, typeof(JsonKnownTypeFallbackAttribute)); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/DiscriminatorValues.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using JsonKnownTypes.Exceptions; 4 | 5 | namespace JsonKnownTypes 6 | { 7 | public class DiscriminatorValues 8 | { 9 | public string FieldName { get; } 10 | public Type BaseType { get; } 11 | private readonly Dictionary _discriminatorToType; 12 | private readonly Dictionary _typeToDiscriminator; 13 | private readonly bool _useBaseTypeForCanConvert; 14 | 15 | public DiscriminatorValues(Type baseType, string fieldName, bool useBaseTypeForCanConvert) 16 | { 17 | BaseType = baseType; 18 | FieldName = fieldName; 19 | _useBaseTypeForCanConvert = useBaseTypeForCanConvert; 20 | _discriminatorToType = new Dictionary(); 21 | _typeToDiscriminator = new Dictionary(); 22 | } 23 | 24 | public bool CanConvert(Type type) 25 | { 26 | return _useBaseTypeForCanConvert ? type == BaseType : Contains(type); 27 | } 28 | 29 | public Type FallbackType { get; private set; } 30 | 31 | public int Count => _typeToDiscriminator.Count; 32 | 33 | public bool TryGetDiscriminator(Type type, out string discriminator) 34 | => _typeToDiscriminator.TryGetValue(type, out discriminator); 35 | 36 | public bool TryGetType(string discriminator, out Type type) 37 | { 38 | var discriminatorIsNull = discriminator == null; 39 | var fallbackTypeExists = FallbackType != null; 40 | 41 | Type existingType = null; 42 | // ReSharper disable once SimplifyConditionalTernaryExpression 43 | var typeExists = discriminatorIsNull 44 | ? false 45 | : _discriminatorToType.TryGetValue(discriminator, out existingType); 46 | 47 | switch (discriminatorIsNull, fallbackTypeExists, typeExists) 48 | { 49 | case (true, true, _): 50 | type = FallbackType; 51 | return true; 52 | 53 | case (false, _, true): 54 | type = existingType; 55 | return true; 56 | 57 | case (false, true, false): 58 | type = FallbackType; 59 | return true; 60 | 61 | default: 62 | type = null; 63 | return false; 64 | } 65 | } 66 | 67 | public bool Contains(Type type) => _typeToDiscriminator.ContainsKey(type); 68 | 69 | public bool Contains(string discriminator) => _discriminatorToType.ContainsKey(discriminator); 70 | 71 | public void AddType(Type type, string discriminator) 72 | { 73 | if (type == null) 74 | throw new JsonKnownTypesException("null passed as type"); 75 | 76 | if (string.IsNullOrWhiteSpace(discriminator)) 77 | throw new JsonKnownTypesException($"Invalid discriminator for {type} type"); 78 | 79 | if (_typeToDiscriminator.ContainsKey(type)) 80 | throw new JsonKnownTypesException($"{type} type already registered"); 81 | 82 | if (_discriminatorToType.ContainsKey(discriminator)) 83 | throw new JsonKnownTypesException($"{discriminator} discriminator already in use"); 84 | 85 | _typeToDiscriminator.Add(type, discriminator); 86 | _discriminatorToType.Add(discriminator, type); 87 | } 88 | 89 | public void AddFallbackType(Type type) 90 | { 91 | if (FallbackType != null) 92 | throw new JsonKnownTypesException($"{FallbackType} fallback type is already registered"); 93 | 94 | FallbackType = type; 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/DiscriminatorValuesManager.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | internal static class DiscriminatorValuesManager 6 | { 7 | internal static void AddJsonKnown(this DiscriminatorValues discriminatorValues) 8 | { 9 | var attrs = AttributesManager.GetJsonKnownAttributes(typeof(T)); 10 | foreach (var attr in attrs) 11 | { 12 | var discriminator = attr.Discriminator ?? attr.Type.Name; 13 | discriminatorValues.AddType(attr.Type, discriminator); 14 | } 15 | 16 | var fallbackTypeAttribute = AttributesManager.GetJsonKnownTypeFallbackAttribute(typeof(T)); 17 | if (fallbackTypeAttribute != null) 18 | { 19 | discriminatorValues.AddFallbackType(fallbackTypeAttribute.FallbackType); 20 | } 21 | } 22 | 23 | internal static void AddJsonKnownThis(this DiscriminatorValues discriminatorValues, Type[] inherited) 24 | { 25 | foreach (var type in inherited) 26 | { 27 | var attr = AttributesManager.GetJsonKnownThisAttribute(type); 28 | if (attr != null) 29 | { 30 | var discriminator = attr.Discriminator ?? type.Name; 31 | discriminatorValues.AddType(type, discriminator); 32 | } 33 | } 34 | } 35 | 36 | internal static void AddAutoDiscriminators(this DiscriminatorValues discriminatorValues, Type[] inherited) 37 | { 38 | foreach (var type in inherited) 39 | { 40 | if (discriminatorValues.Contains(type)) 41 | continue; 42 | 43 | discriminatorValues.AddType(type, type.Name); 44 | } 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/Exceptions/JsonKnownTypesException.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes.Exceptions 4 | { 5 | public class JsonKnownTypesException : Exception 6 | { 7 | internal JsonKnownTypesException(string message) 8 | : base(message) 9 | { } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonDiscriminatorAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | /// 6 | /// Manage discriminator settings 7 | /// 8 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface)] 9 | public class JsonDiscriminatorAttribute : Attribute 10 | { 11 | /// 12 | /// Discriminator field name in json representation 13 | /// 14 | public string Name { get; set; } 15 | 16 | /// 17 | /// Use JsonKnownTypesConverter with base class ONLY https://github.com/dmitry-bym/JsonKnownTypes/issues/26 18 | /// 19 | public bool UseBaseTypeForCanConvert 20 | { 21 | get => UseBaseType != false; 22 | set => UseBaseType = value; 23 | } 24 | 25 | internal bool? UseBaseType; 26 | 27 | 28 | /// 29 | /// Use class name as discriminator if JsonKnown attribute didn't add 30 | /// 31 | public bool UseClassNameAsDiscriminator 32 | { 33 | get => AutoJson != false; 34 | set => AutoJson = value; 35 | } 36 | 37 | internal bool? AutoJson; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonDiscriminatorSettings.cs: -------------------------------------------------------------------------------- 1 | namespace JsonKnownTypes 2 | { 3 | public class JsonDiscriminatorSettings 4 | { 5 | /// 6 | /// Discriminator field name in json representation 7 | /// 8 | public string DiscriminatorFieldName { get; set; } = "$type"; 9 | 10 | /// 11 | /// Use class name as discriminator if JsonKnown attribute hasn't been added 12 | /// 13 | public bool UseClassNameAsDiscriminator { get; set; } = true; 14 | 15 | /// 16 | /// Use JsonKnownTypesConverter with base class ONLY https://github.com/dmitry-bym/JsonKnownTypes/issues/26 17 | /// 18 | public bool UseBaseTypeForCanConvert { get; set; } = false; 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownProxyWriter.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Threading; 3 | using System.Threading.Tasks; 4 | using Newtonsoft.Json; 5 | 6 | namespace JsonKnownTypes 7 | { 8 | internal class JsonKnownProxyWriter : JsonWriter 9 | { 10 | private readonly string _fieldName; 11 | private readonly string _disc; 12 | private bool _discriminatorWritten; 13 | private readonly JsonWriter _writer; 14 | 15 | public JsonKnownProxyWriter(string fieldName, string disc, JsonWriter writer) 16 | { 17 | _discriminatorWritten = false; 18 | _fieldName = fieldName; 19 | _disc = disc; 20 | _writer = writer; 21 | } 22 | 23 | public override void WriteStartObject() 24 | { 25 | _writer.WriteStartObject(); 26 | 27 | if (_discriminatorWritten == false) 28 | { 29 | _writer.WritePropertyName(_fieldName); 30 | _writer.WriteValue(_disc); 31 | _discriminatorWritten = true; 32 | } 33 | } 34 | 35 | public void Dispose() => ((IDisposable) _writer).Dispose(); 36 | 37 | public override Task CloseAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.CloseAsync(cancellationToken); 38 | 39 | public override Task FlushAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.FlushAsync(cancellationToken); 40 | 41 | public override Task WriteRawAsync(string json, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteRawAsync(json, cancellationToken); 42 | 43 | public override Task WriteEndAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteEndAsync(cancellationToken); 44 | 45 | public override Task WriteEndArrayAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteEndArrayAsync(cancellationToken); 46 | 47 | public override Task WriteEndConstructorAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteEndConstructorAsync(cancellationToken); 48 | 49 | public override Task WriteEndObjectAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteEndObjectAsync(cancellationToken); 50 | 51 | public override Task WriteNullAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteNullAsync(cancellationToken); 52 | 53 | public override Task WritePropertyNameAsync(string name, CancellationToken cancellationToken = new CancellationToken()) => _writer.WritePropertyNameAsync(name, cancellationToken); 54 | 55 | public override Task WritePropertyNameAsync(string name, bool escape, CancellationToken cancellationToken = new CancellationToken()) => _writer.WritePropertyNameAsync(name, escape, cancellationToken); 56 | 57 | public override Task WriteStartArrayAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteStartArrayAsync(cancellationToken); 58 | 59 | public override Task WriteCommentAsync(string text, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteCommentAsync(text, cancellationToken); 60 | 61 | public override Task WriteRawValueAsync(string json, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteRawValueAsync(json, cancellationToken); 62 | 63 | public override Task WriteStartConstructorAsync(string name, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteStartConstructorAsync(name, cancellationToken); 64 | 65 | public override Task WriteStartObjectAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteStartObjectAsync(cancellationToken); 66 | 67 | public override Task WriteValueAsync(bool value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 68 | 69 | public override Task WriteValueAsync(bool? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 70 | 71 | public override Task WriteValueAsync(byte value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 72 | 73 | public override Task WriteValueAsync(byte? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 74 | 75 | public override Task WriteValueAsync(byte[] value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 76 | 77 | public override Task WriteValueAsync(char value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 78 | 79 | public override Task WriteValueAsync(char? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 80 | 81 | public override Task WriteValueAsync(DateTime value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 82 | 83 | public override Task WriteValueAsync(DateTime? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 84 | 85 | public override Task WriteValueAsync(DateTimeOffset value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 86 | 87 | public override Task WriteValueAsync(DateTimeOffset? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 88 | 89 | public override Task WriteValueAsync(decimal value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 90 | 91 | public override Task WriteValueAsync(decimal? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 92 | 93 | public override Task WriteValueAsync(double value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 94 | 95 | public override Task WriteValueAsync(double? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 96 | 97 | public override Task WriteValueAsync(float value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 98 | 99 | public override Task WriteValueAsync(float? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 100 | 101 | public override Task WriteValueAsync(Guid value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 102 | 103 | public override Task WriteValueAsync(Guid? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 104 | 105 | public override Task WriteValueAsync(int value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 106 | 107 | public override Task WriteValueAsync(int? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 108 | 109 | public override Task WriteValueAsync(long value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 110 | 111 | public override Task WriteValueAsync(long? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 112 | 113 | public override Task WriteValueAsync(object value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 114 | 115 | public override Task WriteValueAsync(sbyte value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 116 | 117 | public override Task WriteValueAsync(sbyte? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 118 | 119 | public override Task WriteValueAsync(short value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 120 | 121 | public override Task WriteValueAsync(short? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 122 | 123 | public override Task WriteValueAsync(string value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 124 | 125 | public override Task WriteValueAsync(TimeSpan value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 126 | 127 | public override Task WriteValueAsync(TimeSpan? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 128 | 129 | public override Task WriteValueAsync(uint value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 130 | 131 | public override Task WriteValueAsync(uint? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 132 | 133 | public override Task WriteValueAsync(ulong value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 134 | 135 | public override Task WriteValueAsync(ulong? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 136 | 137 | public override Task WriteValueAsync(Uri value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 138 | 139 | public override Task WriteValueAsync(ushort value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 140 | 141 | public override Task WriteValueAsync(ushort? value, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteValueAsync(value, cancellationToken); 142 | 143 | public override Task WriteUndefinedAsync(CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteUndefinedAsync(cancellationToken); 144 | 145 | public override Task WriteWhitespaceAsync(string ws, CancellationToken cancellationToken = new CancellationToken()) => _writer.WriteWhitespaceAsync(ws, cancellationToken); 146 | 147 | public override void Flush() => _writer.Flush(); 148 | 149 | public override void Close() => _writer.Close(); 150 | 151 | public override void WriteEndObject() => _writer.WriteEndObject(); 152 | 153 | public override void WriteStartArray() => _writer.WriteStartArray(); 154 | 155 | public override void WriteEndArray() => _writer.WriteEndArray(); 156 | 157 | public override void WriteStartConstructor(string name) => _writer.WriteStartConstructor(name); 158 | 159 | public override void WriteEndConstructor() => _writer.WriteEndConstructor(); 160 | 161 | public override void WritePropertyName(string name) => _writer.WritePropertyName(name); 162 | 163 | public override void WritePropertyName(string name, bool escape) => _writer.WritePropertyName(name, escape); 164 | 165 | public override void WriteEnd() => _writer.WriteEnd(); 166 | 167 | public override void WriteNull() => _writer.WriteNull(); 168 | 169 | public override void WriteUndefined() => _writer.WriteUndefined(); 170 | 171 | public override void WriteRaw(string json) => _writer.WriteRaw(json); 172 | 173 | public override void WriteRawValue(string json) => _writer.WriteRawValue(json); 174 | 175 | public override void WriteValue(string value) => _writer.WriteValue(value); 176 | 177 | public override void WriteValue(int value) => _writer.WriteValue(value); 178 | 179 | public override void WriteValue(uint value) => _writer.WriteValue(value); 180 | 181 | public override void WriteValue(long value) => _writer.WriteValue(value); 182 | 183 | public override void WriteValue(ulong value) => _writer.WriteValue(value); 184 | 185 | public override void WriteValue(float value) => _writer.WriteValue(value); 186 | 187 | public override void WriteValue(double value) => _writer.WriteValue(value); 188 | 189 | public override void WriteValue(bool value) => _writer.WriteValue(value); 190 | 191 | public override void WriteValue(short value) => _writer.WriteValue(value); 192 | 193 | public override void WriteValue(ushort value) => _writer.WriteValue(value); 194 | 195 | public override void WriteValue(char value) => _writer.WriteValue(value); 196 | 197 | public override void WriteValue(byte value) => _writer.WriteValue(value); 198 | 199 | public override void WriteValue(sbyte value) => _writer.WriteValue(value); 200 | 201 | public override void WriteValue(decimal value) => _writer.WriteValue(value); 202 | 203 | public override void WriteValue(DateTime value) => _writer.WriteValue(value); 204 | 205 | public override void WriteValue(DateTimeOffset value) => _writer.WriteValue(value); 206 | 207 | public override void WriteValue(Guid value) => _writer.WriteValue(value); 208 | 209 | public override void WriteValue(TimeSpan value) => _writer.WriteValue(value); 210 | 211 | public override void WriteValue(int? value) => _writer.WriteValue(value); 212 | 213 | public override void WriteValue(uint? value) => _writer.WriteValue(value); 214 | 215 | public override void WriteValue(long? value) => _writer.WriteValue(value); 216 | 217 | public override void WriteValue(ulong? value) => _writer.WriteValue(value); 218 | 219 | public override void WriteValue(float? value) => _writer.WriteValue(value); 220 | 221 | public override void WriteValue(double? value) => _writer.WriteValue(value); 222 | 223 | public override void WriteValue(bool? value) => _writer.WriteValue(value); 224 | 225 | public override void WriteValue(short? value) => _writer.WriteValue(value); 226 | 227 | public override void WriteValue(ushort? value) => _writer.WriteValue(value); 228 | 229 | public override void WriteValue(char? value) => _writer.WriteValue(value); 230 | 231 | public override void WriteValue(byte? value) => _writer.WriteValue(value); 232 | 233 | public override void WriteValue(sbyte? value) => _writer.WriteValue(value); 234 | 235 | public override void WriteValue(decimal? value) => _writer.WriteValue(value); 236 | 237 | public override void WriteValue(DateTime? value) => _writer.WriteValue(value); 238 | 239 | public override void WriteValue(DateTimeOffset? value) => _writer.WriteValue(value); 240 | 241 | public override void WriteValue(Guid? value) => _writer.WriteValue(value); 242 | 243 | public override void WriteValue(TimeSpan? value) => _writer.WriteValue(value); 244 | 245 | public override void WriteValue(byte[] value) => _writer.WriteValue(value); 246 | 247 | public override void WriteValue(Uri value) => _writer.WriteValue(value); 248 | 249 | public override void WriteValue(object value) => _writer.WriteValue(value); 250 | 251 | public override void WriteComment(string text) => _writer.WriteComment(text); 252 | 253 | public override void WriteWhitespace(string ws) => _writer.WriteWhitespace(ws); 254 | } 255 | } 256 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownThisTypeAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | /// 6 | /// Add discriminator to type which is used with 7 | /// 8 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface, Inherited = false)] 9 | public class JsonKnownThisTypeAttribute : Attribute 10 | { 11 | public string Discriminator { get; } 12 | 13 | public JsonKnownThisTypeAttribute() 14 | { } 15 | 16 | public JsonKnownThisTypeAttribute(string discriminator) 17 | { 18 | Discriminator = discriminator; 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypeAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | /// 6 | /// Add discriminator to specified type 7 | /// 8 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface, AllowMultiple = true)] 9 | public class JsonKnownTypeAttribute : Attribute 10 | { 11 | public Type Type { get; } 12 | 13 | public string Discriminator { get; } 14 | 15 | public JsonKnownTypeAttribute(Type type) 16 | { 17 | Type = type; 18 | } 19 | 20 | public JsonKnownTypeAttribute(Type type, string discriminator) 21 | { 22 | Type = type; 23 | Discriminator = discriminator; 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypeFallbackAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace JsonKnownTypes 4 | { 5 | /// 6 | /// Adds fallback type when type lookup fails. 7 | /// 8 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface)] 9 | public class JsonKnownTypeFallbackAttribute : Attribute 10 | { 11 | public Type FallbackType { get; } 12 | 13 | public JsonKnownTypeFallbackAttribute(Type fallbackType) 14 | { 15 | FallbackType = fallbackType ?? throw new ArgumentNullException(nameof(fallbackType)); 16 | } 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypes.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | netstandard2.0 5 | 8.0 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | true 19 | 0.5.2 20 | Dmitry Kaznacheev 21 | https://github.com/dmitry-bym/JsonKnownTypes 22 | Dmitry Kaznacheev 23 | https://github.com/dmitry-bym/JsonKnownTypes 24 | json known polymorphic types 25 | LICENSE 26 | README.md 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypesCache.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Concurrent; 3 | 4 | namespace JsonKnownTypes 5 | { 6 | 7 | public static class JsonKnownTypesCache 8 | { 9 | /// 10 | /// Dictionary with base type as key and discriminator field name as value 11 | /// 12 | public static readonly ConcurrentDictionary TypeToDiscriminator 13 | = new ConcurrentDictionary(); 14 | 15 | /// 16 | /// Bag with all discriminator values 17 | /// 18 | public static readonly ConcurrentBag DiscriminatorValues = 19 | new ConcurrentBag(); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypesConverter.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Threading; 3 | using JsonKnownTypes.Exceptions; 4 | using Newtonsoft.Json; 5 | using Newtonsoft.Json.Linq; 6 | 7 | namespace JsonKnownTypes 8 | { 9 | /// 10 | /// Convert an object with discriminator to and from JSON 11 | /// 12 | public class JsonKnownTypesConverter : JsonConverter 13 | { 14 | private static readonly DiscriminatorValues TypesDiscriminatorValues; 15 | 16 | static JsonKnownTypesConverter() 17 | { 18 | TypesDiscriminatorValues = JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 19 | JsonKnownTypesCache.TypeToDiscriminator.TryAdd(typeof(T), TypesDiscriminatorValues.FieldName); 20 | JsonKnownTypesCache.DiscriminatorValues.Add(TypesDiscriminatorValues); 21 | } 22 | 23 | public override bool CanConvert(Type objectType) 24 | { 25 | return TypesDiscriminatorValues.CanConvert(objectType); 26 | } 27 | 28 | private readonly ThreadLocal _isInRead = new ThreadLocal(); 29 | 30 | public override bool CanRead => !IsInReadAndReset(); 31 | 32 | private bool IsInReadAndReset() 33 | { 34 | if (_isInRead.Value) 35 | { 36 | _isInRead.Value = false; 37 | return true; 38 | } 39 | 40 | return false; 41 | } 42 | 43 | public override object ReadJson(JsonReader reader, Type objectType, object existingValue, 44 | JsonSerializer serializer) 45 | { 46 | if (reader.TokenType == JsonToken.Null) return null; 47 | 48 | var jObject = JObject.Load(reader); 49 | 50 | var discriminator = jObject[TypesDiscriminatorValues.FieldName]?.Value(); 51 | 52 | if (TypesDiscriminatorValues.TryGetType(discriminator, out var typeForObject)) 53 | { 54 | var jsonReader = jObject.CreateReader(); 55 | 56 | if (objectType == typeForObject) 57 | _isInRead.Value = true; 58 | 59 | try 60 | { 61 | var obj = serializer.Deserialize(jsonReader, typeForObject); 62 | return obj; 63 | } 64 | finally 65 | { 66 | _isInRead.Value = false; 67 | } 68 | } 69 | 70 | var discriminatorName = string.IsNullOrWhiteSpace(discriminator) ? "" : discriminator; 71 | throw new JsonKnownTypesException( 72 | $"{discriminatorName} discriminator is not registered for {nameof(T)} type"); 73 | } 74 | 75 | private readonly ThreadLocal _isInWrite = new ThreadLocal(); 76 | 77 | public override bool CanWrite => !IsInWriteAndReset(); 78 | 79 | private bool IsInWriteAndReset() 80 | { 81 | if (_isInWrite.Value) 82 | { 83 | _isInWrite.Value = false; 84 | return true; 85 | } 86 | 87 | return false; 88 | } 89 | 90 | public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) 91 | { 92 | if (value == null) 93 | { 94 | writer.WriteNull(); 95 | return; 96 | } 97 | 98 | var objectType = value.GetType(); 99 | 100 | if (TypesDiscriminatorValues.FallbackType != null && objectType == TypesDiscriminatorValues.FallbackType) 101 | { 102 | _isInWrite.Value = true; 103 | try 104 | { 105 | serializer.Serialize(writer, value); 106 | } 107 | finally 108 | { 109 | _isInWrite.Value = false; 110 | } 111 | 112 | return; 113 | } 114 | 115 | if (TypesDiscriminatorValues.TryGetDiscriminator(objectType, out var discriminator)) 116 | { 117 | _isInWrite.Value = true; 118 | 119 | var writerProxy = new JsonKnownProxyWriter(TypesDiscriminatorValues.FieldName, discriminator, writer); 120 | 121 | try 122 | { 123 | serializer.Serialize(writerProxy, value); 124 | } 125 | finally 126 | { 127 | _isInWrite.Value = false; 128 | } 129 | } 130 | else 131 | { 132 | throw new JsonKnownTypesException($"There is no discriminator for {objectType.Name} type"); 133 | } 134 | } 135 | } 136 | } 137 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/JsonKnownTypesSettingsManager.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using JsonKnownTypes.Utils; 4 | 5 | namespace JsonKnownTypes 6 | { 7 | public static class JsonKnownTypesSettingsManager 8 | { 9 | /// 10 | /// Default settings for discriminator 11 | /// 12 | public static JsonDiscriminatorSettings DefaultDiscriminatorSettings { get; set; } = 13 | new JsonDiscriminatorSettings(); 14 | 15 | /// 16 | /// Function for search derived classes (By default in base class assembly only) 17 | /// 18 | public static Func GetDerivedByBase = 19 | parent => parent.Assembly.GetTypes(); 20 | 21 | internal static DiscriminatorValues GetDiscriminatorValues() 22 | { 23 | var discriminatorAttribute = AttributesManager.GetJsonDiscriminatorAttribute(typeof(T)); 24 | 25 | var discriminatorSettings = discriminatorAttribute == null 26 | ? DefaultDiscriminatorSettings 27 | : Mapper.Map(discriminatorAttribute, DefaultDiscriminatorSettings); 28 | 29 | var typeSettings = new DiscriminatorValues(typeof(T), discriminatorSettings.DiscriminatorFieldName, discriminatorSettings.UseBaseTypeForCanConvert); 30 | 31 | typeSettings.AddJsonKnown(); 32 | 33 | var allTypes = GetFilteredDerived(); 34 | typeSettings.AddJsonKnownThis(allTypes); 35 | 36 | if (discriminatorSettings.UseClassNameAsDiscriminator) 37 | { 38 | typeSettings.AddAutoDiscriminators(allTypes); 39 | } 40 | 41 | return typeSettings; 42 | } 43 | 44 | private static Type[] GetFilteredDerived() 45 | { 46 | var type = typeof(T); 47 | return GetDerivedByBase(type) 48 | .Where(x => type.IsAssignableFrom(x) && !x.IsInterface && !x.IsAbstract) 49 | .ToArray(); 50 | } 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | 3 | [assembly: InternalsVisibleTo("JsonKnownTypes.UnitTests")] 4 | -------------------------------------------------------------------------------- /src/JsonKnownTypes/Utils/Mapper.cs: -------------------------------------------------------------------------------- 1 | namespace JsonKnownTypes.Utils 2 | { 3 | internal static class Mapper 4 | { 5 | internal static JsonDiscriminatorSettings Map(JsonDiscriminatorAttribute entity, JsonDiscriminatorSettings defaultSettings) 6 | { 7 | var settings = new JsonDiscriminatorSettings 8 | { 9 | DiscriminatorFieldName = entity.Name ?? defaultSettings.DiscriminatorFieldName, 10 | UseClassNameAsDiscriminator = entity.AutoJson ?? defaultSettings.UseClassNameAsDiscriminator, 11 | UseBaseTypeForCanConvert = entity.UseBaseType ?? defaultSettings.UseBaseTypeForCanConvert 12 | }; 13 | 14 | return settings; 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.Benchmark/JsonKnownTypes.Benchmark.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | Exe 5 | netcoreapp3.1 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.Benchmark/Program.cs: -------------------------------------------------------------------------------- 1 | using System.Linq; 2 | using AutoFixture; 3 | using BenchmarkDotNet.Attributes; 4 | using BenchmarkDotNet.Running; 5 | using JsonKnownTypes; 6 | using Newtonsoft.Json; 7 | 8 | namespace JsonKnownTypes.Benchmark 9 | { 10 | class Program 11 | { 12 | static void Main(string[] args) 13 | => BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args); 14 | 15 | } 16 | } 17 | 18 | [MemoryDiagnoser] 19 | public class JsonKnownTypesBenchmark 20 | { 21 | [Benchmark] 22 | public string AutoBaseAbstractClass1HeirSerialize() 23 | => JsonConvert.SerializeObject(Data1); 24 | 25 | public static BaseAbstractClass1Heir[] Data1 26 | = new Fixture().CreateMany(100000).ToArray(); 27 | 28 | [Benchmark] 29 | public string AutoBaseAbstractClass2HeirSerialize() 30 | => JsonConvert.SerializeObject(Data2); 31 | 32 | public static BaseAbstractClass2Heir[] Data2 33 | = new Fixture().CreateMany(100000).ToArray(); 34 | 35 | [Benchmark] 36 | public BaseAbstractClass[] AutoBaseAbstractClass1HeirDeserialize() 37 | => JsonConvert.DeserializeObject(Data1De); 38 | 39 | public static string Data1De 40 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000)); 41 | 42 | [Benchmark] 43 | public BaseAbstractClass[] AutoBaseAbstractClass2HeirDeserialize() 44 | => JsonConvert.DeserializeObject(Data2De); 45 | 46 | public static string Data2De 47 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000)); 48 | 49 | 50 | [JsonConverter(typeof(JsonKnownTypesConverter))] 51 | [JsonDiscriminator(Name = "Type")] 52 | [JsonKnownType(typeof(BaseAbstractClass1Heir), "Heir1")] 53 | [JsonKnownType(typeof(BaseAbstractClass2Heir), "Heir2")] 54 | public class BaseAbstractClass 55 | { 56 | public string Summary { get; set; } 57 | } 58 | 59 | public class BaseAbstractClass1Heir : BaseAbstractClass 60 | { 61 | public int SomeInt { get; set; } 62 | } 63 | 64 | public class BaseAbstractClass2Heir : BaseAbstractClass 65 | { 66 | public double SomeDouble { get; set; } 67 | public string Detailed { get; set; } 68 | } 69 | } 70 | 71 | 72 | [MemoryDiagnoser] 73 | public class NewtonsoftCleanBenchmark 74 | { 75 | [Benchmark] 76 | public string AutoBaseAbstractClass1HeirSerialize() 77 | => JsonConvert.SerializeObject(Data1); 78 | 79 | public static BaseAbstractClass1Heir[] Data1 80 | = new Fixture().CreateMany(100000).ToArray(); 81 | 82 | [Benchmark] 83 | public string AutoBaseAbstractClass2HeirSerialize() 84 | => JsonConvert.SerializeObject(Data2); 85 | 86 | public static BaseAbstractClass2Heir[] Data2 87 | = new Fixture().CreateMany(100000).ToArray(); 88 | 89 | [Benchmark] 90 | public BaseAbstractClass[] AutoBaseAbstractClass1HeirDeserialize() 91 | => JsonConvert.DeserializeObject(Data1De); 92 | 93 | public static string Data1De 94 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000)); 95 | 96 | [Benchmark] 97 | public BaseAbstractClass[] AutoBaseAbstractClass2HeirDeserialize() 98 | => JsonConvert.DeserializeObject(Data2De); 99 | 100 | public static string Data2De 101 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000)); 102 | 103 | public class BaseAbstractClass 104 | { 105 | public string Summary { get; set; } 106 | } 107 | 108 | public class BaseAbstractClass1Heir : BaseAbstractClass 109 | { 110 | public int SomeInt { get; set; } 111 | } 112 | 113 | public class BaseAbstractClass2Heir : BaseAbstractClass 114 | { 115 | public double SomeDouble { get; set; } 116 | public string Detailed { get; set; } 117 | } 118 | } 119 | 120 | [MemoryDiagnoser] 121 | public class NewtonsoftTypeNameHandlingAllBenchmark 122 | { 123 | [Benchmark] 124 | public string AutoBaseAbstractClass1HeirSerialize() 125 | => JsonConvert.SerializeObject(Data1, new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 126 | 127 | public static BaseAbstractClass1Heir[] Data1 128 | = new Fixture().CreateMany(100000).ToArray(); 129 | 130 | [Benchmark] 131 | public string AutoBaseAbstractClass2HeirSerialize() 132 | => JsonConvert.SerializeObject(Data2, new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 133 | 134 | public static BaseAbstractClass2Heir[] Data2 135 | = new Fixture().CreateMany(100000).ToArray(); 136 | 137 | [Benchmark] 138 | public BaseAbstractClass[] AutoBaseAbstractClass1HeirDeserialize() 139 | => JsonConvert.DeserializeObject(Data1De, new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 140 | 141 | public static string Data1De 142 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000).ToArray(), new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 143 | 144 | [Benchmark] 145 | public BaseAbstractClass[] AutoBaseAbstractClass2HeirDeserialize() 146 | => JsonConvert.DeserializeObject(Data2De, new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 147 | 148 | public static string Data2De 149 | = JsonConvert.SerializeObject(new Fixture().CreateMany(100000).ToArray(), new JsonSerializerSettings{TypeNameHandling = TypeNameHandling.All}); 150 | 151 | public class BaseAbstractClass 152 | { 153 | public string Summary { get; set; } 154 | } 155 | 156 | public class BaseAbstractClass1Heir : BaseAbstractClass 157 | { 158 | public int SomeInt { get; set; } 159 | } 160 | 161 | public class BaseAbstractClass2Heir : BaseAbstractClass 162 | { 163 | public double SomeDouble { get; set; } 164 | public string Detailed { get; set; } 165 | } 166 | } -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/ClassInClass.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using NUnit.Framework; 5 | 6 | namespace JsonKnownTypes.UnitTests 7 | { 8 | public class ClassInClass 9 | { 10 | [Test] 11 | public void BaseClassTest() 12 | { 13 | var c = new ClassWithClass 14 | { 15 | Name = "Test0", 16 | Children = new List 17 | { 18 | new() 19 | { 20 | Name = "name" 21 | }, 22 | new ClassWithClass 23 | { 24 | Name = "name1", 25 | Children = new List 26 | { 27 | new() 28 | { 29 | Name = "name12" 30 | } 31 | } 32 | } 33 | } 34 | }; 35 | 36 | There_is_right_discriminator(c); 37 | } 38 | 39 | private void There_is_right_discriminator(ClassWithClass entity) 40 | { 41 | var json = JsonConvert.SerializeObject(entity); 42 | 43 | var obj = JsonConvert.DeserializeObject(json); 44 | 45 | obj.Should().BeEquivalentTo(entity); 46 | } 47 | } 48 | 49 | [JsonConverter(typeof(JsonKnownTypesConverter))] 50 | public class ClassWithClassBase 51 | { 52 | public string Name { get; set; } 53 | 54 | } 55 | 56 | public class ClassWithClass : ClassWithClassBase 57 | { 58 | public List Children { get; set; } = new(); 59 | } 60 | 61 | } 62 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/ClassInItself.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture; 2 | using AutoFixture.NUnit3; 3 | using FluentAssertions; 4 | using Newtonsoft.Json; 5 | using Newtonsoft.Json.Linq; 6 | using NUnit.Framework; 7 | 8 | namespace JsonKnownTypes.UnitTests 9 | { 10 | public class ClassInItself 11 | { 12 | [Test] 13 | public void BaseClassTest() 14 | { 15 | var baseClass = new BaseClass {FieldBaseClass = new BaseClassHeir {FieldBaseClass = null, Summary = "aaa"}}; 16 | There_is_right_discriminator(baseClass); 17 | } 18 | 19 | private void There_is_right_discriminator(BaseClass entity) 20 | { 21 | var json = JsonConvert.SerializeObject(entity); 22 | var jObject = JToken.Parse(json); 23 | 24 | var discriminator = jObject["$type"]?.Value(); 25 | var obj = JsonConvert.DeserializeObject(json); 26 | 27 | obj.Should().BeEquivalentTo(entity); 28 | Assert.AreEqual(discriminator, entity.GetType().Name); 29 | } 30 | 31 | [JsonConverter(typeof(JsonKnownTypesConverter))] 32 | [JsonDiscriminator(UseClassNameAsDiscriminator = false)] 33 | [JsonKnownThisType] 34 | public class BaseClass 35 | { 36 | public BaseClass FieldBaseClass { get; set; } 37 | } 38 | 39 | [JsonKnownThisType] 40 | public class BaseClassHeir : BaseClass 41 | { 42 | public string Summary { get; set; } 43 | } 44 | 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/DeserializeTest.cs: -------------------------------------------------------------------------------- 1 | using JsonKnownTypes.Exceptions; 2 | using Newtonsoft.Json; 3 | using NUnit.Framework; 4 | 5 | namespace JsonKnownTypes.UnitTests 6 | { 7 | [TestFixture] 8 | public class DeserializeTest 9 | { 10 | [Test] 11 | [TestCase("{\"field\":\"value\"}")] 12 | [TestCase("{\"field\":\"value\", \"disc\":\"\"}")] 13 | [TestCase("{\"field\":\"value\", \"disc\":\"unknowndisc\"}")] 14 | public void Deserialize_wi4thout_discriminator(string json) => 15 | Assert.Throws(delegate 16 | { 17 | JsonConvert.DeserializeObject(json); 18 | }); 19 | 20 | 21 | [JsonConverter(typeof(JsonKnownTypesConverter))] 22 | [JsonKnownType(typeof(DeserializeTestClass), "disc")] 23 | class DeserializeTestClass 24 | { 25 | public string field { get; set; } 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/DiscriminatorValuesTest.cs: -------------------------------------------------------------------------------- 1 | using NUnit.Framework; 2 | 3 | namespace JsonKnownTypes.UnitTests 4 | { 5 | [TestFixture] 6 | public class DiscriminatorValuesTest 7 | { 8 | private record TestRecord(string FieldOne); 9 | private record TestHeir(string FieldOne, int FieldTwo) : TestRecord(FieldOne); 10 | private record TestFallback(string FieldOne, int FieldTwo) : TestRecord(FieldOne); 11 | 12 | [Test] 13 | public void CorrectDiscriminatorFieldNameAndBaseType() 14 | { 15 | var discriminatorFieldName = "discriminator"; 16 | var expectedBaseType = typeof(TestRecord); 17 | 18 | var discriminatorValues = new DiscriminatorValues(expectedBaseType, discriminatorFieldName, false); 19 | 20 | Assert.AreEqual(discriminatorFieldName, discriminatorValues.FieldName); 21 | Assert.AreEqual(expectedBaseType, discriminatorValues.BaseType); 22 | } 23 | 24 | [Test] 25 | public void GetCorrectTypeAndDiscriminator() 26 | { 27 | var discriminatorValues = new DiscriminatorValues(typeof(TestRecord), "name", false); 28 | 29 | discriminatorValues.AddType(typeof(TestHeir), nameof(TestHeir)); 30 | 31 | var result = discriminatorValues.TryGetDiscriminator(typeof(TestHeir), out var disc); 32 | var result1 = discriminatorValues.TryGetType(nameof(TestHeir), out var type); 33 | 34 | Assert.True(result); 35 | Assert.True(result1); 36 | 37 | Assert.AreEqual(nameof(TestHeir), disc); 38 | Assert.AreEqual(typeof(TestHeir), type); 39 | } 40 | 41 | [Test] 42 | public void GetCorrectFallbackType() 43 | { 44 | var discriminatorValues = new DiscriminatorValues(typeof(TestRecord), "name", false); 45 | 46 | discriminatorValues.AddType(typeof(TestRecord), nameof(TestRecord)); 47 | discriminatorValues.AddFallbackType(typeof(TestFallback)); 48 | 49 | var result = discriminatorValues.TryGetType(nameof(TestHeir), out var type); 50 | 51 | Assert.True(result); 52 | 53 | Assert.AreEqual(typeof(TestFallback), type); 54 | Assert.AreEqual(typeof(TestFallback), discriminatorValues.FallbackType); 55 | } 56 | 57 | [Test] 58 | public void CorrectContains() 59 | { 60 | var discriminatorValues = new DiscriminatorValues(typeof(TestRecord), "name", false); 61 | 62 | discriminatorValues.AddType(typeof(TestRecord), nameof(TestRecord)); 63 | 64 | var result = discriminatorValues.Contains(nameof(TestRecord)); 65 | 66 | Assert.True(result); 67 | } 68 | 69 | [Test] 70 | public void IncorrectContains() 71 | { 72 | var discriminatorValues = new DiscriminatorValues(typeof(TestRecord), "name", false); 73 | 74 | discriminatorValues.AddType(typeof(TestRecord), nameof(TestRecord)); 75 | 76 | var result = discriminatorValues.Contains(nameof(TestHeir)); 77 | 78 | Assert.False(result); 79 | } 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/FallbackType.cs: -------------------------------------------------------------------------------- 1 | using Newtonsoft.Json; 2 | using NUnit.Framework; 3 | 4 | namespace JsonKnownTypes.UnitTests 5 | { 6 | [JsonConverter(typeof(JsonKnownTypesConverter))] 7 | [JsonDiscriminator(Name = "opType")] 8 | [JsonKnownType(typeof(OperationStarted), "op_start")] 9 | [JsonKnownType(typeof(OperationEnded), "op_end")] 10 | [JsonKnownTypeFallback(typeof(UnknownOperation))] 11 | public abstract class OperationBase 12 | { 13 | public string Id { get; set; } 14 | } 15 | 16 | public class OperationStarted : OperationBase { } 17 | 18 | public class OperationEnded : OperationBase { } 19 | 20 | public class UnknownOperation : OperationBase { } 21 | 22 | public class FallbackType 23 | { 24 | [Test] 25 | public void Deserialize_UsesFallbackType_WhenUnknownDiscriminatorIsUsed() 26 | { 27 | const string payload = @"[ 28 | {id: ""abc"", opType: ""op_start""}, 29 | {id: ""bcd"", opType: ""op_delayed""}, 30 | {id: ""cde"", opType: ""op_update""}, 31 | {id: ""def"", opType: ""op_end""}, 32 | {id: ""broken_entity""} 33 | ]"; 34 | 35 | var deserialized = JsonConvert.DeserializeObject(payload); 36 | 37 | Assert.AreEqual(typeof(OperationStarted), deserialized[0].GetType()); 38 | Assert.AreEqual(typeof(UnknownOperation), deserialized[1].GetType()); 39 | Assert.AreEqual(typeof(UnknownOperation), deserialized[2].GetType()); 40 | Assert.AreEqual(typeof(OperationEnded), deserialized[3].GetType()); 41 | Assert.AreEqual(typeof(UnknownOperation), deserialized[4].GetType()); 42 | } 43 | 44 | [Test] 45 | public void Serialize_and_Deserialize_ProducesSameResult() 46 | { 47 | var serialized = JsonConvert.SerializeObject(new OperationBase[] 48 | { 49 | new OperationStarted { Id = "abc" }, 50 | new UnknownOperation { Id = "bcd" } 51 | }); 52 | 53 | var deserialized = JsonConvert.DeserializeObject(serialized); 54 | 55 | Assert.AreEqual(typeof(UnknownOperation), deserialized[1].GetType()); 56 | } 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/InheritedWithManyTypes.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections; 3 | using System.Diagnostics; 4 | using AutoFixture; 5 | using FluentAssertions; 6 | using Newtonsoft.Json; 7 | using Newtonsoft.Json.Linq; 8 | using NUnit.Framework; 9 | 10 | namespace JsonKnownTypes.UnitTests 11 | { 12 | public class InheritedWithManyTypes 13 | { 14 | [JsonConverter(typeof(JsonKnownTypesConverter))] 15 | private record TestBase(string Str); 16 | 17 | private record TestInherited(string Str, 18 | DateTime DateTimeField, 19 | DateTimeOffset DateTimeOffsetField, 20 | decimal DecimalField, 21 | double DoubleField, 22 | bool BoolField, 23 | int IntField, 24 | byte ByteField, 25 | byte[] BytesArrayField) : TestBase(Str); 26 | 27 | [Test] 28 | public void CorrectSerializationAndDeserialization() 29 | { 30 | There_is_right_discriminator(new Fixture().Create()); 31 | } 32 | 33 | private void There_is_right_discriminator(TestBase entity) 34 | { 35 | var json = JsonConvert.SerializeObject(entity); 36 | var jObject = JToken.Parse(json); 37 | 38 | var discriminator = jObject["$type"]?.Value(); 39 | var obj = JsonConvert.DeserializeObject(json); 40 | 41 | var ex = (TestInherited) entity; 42 | var ac = (TestInherited) obj; 43 | 44 | Assert.AreEqual(discriminator, entity.GetType().Name); 45 | 46 | Assert.AreEqual(ex.Str, ac.Str); 47 | Assert.AreEqual(ex.DateTimeField, ac.DateTimeField); 48 | Assert.AreEqual(ex.DateTimeOffsetField, ac.DateTimeOffsetField); 49 | Assert.AreEqual(ex.DecimalField, ac.DecimalField); 50 | Assert.AreEqual(ex.DoubleField, ac.DoubleField); 51 | Assert.AreEqual(ex.BoolField, ac.BoolField); 52 | Assert.AreEqual(ex.IntField, ac.IntField); 53 | Assert.AreEqual(ex.ByteField, ac.ByteField); 54 | for (int i = 0; i < ex.BytesArrayField.Length; i++) 55 | { 56 | Assert.AreEqual(ex.BytesArrayField[i], ac.BytesArrayField[i]); 57 | } 58 | } 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/InterfaceInInterface.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using NUnit.Framework; 5 | 6 | namespace JsonKnownTypes.UnitTests 7 | { 8 | public class InterfaceInInterface 9 | { 10 | [Test] 11 | public void BaseClassTest() 12 | { 13 | var holder = new ObjectHolder(); 14 | 15 | var twc = new TestWithChildren { Name = "Test0" }; 16 | twc.Children.Add(new TestWithDataOnly { Name = "Test1", Value = 1 }); 17 | twc.Children.Add(new TestWithDataOnly { Name = "Test2", Value = 2 }); 18 | 19 | holder.Tests.Add(twc); 20 | holder.Tests.Add(new TestWithDataOnly { Name = "Test3", Value = 3 }); 21 | holder.Tests.Add(new TestWithDataOnly { Name = "Test4", Value = 4 }); 22 | holder.Tests.Add(new TestWithDataOnly { Name = "Test5", Value = 5 }); 23 | 24 | There_is_right_discriminator(holder); 25 | } 26 | 27 | private void There_is_right_discriminator(ObjectHolder entity) 28 | { 29 | var json = JsonConvert.SerializeObject(entity); 30 | 31 | var obj = JsonConvert.DeserializeObject(json); 32 | 33 | obj.Should().BeEquivalentTo(entity); 34 | } 35 | } 36 | 37 | [JsonConverter(typeof(JsonKnownTypesConverter))] 38 | public interface ITest 39 | { } 40 | 41 | public class TestWithChildren : ITest 42 | { 43 | public string Name { get; set; } 44 | public List Children { get; set; } = new List(); 45 | } 46 | 47 | public class TestWithDataOnly : ITest 48 | { 49 | public string Name { get; set; } 50 | public int Value { get; set; } 51 | } 52 | 53 | public class ObjectHolder 54 | { 55 | public List Tests { get; protected set; } = new List(); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/JsonKnownTypes.UnitTests.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | net5.0 5 | 6 | false 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | all 17 | runtime; build; native; contentfiles; analyzers; buildtransitive 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/LongTypesHierarchy.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture; 2 | using AutoFixture.NUnit3; 3 | using FluentAssertions; 4 | using Newtonsoft.Json; 5 | using Newtonsoft.Json.Linq; 6 | using NUnit.Framework; 7 | 8 | namespace JsonKnownTypes.UnitTests 9 | { 10 | [TestFixture] 11 | public class LongTypesHierarchy 12 | { 13 | public class AutoDataCustomAttribute : AutoDataAttribute 14 | { 15 | public AutoDataCustomAttribute() 16 | : base(() => 17 | { 18 | var fixture = new Fixture(); 19 | fixture.Register(() => null); 20 | fixture.Register(() => null); 21 | return fixture; 22 | }) 23 | { } 24 | } 25 | 26 | [Test] 27 | [AutoDataCustom] 28 | public void BaseClassTest(BaseClass entity) 29 | { 30 | There_is_right_discriminator(entity); 31 | } 32 | 33 | [Test] 34 | [AutoDataCustom] 35 | public void BaseClass1HeirWithBaseAbstractClass1Heir(BaseClass1Heir entity, BaseAbstractClass1Heir field) 36 | { 37 | entity.Field = new ClassWithoutHeirs { Field = field }; 38 | There_is_right_discriminator(entity); 39 | } 40 | 41 | [Test] 42 | [AutoDataCustom] 43 | public void BaseClass1HeirWithBaseAbstractClass2Heir(BaseClass1Heir entity, BaseAbstractClass2Heir field) 44 | { 45 | entity.Field = new ClassWithoutHeirs { Field = field }; 46 | There_is_right_discriminator(entity); 47 | } 48 | 49 | [Test] 50 | [AutoData] 51 | public void BaseClass2HeirTest(BaseClass2Heir entity) 52 | { 53 | There_is_right_discriminator(entity); 54 | } 55 | 56 | [Test] 57 | [AutoDataCustom] 58 | public void BaseClass3HeirWithBaseInterface1Heir(BaseClass3Heir entity, BaseInterface1Heir field) 59 | { 60 | entity.Field = new ClassWithoutHeirs2 { Field = field }; 61 | There_is_right_discriminator(entity); 62 | } 63 | 64 | [Test] 65 | [AutoDataCustom] 66 | public void BaseClass3HeirWithBaseInterface2Heir(BaseClass3Heir entity, BaseInterface2Heir field) 67 | { 68 | entity.Field = new ClassWithoutHeirs2 { Field = field }; 69 | There_is_right_discriminator(entity); 70 | } 71 | 72 | private void There_is_right_discriminator(BaseClass entity) 73 | { 74 | var json = JsonConvert.SerializeObject(entity); 75 | var jObject = JToken.Parse(json); 76 | 77 | var discriminator = jObject["$type"]?.Value(); 78 | var obj = JsonConvert.DeserializeObject(json); 79 | 80 | obj.Should().BeEquivalentTo(entity); 81 | Assert.AreEqual(discriminator, entity.GetType().Name); 82 | } 83 | 84 | [JsonConverter(typeof(JsonKnownTypesConverter))] 85 | [JsonDiscriminator(UseClassNameAsDiscriminator = false)] 86 | [JsonKnownThisType] 87 | public class BaseClass 88 | { 89 | public string Summary { get; set; } 90 | } 91 | 92 | [JsonKnownThisType] 93 | public class BaseClass1Heir : BaseClass 94 | { 95 | public int SomeInt { get; set; } 96 | public ClassWithoutHeirs Field { get; set; } 97 | } 98 | 99 | [JsonKnownThisType] 100 | public class BaseClass2Heir : BaseClass 101 | { 102 | public double SomeDouble { get; set; } 103 | public string Detailed { get; set; } 104 | } 105 | 106 | [JsonKnownThisType] 107 | public class BaseClass3Heir : BaseClass2Heir 108 | { 109 | public string SomeString { get; set; } 110 | public ClassWithoutHeirs2 Field { get; set; } 111 | } 112 | 113 | public class ClassWithoutHeirs 114 | { 115 | public BaseAbstractClass Field; 116 | } 117 | 118 | [JsonConverter(typeof(JsonKnownTypesConverter))] 119 | [JsonKnownType(typeof(BaseAbstractClass1Heir))] 120 | [JsonKnownType(typeof(BaseAbstractClass2Heir))] 121 | public abstract class BaseAbstractClass 122 | { 123 | public string Summary { get; set; } 124 | } 125 | 126 | public class BaseAbstractClass1Heir : BaseAbstractClass 127 | { 128 | public int SomeInt { get; set; } 129 | } 130 | 131 | public class BaseAbstractClass2Heir : BaseAbstractClass 132 | { 133 | public double SomeDouble { get; set; } 134 | public string Detailed { get; set; } 135 | } 136 | 137 | public class ClassWithoutHeirs2 138 | { 139 | public IBaseInterface Field { get; set; } 140 | } 141 | 142 | [JsonConverter(typeof(JsonKnownTypesConverter))] 143 | [JsonKnownType(typeof(BaseInterface2Heir))] 144 | public interface IBaseInterface 145 | { 146 | string Summary { get; set; } 147 | } 148 | 149 | public class BaseInterface1Heir : IBaseInterface 150 | { 151 | public string Summary { get; set; } 152 | } 153 | 154 | public class BaseInterface2Heir : IBaseInterface 155 | { 156 | public string Summary { get; set; } 157 | public string Detailed { get; set; } 158 | } 159 | } 160 | } 161 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/SettingsTest.cs: -------------------------------------------------------------------------------- 1 | using JsonKnownTypes.Exceptions; 2 | using Newtonsoft.Json; 3 | using NUnit.Framework; 4 | 5 | namespace JsonKnownTypes.UnitTests 6 | { 7 | [TestFixture] 8 | public class SettingsTest 9 | { 10 | [Test] 11 | public void Contains_correct_settings_interface() 12 | { 13 | var settings = JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 14 | 15 | Assert.True(settings.Count == 0); 16 | Assert.AreEqual(settings.FieldName, "name"); 17 | } 18 | 19 | [Test] 20 | public void Throw_an_exception() => 21 | Assert.Throws(delegate 22 | { 23 | JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 24 | }); 25 | 26 | [JsonConverter(typeof(JsonKnownTypesConverter))] 27 | [JsonDiscriminator(Name = "name")] 28 | public interface ISettings 29 | { 30 | string Summary { get; set; } 31 | } 32 | 33 | [JsonConverter(typeof(JsonKnownTypesConverter))] 34 | [JsonDiscriminator(Name = "NotName")] 35 | public class Settings 36 | { 37 | string Summary { get; set; } 38 | } 39 | 40 | [JsonKnownThisType("Settings")] //same discriminator as for Settings should throw 41 | public class Settings1 : Settings 42 | { } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/TypesHierarchy.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using Newtonsoft.Json.Linq; 5 | using NUnit.Framework; 6 | 7 | namespace JsonKnownTypes.UnitTests 8 | { 9 | [TestFixture] 10 | public class TypesHierarchy 11 | { 12 | [Test] 13 | [AutoData] 14 | public void BaseAbstractClass1HeirWithBaseClass(BaseAbstractClass1Heir entity, BaseClass field) 15 | { 16 | entity.Field = field; 17 | There_is_right_discriminator(entity); 18 | } 19 | 20 | [Test] 21 | [AutoData] 22 | public void BaseAbstractClass1HeirWithBaseClass1Heir(BaseAbstractClass1Heir entity, BaseClass1Heir field) 23 | { 24 | entity.Field = field; 25 | There_is_right_discriminator(entity); 26 | } 27 | 28 | [Test] 29 | [AutoData] 30 | public void BaseAbstractClass1HeirWithBaseClass2Heir(BaseAbstractClass1Heir entity, BaseClass2Heir field) 31 | { 32 | entity.Field = field; 33 | There_is_right_discriminator(entity); 34 | } 35 | 36 | [Test] 37 | [AutoData] 38 | public void BaseAbstractClass1HeirWithBaseClass3Heir(BaseAbstractClass1Heir entity, BaseClass3Heir field) 39 | { 40 | entity.Field = field; 41 | There_is_right_discriminator(entity); 42 | } 43 | 44 | [Test] 45 | [AutoData] 46 | public void BaseAbstractClass2HeirWithBaseClass(BaseAbstractClass2Heir entity, BaseClass field) 47 | { 48 | entity.Field = field; 49 | There_is_right_discriminator(entity); 50 | } 51 | 52 | [Test] 53 | [AutoData] 54 | public void BaseAbstractClass2HeirWithBaseClass1Heir(BaseAbstractClass2Heir entity, BaseClass1Heir field) 55 | { 56 | entity.Field = field; 57 | There_is_right_discriminator(entity); 58 | } 59 | 60 | [Test] 61 | [AutoData] 62 | public void BaseAbstractClass2HeirWithBaseClass2Heir(BaseAbstractClass2Heir entity, BaseClass2Heir field) 63 | { 64 | entity.Field = field; 65 | There_is_right_discriminator(entity); 66 | } 67 | 68 | [Test] 69 | [AutoData] 70 | public void BaseAbstractClass2HeirWithBaseClass3Heir(BaseAbstractClass2Heir entity, BaseClass3Heir field) 71 | { 72 | entity.Field = field; 73 | There_is_right_discriminator(entity); 74 | } 75 | 76 | private void There_is_right_discriminator(BaseAbstractClass entity) 77 | { 78 | var json = JsonConvert.SerializeObject(entity); 79 | var jObject = JToken.Parse(json); 80 | 81 | var discriminator = jObject["$type"]?.Value(); 82 | var obj = JsonConvert.DeserializeObject(json); 83 | 84 | obj.Should().BeEquivalentTo(entity); 85 | Assert.AreEqual(discriminator, entity.GetType().Name); 86 | } 87 | 88 | [JsonConverter(typeof(JsonKnownTypesConverter))] 89 | [JsonDiscriminator(UseClassNameAsDiscriminator = false)] 90 | [JsonKnownThisType] 91 | public class BaseClass 92 | { 93 | public string Summary { get; set; } 94 | } 95 | 96 | [JsonKnownThisType] 97 | public class BaseClass1Heir : BaseClass 98 | { 99 | public int SomeInt { get; set; } 100 | } 101 | 102 | [JsonKnownThisType] 103 | public class BaseClass2Heir : BaseClass 104 | { 105 | public double SomeDouble { get; set; } 106 | public string Detailed { get; set; } 107 | } 108 | 109 | [JsonKnownThisType] 110 | public class BaseClass3Heir : BaseClass2Heir 111 | { 112 | public string SomeString { get; set; } 113 | } 114 | 115 | [JsonConverter(typeof(JsonKnownTypesConverter))] 116 | [JsonKnownType(typeof(BaseAbstractClass1Heir))] 117 | [JsonKnownType(typeof(BaseAbstractClass2Heir))] 118 | public abstract class BaseAbstractClass 119 | { 120 | public string Summary { get; set; } 121 | 122 | public BaseClass Field { get; set; } 123 | } 124 | 125 | public class BaseAbstractClass1Heir : BaseAbstractClass 126 | { 127 | public int SomeInt { get; set; } 128 | } 129 | 130 | public class BaseAbstractClass2Heir : BaseAbstractClass 131 | { 132 | public double SomeDouble { get; set; } 133 | public string Detailed { get; set; } 134 | } 135 | } 136 | } 137 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/WithBaseAbstractClass.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using Newtonsoft.Json.Linq; 5 | using NUnit.Framework; 6 | 7 | namespace JsonKnownTypes.UnitTests 8 | { 9 | [TestFixture] 10 | public class WithBaseAbstractClass 11 | { 12 | private static string DiscriminatorName { get => "type"; } 13 | 14 | [Test] 15 | [AutoData] 16 | public void AutoBaseAbstractClass1Heir(BaseAbstractClass1Heir entity) 17 | => There_is_right_discriminator(entity); 18 | 19 | [Test] 20 | [AutoData] 21 | public void AutoBaseAbstractClass2Heir(BaseAbstractClass2Heir entity) 22 | => There_is_right_discriminator(entity); 23 | 24 | private void There_is_right_discriminator(BaseAbstractClass entity) 25 | { 26 | var json = JsonConvert.SerializeObject(entity); 27 | var jObject = JToken.Parse(json); 28 | 29 | var discriminator = jObject[DiscriminatorName]?.Value(); 30 | var obj = JsonConvert.DeserializeObject(json); 31 | 32 | obj.Should().BeEquivalentTo(entity); 33 | Assert.AreEqual(discriminator, entity.GetType().Name); 34 | } 35 | 36 | [Test] 37 | public void Settings_are_correct() 38 | { 39 | var settings = JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 40 | 41 | Assert.True(settings.Count == 2); 42 | Assert.AreEqual(settings.FieldName, DiscriminatorName); 43 | } 44 | 45 | [JsonConverter(typeof(JsonKnownTypesConverter))] 46 | [JsonDiscriminator(Name = "type")] 47 | [JsonKnownType(typeof(BaseAbstractClass1Heir))] 48 | [JsonKnownType(typeof(BaseAbstractClass2Heir))] 49 | public abstract class BaseAbstractClass 50 | { 51 | public string Summary { get; set; } 52 | } 53 | 54 | public class BaseAbstractClass1Heir : BaseAbstractClass 55 | { 56 | public int SomeInt { get; set; } 57 | } 58 | 59 | public class BaseAbstractClass2Heir : BaseAbstractClass 60 | { 61 | public double SomeDouble { get; set; } 62 | public string Detailed { get; set; } 63 | } 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/WithBaseClass.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using Newtonsoft.Json.Linq; 5 | using NUnit.Framework; 6 | 7 | namespace JsonKnownTypes.UnitTests 8 | { 9 | [TestFixture] 10 | public class WithBaseClass 11 | { 12 | private static string DiscriminatorName { get => "type"; } 13 | 14 | [Test] 15 | [AutoData] 16 | public void AutoBaseClass(BaseClass entity) 17 | => There_is_right_discriminator(entity); 18 | 19 | [Test] 20 | [AutoData] 21 | public void AutoBaseClass1Heir(BaseClass1Heir entity) 22 | => There_is_right_discriminator(entity); 23 | 24 | [Test] 25 | [AutoData] 26 | public void AutoBaseClass2Heir(BaseClass2Heir entity) 27 | => There_is_right_discriminator(entity); 28 | 29 | [Test] 30 | [AutoData] 31 | public void AutoBaseClass3Heir(BaseClass3Heir entity) 32 | => There_is_right_discriminator(entity); 33 | 34 | private void There_is_right_discriminator(BaseClass entity) 35 | { 36 | var json = JsonConvert.SerializeObject(entity); 37 | var jObject = JToken.Parse(json); 38 | 39 | var discriminator = jObject[DiscriminatorName]?.Value(); 40 | var obj = JsonConvert.DeserializeObject(json); 41 | 42 | obj.Should().BeEquivalentTo(entity); 43 | Assert.AreEqual(discriminator, entity.GetType().Name); 44 | } 45 | 46 | [Test] 47 | public void Settings_are_correct() 48 | { 49 | var settings = JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 50 | 51 | Assert.True(settings.Count == 4); 52 | Assert.AreEqual(settings.FieldName, DiscriminatorName); 53 | } 54 | 55 | [JsonConverter(typeof(JsonKnownTypesConverter))] 56 | [JsonDiscriminator(UseClassNameAsDiscriminator = false, Name = "type")] 57 | [JsonKnownThisType] 58 | public class BaseClass 59 | { 60 | public string Summary { get; set; } 61 | } 62 | 63 | [JsonKnownThisType] 64 | public class BaseClass1Heir : BaseClass 65 | { 66 | public int SomeInt { get; set; } 67 | } 68 | 69 | [JsonKnownThisType] 70 | public class BaseClass2Heir : BaseClass 71 | { 72 | public double SomeDouble { get; set; } 73 | public string Detailed { get; set; } 74 | } 75 | 76 | [JsonKnownThisType] 77 | public class BaseClass3Heir : BaseClass2Heir 78 | { 79 | public string SomeString { get; set; } 80 | } 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/WithBaseClassWithException.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using Newtonsoft.Json; 3 | using NUnit.Framework; 4 | 5 | namespace JsonKnownTypes.UnitTests 6 | { 7 | [TestFixture] 8 | class WithBaseClassWithException 9 | { 10 | private static string DiscriminatorName { get => "$type"; } 11 | 12 | [Test] 13 | [AutoData] 14 | public void AutoBaseClassSameDiscriminator(BaseClassSameDiscriminator entity) 15 | => Should_throw_exception(entity); 16 | 17 | [Test] 18 | [AutoData] 19 | public void AutoBaseClassSameDiscriminator1Heir(BaseClassSameDiscriminator1Heir entity) 20 | => Should_throw_exception(entity); 21 | 22 | [Test] 23 | [AutoData] 24 | public void AutoBaseClassSameDiscriminator2Heir(BaseClassSameDiscriminator2Heir entity) 25 | => Should_throw_exception(entity); 26 | 27 | [Test] 28 | [AutoData] 29 | public void AutoBaseClassSameDiscriminator3Heir(BaseClassSameDiscriminator3Heir entity) 30 | => Should_throw_exception(entity); 31 | 32 | private void Should_throw_exception(BaseClassSameDiscriminator entity) 33 | { 34 | Assert.Throws(delegate 35 | { 36 | JsonConvert.SerializeObject(entity); 37 | }); 38 | } 39 | 40 | [JsonConverter(typeof(JsonKnownTypesConverter))] 41 | [JsonKnownType(typeof(BaseClassSameDiscriminator))] 42 | [JsonKnownType(typeof(BaseClassSameDiscriminator1Heir), "same name")] 43 | [JsonKnownType(typeof(BaseClassSameDiscriminator2Heir), "same name")] 44 | [JsonKnownType(typeof(BaseClassSameDiscriminator3Heir), "same name")] 45 | public class BaseClassSameDiscriminator 46 | { 47 | public string Summary { get; set; } 48 | } 49 | 50 | public class BaseClassSameDiscriminator1Heir : BaseClassSameDiscriminator 51 | { 52 | public int SomeInt { get; set; } 53 | } 54 | 55 | public class BaseClassSameDiscriminator2Heir : BaseClassSameDiscriminator1Heir 56 | { 57 | public double SomeDouble { get; set; } 58 | public string Detailed { get; set; } 59 | } 60 | 61 | public class BaseClassSameDiscriminator3Heir : BaseClassSameDiscriminator2Heir 62 | { 63 | public string SomeString { get; set; } 64 | } 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/WithBaseInterface.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using Newtonsoft.Json.Linq; 5 | using NUnit.Framework; 6 | 7 | namespace JsonKnownTypes.UnitTests 8 | { 9 | [TestFixture] 10 | public class WithBaseInterface 11 | { 12 | private static string DiscriminatorName { get => "$type"; } 13 | 14 | [Test] 15 | [AutoData] 16 | public void AutoBaseInterface1Heir(BaseInterface1Heir entity) 17 | => There_is_right_discriminator(entity); 18 | 19 | [Test] 20 | [AutoData] 21 | public void AutoBaseInterface2Heir(BaseInterface2Heir entity) 22 | => There_is_right_discriminator(entity); 23 | 24 | private void There_is_right_discriminator(IBaseInterface entity) 25 | { 26 | var json = JsonConvert.SerializeObject(entity); 27 | var jObject = JToken.Parse(json); 28 | 29 | var discriminator = jObject[DiscriminatorName]?.Value(); 30 | var obj = JsonConvert.DeserializeObject(json); 31 | 32 | obj.Should().BeEquivalentTo(entity); 33 | Assert.AreEqual(discriminator, entity.GetType().Name); 34 | } 35 | 36 | [JsonConverter(typeof(JsonKnownTypesConverter))] 37 | [JsonKnownType(typeof(BaseInterface2Heir))] 38 | public interface IBaseInterface 39 | { 40 | string Summary { get; set; } 41 | } 42 | 43 | public class BaseInterface1Heir : IBaseInterface 44 | { 45 | public string Summary { get; set; } 46 | } 47 | 48 | public class BaseInterface2Heir : IBaseInterface 49 | { 50 | public string Summary { get; set; } 51 | public string Detailed { get; set; } 52 | } 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /tests/JsonKnownTypes.UnitTests/WithChildrenClasses.cs: -------------------------------------------------------------------------------- 1 | using AutoFixture.NUnit3; 2 | using FluentAssertions; 3 | using Newtonsoft.Json; 4 | using Newtonsoft.Json.Linq; 5 | using NUnit.Framework; 6 | 7 | namespace JsonKnownTypes.UnitTests 8 | { 9 | [TestFixture] 10 | public class WithChildrenClasses 11 | { 12 | private static string DiscriminatorName { get => "$type"; } 13 | 14 | [Test] 15 | [AutoData] 16 | public void AutoParentClass(ParentClass entity) 17 | => There_is_right_discriminator(entity); 18 | 19 | [Test] 20 | [AutoData] 21 | public void AutoParentClass1Heir(ParentClass1Heir entity) 22 | => There_is_right_discriminator(entity); 23 | 24 | [Test] 25 | [AutoData] 26 | public void AutoParentClass2Heir(ParentClass2Heir entity) 27 | => There_is_right_discriminator(entity); 28 | 29 | private void There_is_right_discriminator(ParentClass entity) 30 | { 31 | var json = JsonConvert.SerializeObject(entity); 32 | var jObject = JToken.Parse(json); 33 | 34 | var discriminator = jObject[DiscriminatorName]?.Value(); 35 | var obj = JsonConvert.DeserializeObject(json); 36 | 37 | obj.Should().BeEquivalentTo(entity); 38 | Assert.AreEqual(discriminator, entity.GetType().Name.ToLower()); 39 | } 40 | 41 | [Test] 42 | public void Settings_are_correct() 43 | { 44 | var settings = JsonKnownTypesSettingsManager.GetDiscriminatorValues(); 45 | 46 | Assert.True(settings.Count == 3); 47 | Assert.AreEqual(settings.FieldName, DiscriminatorName); 48 | } 49 | 50 | [JsonConverter(typeof(JsonKnownTypesConverter))] 51 | [JsonKnownType(typeof(ParentClass), "parentclass")] 52 | [JsonKnownType(typeof(ParentClass2Heir), "parentclass2heir")] 53 | public class ParentClass 54 | { 55 | public string Summary { get; set; } 56 | public ChildClass2Heir Child { get; set; } 57 | } 58 | 59 | [JsonKnownThisType("parentclass1heir")] 60 | public class ParentClass1Heir : ParentClass 61 | { 62 | public int SomeInt { get; set; } 63 | public ChildClass1Heir Child2 { get; set; } 64 | } 65 | 66 | public class ParentClass2Heir : ParentClass 67 | { 68 | public double SomeDouble { get; set; } 69 | public string Detailed { get; set; } 70 | ChildClass Child2 { get; set; } 71 | } 72 | 73 | [JsonConverter(typeof(JsonKnownTypesConverter))] 74 | [JsonKnownType(typeof(ChildClass), "childclass")] 75 | [JsonKnownType(typeof(ChildClass1Heir), "childclass1heir")] 76 | [JsonKnownType(typeof(ChildClass2Heir), "childclass2heir")] 77 | public class ChildClass 78 | { 79 | public string Summary { get; set; } 80 | } 81 | 82 | public class ChildClass1Heir : ChildClass 83 | { 84 | public int SomeInt { get; set; } 85 | } 86 | 87 | public class ChildClass2Heir : ChildClass 88 | { 89 | public double SomeDouble { get; set; } 90 | public string Detailed { get; set; } 91 | } 92 | } 93 | } 94 | --------------------------------------------------------------------------------