-Documentation
This commit is contained in:
@@ -338,6 +338,19 @@ or a property's object properties or collection items using
|
|||||||
</content>
|
</content>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>TraceWriter</title>
|
||||||
|
<content><para>The Json.NET serializer supports logging using the <codeEntityReference>T:Newtonsoft.Json.Serialization.ITraceWriter</codeEntityReference>
|
||||||
|
interface. By assigning a trace writer you can debug what is happening inside the Json.NET serializer when
|
||||||
|
serializing and deserializing JSON.</para>
|
||||||
|
<para>Read more about TraceWriters here: <externalLink>
|
||||||
|
<linkText>Debug with Serialization Tracing</linkText>
|
||||||
|
<linkUri>SerializationTracing.htm</linkUri>
|
||||||
|
<linkTarget>_self</linkTarget>
|
||||||
|
</externalLink></para>
|
||||||
|
</content>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<title>Error</title>
|
<title>Error</title>
|
||||||
<content><para>The <codeEntityReference>E:Newtonsoft.Json.JsonSerializer.Error</codeEntityReference> event can catch errors during serialization and either handle the event and continue with
|
<content><para>The <codeEntityReference>E:Newtonsoft.Json.JsonSerializer.Error</codeEntityReference> event can catch errors during serialization and either handle the event and continue with
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<topic id="SerializationTracing" revisionNumber="1">
|
||||||
|
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<introduction>
|
||||||
|
<para>The Json.NET serializer supports logging using the <codeEntityReference>T:Newtonsoft.Json.Serialization.ITraceWriter</codeEntityReference>
|
||||||
|
interface. By assigning a trace writer you can debug what is happening inside the Json.NET serializer when
|
||||||
|
serializing and deserializing JSON.</para>
|
||||||
|
</introduction>
|
||||||
|
<section>
|
||||||
|
<title>ITraceWriter</title>
|
||||||
|
<content>
|
||||||
|
<para>A trace writer can be assigned using properties on JsonSerializerSettings or JsonSerializer.</para>
|
||||||
|
|
||||||
|
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\TraceWriterTests.cs" region="MemoryTraceWriterExample" title="Debugging serialization using MemoryTraceWriter" />
|
||||||
|
|
||||||
|
<para>Json.NET has two implementations of ITraceWriter: <codeEntityReference>P:Newtonsoft.Json.Serialization.MemoryTraceWriter</codeEntityReference>
|
||||||
|
which keeps messages in memory for simple debugging like the example
|
||||||
|
above, and <codeEntityReference>T:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter</codeEntityReference> which writes messages to any
|
||||||
|
System.Diagnostics.TraceListeners your application is using.</para>
|
||||||
|
</content>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Custom ITraceWriter</title>
|
||||||
|
<content>
|
||||||
|
<para>To write messages using your existing logging framework implement a custom version of ITraceWriter.</para>
|
||||||
|
|
||||||
|
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\TraceWriterTests.cs" region="CustomTraceWriterExample" title="Custom NLog TraceWriter" />
|
||||||
|
|
||||||
|
</content>
|
||||||
|
</section>
|
||||||
|
<relatedTopics>
|
||||||
|
<codeEntityReference>T:Newtonsoft.Json.JsonSerializer</codeEntityReference>
|
||||||
|
<codeEntityReference>T:Newtonsoft.Json.Serialization.ITraceWriter</codeEntityReference>
|
||||||
|
<codeEntityReference>T:Newtonsoft.Json.Serialization.MemoryTraceWriter</codeEntityReference>
|
||||||
|
<codeEntityReference>T:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter</codeEntityReference>
|
||||||
|
</relatedTopics>
|
||||||
|
</developerConceptualDocument>
|
||||||
|
</topic>
|
||||||
+2
-1
@@ -13,8 +13,9 @@
|
|||||||
<Topic id="DatesInJSON" visible="True" title="Serializing Dates in JSON" />
|
<Topic id="DatesInJSON" visible="True" title="Serializing Dates in JSON" />
|
||||||
<Topic id="ReducingSerializedJSONSize" visible="True" title="Reducing Serialized JSON Size" />
|
<Topic id="ReducingSerializedJSONSize" visible="True" title="Reducing Serialized JSON Size" />
|
||||||
<Topic id="SerializingJSONFragments" visible="True" title="Serializing Partial JSON Fragments" />
|
<Topic id="SerializingJSONFragments" visible="True" title="Serializing Partial JSON Fragments" />
|
||||||
<Topic id="ConditionalProperties" visible="True" isSelected="true" title="Conditional Property Serialization" />
|
<Topic id="ConditionalProperties" visible="True" title="Conditional Property Serialization" />
|
||||||
<Topic id="ContractResolver" visible="True" title="Serialization using ContractResolver" />
|
<Topic id="ContractResolver" visible="True" title="Serialization using ContractResolver" />
|
||||||
|
<Topic id="SerializationTracing" visible="True" isSelected="true" title="Debug with Serialization Tracing" />
|
||||||
</Topic>
|
</Topic>
|
||||||
<Topic id="LINQtoJSON" visible="True" title="LINQ to JSON">
|
<Topic id="LINQtoJSON" visible="True" title="LINQ to JSON">
|
||||||
<Topic id="ParsingLINQtoJSON" visible="True" title="Parsing JSON" />
|
<Topic id="ParsingLINQtoJSON" visible="True" title="Parsing JSON" />
|
||||||
|
|||||||
@@ -137,6 +137,7 @@
|
|||||||
<Content Include="donate.gif" />
|
<Content Include="donate.gif" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
<None Include="SerializationTracing.aml" />
|
||||||
<None Include="JsonNetVsDotNetSerializers.aml" />
|
<None Include="JsonNetVsDotNetSerializers.aml" />
|
||||||
<None Include="JsonNetVsWindowsDataJson.aml" />
|
<None Include="JsonNetVsWindowsDataJson.aml" />
|
||||||
<None Include="ConditionalProperties.aml" />
|
<None Include="ConditionalProperties.aml" />
|
||||||
|
|||||||
@@ -0,0 +1,163 @@
|
|||||||
|
#region License
|
||||||
|
// Copyright (c) 2007 James Newton-King
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person
|
||||||
|
// obtaining a copy of this software and associated documentation
|
||||||
|
// files (the "Software"), to deal in the Software without
|
||||||
|
// restriction, including without limitation the rights to use,
|
||||||
|
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the
|
||||||
|
// Software is furnished to do so, subject to the following
|
||||||
|
// conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be
|
||||||
|
// included in all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||||
|
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||||
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
|
// OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
#if !(NET35 || NET20 || PORTABLE)
|
||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.ComponentModel;
|
||||||
|
using System.Diagnostics;
|
||||||
|
using System.Dynamic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Net;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Runtime.Serialization;
|
||||||
|
using System.Text;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using Newtonsoft.Json.Converters;
|
||||||
|
using Newtonsoft.Json.Linq;
|
||||||
|
#if !NETFX_CORE
|
||||||
|
using NUnit.Framework;
|
||||||
|
#else
|
||||||
|
using Microsoft.VisualStudio.TestPlatform.UnitTestFramework;
|
||||||
|
using TestFixture = Microsoft.VisualStudio.TestPlatform.UnitTestFramework.TestClassAttribute;
|
||||||
|
using Test = Microsoft.VisualStudio.TestPlatform.UnitTestFramework.TestMethodAttribute;
|
||||||
|
#endif
|
||||||
|
using Newtonsoft.Json.Serialization;
|
||||||
|
using Newtonsoft.Json.Tests.Serialization;
|
||||||
|
using Newtonsoft.Json.Tests.TestObjects;
|
||||||
|
using Newtonsoft.Json.Utilities;
|
||||||
|
using System.Globalization;
|
||||||
|
|
||||||
|
namespace Newtonsoft.Json.Tests.Documentation
|
||||||
|
{
|
||||||
|
[TestFixture]
|
||||||
|
public class TraceWriterTests : TestFixtureBase
|
||||||
|
{
|
||||||
|
public class LogEventInfo
|
||||||
|
{
|
||||||
|
public LogLevel Level;
|
||||||
|
public string Message;
|
||||||
|
public Exception Exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
public class LogLevel
|
||||||
|
{
|
||||||
|
public static LogLevel Info;
|
||||||
|
public static LogLevel Trace;
|
||||||
|
public static LogLevel Error;
|
||||||
|
public static LogLevel Warn;
|
||||||
|
public static LogLevel Off;
|
||||||
|
}
|
||||||
|
|
||||||
|
public class Logger
|
||||||
|
{
|
||||||
|
public void Log(LogEventInfo logEvent)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static class LogManager
|
||||||
|
{
|
||||||
|
public static Logger GetLogger(string className)
|
||||||
|
{
|
||||||
|
return new Logger();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#region CustomTraceWriterExample
|
||||||
|
public class NLogTraceWriter : ITraceWriter
|
||||||
|
{
|
||||||
|
private static readonly Logger Logger = LogManager.GetLogger("NLogTraceWriter");
|
||||||
|
|
||||||
|
public TraceLevel LevelFilter
|
||||||
|
{
|
||||||
|
// trace all messages. nlog can handle filtering
|
||||||
|
get { return TraceLevel.Verbose; }
|
||||||
|
}
|
||||||
|
|
||||||
|
private LogLevel GetLogLevel(TraceLevel level)
|
||||||
|
{
|
||||||
|
switch (level)
|
||||||
|
{
|
||||||
|
case TraceLevel.Error:
|
||||||
|
return LogLevel.Error;
|
||||||
|
case TraceLevel.Warning:
|
||||||
|
return LogLevel.Warn;
|
||||||
|
case TraceLevel.Info:
|
||||||
|
return LogLevel.Info;
|
||||||
|
case TraceLevel.Off:
|
||||||
|
return LogLevel.Off;
|
||||||
|
default:
|
||||||
|
return LogLevel.Trace;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void Trace(TraceLevel level, string message, Exception ex)
|
||||||
|
{
|
||||||
|
LogEventInfo logEvent = new LogEventInfo
|
||||||
|
{
|
||||||
|
Message = message,
|
||||||
|
Level = GetLogLevel(level),
|
||||||
|
Exception = ex
|
||||||
|
};
|
||||||
|
|
||||||
|
Logger.Log(logEvent);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void MemoryTraceWriterTest()
|
||||||
|
{
|
||||||
|
#region MemoryTraceWriterExample
|
||||||
|
Staff staff = new Staff();
|
||||||
|
staff.Name = "Arnie Admin";
|
||||||
|
staff.Roles = new List<string> { "Administrator" };
|
||||||
|
staff.StartDate = DateTime.Now;
|
||||||
|
|
||||||
|
ITraceWriter traceWriter = new MemoryTraceWriter();
|
||||||
|
|
||||||
|
JsonConvert.SerializeObject(
|
||||||
|
staff,
|
||||||
|
new JsonSerializerSettings { TraceWriter = traceWriter, Converters = { new JavaScriptDateTimeConverter() } });
|
||||||
|
|
||||||
|
Console.WriteLine(traceWriter);
|
||||||
|
// 2012-11-11T12:08:42.761 Info Started serializing Newtonsoft.Json.Tests.Serialization.Staff. Path ''.
|
||||||
|
// 2012-11-11T12:08:42.785 Info Started serializing System.DateTime with converter Newtonsoft.Json.Converters.JavaScriptDateTimeConverter. Path 'StartDate'.
|
||||||
|
// 2012-11-11T12:08:42.791 Info Finished serializing System.DateTime with converter Newtonsoft.Json.Converters.JavaScriptDateTimeConverter. Path 'StartDate'.
|
||||||
|
// 2012-11-11T12:08:42.797 Info Started serializing System.Collections.Generic.List`1[System.String]. Path 'Roles'.
|
||||||
|
// 2012-11-11T12:08:42.798 Info Finished serializing System.Collections.Generic.List`1[System.String]. Path 'Roles'.
|
||||||
|
// 2012-11-11T12:08:42.799 Info Finished serializing Newtonsoft.Json.Tests.Serialization.Staff. Path ''.
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
MemoryTraceWriter memoryTraceWriter = (MemoryTraceWriter)traceWriter;
|
||||||
|
|
||||||
|
Assert.AreEqual(743, memoryTraceWriter.ToString().Length);
|
||||||
|
Assert.AreEqual(6, memoryTraceWriter.GetTraceMessages().Count());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -118,6 +118,7 @@
|
|||||||
<Compile Include="Converters\VersionConverterTests.cs" />
|
<Compile Include="Converters\VersionConverterTests.cs" />
|
||||||
<Compile Include="Documentation\ConvertingJsonAndXmlTests.cs" />
|
<Compile Include="Documentation\ConvertingJsonAndXmlTests.cs" />
|
||||||
<Compile Include="Documentation\ConditionalPropertiesTests.cs" />
|
<Compile Include="Documentation\ConditionalPropertiesTests.cs" />
|
||||||
|
<Compile Include="Documentation\TraceWriterTests.cs" />
|
||||||
<Compile Include="Documentation\JsonNetVsWindowsDataJsonTests.cs" />
|
<Compile Include="Documentation\JsonNetVsWindowsDataJsonTests.cs" />
|
||||||
<Compile Include="Documentation\PerformanceTests.cs" />
|
<Compile Include="Documentation\PerformanceTests.cs" />
|
||||||
<Compile Include="Documentation\JsonSchemaTests.cs" />
|
<Compile Include="Documentation\JsonSchemaTests.cs" />
|
||||||
|
|||||||
@@ -320,7 +320,6 @@ If attributes are not mentioned, default values are used in each case.
|
|||||||
|
|
||||||
TimeOperation(() =>
|
TimeOperation(() =>
|
||||||
{
|
{
|
||||||
string json = null;
|
|
||||||
for (int i = 0; i < interations; i++)
|
for (int i = 0; i < interations; i++)
|
||||||
{
|
{
|
||||||
using (StringWriter w = StringUtils.CreateStringWriter(StringUtils.GetLength(text) ?? 16))
|
using (StringWriter w = StringUtils.CreateStringWriter(StringUtils.GetLength(text) ?? 16))
|
||||||
|
|||||||
Reference in New Issue
Block a user