Join the ServiceStack Google+ group or follow @ServiceStack for project updates.
JSON, JSV and CSV Text Serializers used in servicestack.net.
Note: the source code is provided as-is - no direct or commercial support is available for ServiceStack
ServiceStack.Text is an independent, dependency-free serialization library that contains ServiceStack's text processing functionality, including:
- JsonSerializer
- TypeSerializer (JSV-Format)
- CsvSerializer
- T.Dump extension method
- StringExtensions - Xml/Json/Csv/Url encoding, BaseConvert, Rot13, Hex escape, etc.
- Stream, Reflection, List, DateTime, etc extensions and utils
Like most of the interfaces in Service Stack, the API is simple. Methods that you would commonly use include:
string TypeSerializer.SerializeToString<T>(T value)
void TypeSerializer.SerializeToWriter<T>(T value, TextWriter writer)
T TypeSerializer.DeserializeFromString<T>(string value)
T TypeSerializer.DeserializeFromReader<T>(TextReader reader)Where T can be any .NET POCO type. That's all there is - the API was intentionally left simple :)
JsonObject.Parse()
JsonArrayObjects.Parse()T FromJson()
string ToJson(T)
T FromJsv()
string ToJsv(T)Dump / Diagnostic Extensions:
T Dump()
T Print()
T PrintDump()
string Fmt(args)URL Extensions:
string GetStringFromUrl()
string GetJsonFromUrl()
string GetResponseStatus()
string UrlEncode() / UrlDecode()
string HexEscape() / HexUnescape()
string UrlFormat() / AppendPath() / AppendPaths() / WithTrailingSlash()
string WithoutExtension() / ParentDirectory() / ReadAllText()Stream Extensions:
Stream WriteTo(Stream) / CopyTo()
StreamReader ReadLines()
Stream ReadFully() / ReadExactly()String Utils:
string SplitOnFirst() / SplitOnLast()
string IndexOfAny()
string StripHtml() / ToCamelCase()
string SafeSubstring()
string ToUtf8Bytes() / FromUtf8Bytes()more String, Reflection, List, Dictionary, DateTime extensions...
Although usually used to (de)serialize C#/.NET POCO types, it also includes a flexible API allowing you to deserialize any JSON payload without it's concrete type, see these real-world examples:
- Parsing GitHub's v3 API with typed DTOs
- Parsing GitHub's JSON response
- Parsing Google Maps JSON Response
- Parsing Centroid
Also a thin .NET 4.0 Dynamic JSON wrapper around ServiceStack's JSON library is included in the ServiceStack.Razor project. It provides a dynamic, but more succinct API than the above options.
PM> Install-Package ServiceStack.Text
Latest v4+ on NuGet is a commercial release with free quotas.
Since September 2013, ServiceStack source code is available under GNU Affero General Public License/FOSS License Exception, see license.txt in the source. Alternative commercial licensing is also available, contact team@servicestack.net for details.
Commits can be made to either the master (v4) or v3 release branches. Contributors need to approve the Contributor License Agreement before any code will be reviewed, see the Contributing wiki for more details.
For reasons outlined in this blog post I decided to re-use TypeSerializer's text processing-core to create ServiceStack.JsonSerializer - the fastest JSON Serializer for .NET. Based on the Northwind Benchmarks it's 3.6x faster than .NET's BCL JsonDataContractSerializer and 3x faster then the previous fastest JSON serializer benchmarked - JSON.NET.
A comprehensive set of other .NET benchmarks are maintained at servicestack.net/benchmarks.
As CSV is an important format in many data access and migration scenarios, it became the latest format included in ServiceStack which allows all your existing web services to take advantage of the new format without config or code-changes. As its built using the same tech that makes the JSON and JSV serializers so fast, we expect it to be the fastest POCO CSV Serializer for .NET.
Included in this project is TypeSerializer - A fast and compact text-based serializer for .NET. It's a light-weight compact Text Serializer which can be used to serialize .NET data types inc custom POCO's and DataContract's. More info on its JSV Format can be found on the introductory post.
Another useful library to have in your .NET toolbox is the T.Dump() Extension Method. Under the hood it uses a Pretty Print Output of the JSV Format to recursively dump the contents of any .NET object. Example usage and output:
var model = new TestModel();
model.PrintDump();
//Example Output
{
Int: 1,
String: One,
DateTime: 2010-04-11,
Guid: c050437f6fcd46be9b2d0806a0860b3e,
EmptyIntList: [],
IntList:
[
1,
2,
3
],
StringList:
[
one,
two,
three
],
StringIntMap:
{
a: 1,
b: 2,
c: 3
}
}ServiceStack's JsonSerializer is optimized for serializing C# POCO types in and out of JSON as fast, compact and cleanly as possible. In most cases C# objects serializes as you would expect them to without added json extensions or serializer-specific artefacts.
JsonSerializer provides a simple API that allows you to serialize any .NET generic or runtime type into a string, TextWriter/TextReader or Stream.
string SerializeToString<T>(T)
void SerializeToWriter<T>(T, TextWriter)
void SerializeToStream<T>(T, Stream)
string SerializeToString(object, Type)
void SerializeToWriter(object, Type, TextWriter)
void SerializeToStream(object, Type, Stream)T DeserializeFromString<T>(string)
T DeserializeFromReader<T>(TextReader)
object DeserializeFromString(string, Type)
object DeserializeFromReader(reader, Type)
object DeserializeFromStream(Type, Stream)
T DeserializeFromStream<T>(Stream)string ToJson<T>(this T)
T FromJson<T>(this string)Convenient ToJson/FromJson extension methods are also included reducing the amount of code required, e.g:
new []{ 1, 2, 3 }.ToJson() //= [1,2,3]
"[1,2,3]".FromJson<int[]>() //= int []{ 1, 2, 3 }JSON is a lightweight text serialization format with a spec that's so simple that it fits on one page: http://www.json.org.
The only valid values in JSON are:
- string
- number
- object
- array
- true
- false
- null
Where most allowed values are scalar and the only complex types available are objects and arrays. Although limited, the above set of types make a good fit and can express most programming data structures.
All C# boolean and numeric data types are stored as-is without quotes.
For the most compact output null values are omitted from the serialized by default. If you want to include null values set the global configuration:
JsConfig.IncludeNullValues = true;All other scalar values are stored as strings that are surrounded with double quotes.
Because a C# struct is a value type whose public properties are normally just convenience properties around a single scalar value, they are ignored instead the TStruct.ToString() method is used to serialize and either the static TStruct.ParseJson()/static TStruct.ParseJsv() methods or new TStruct(string) constructor will be used to deserialize the value type if it exists.
Any List, Queue, Stack, Array, Collection, Enumerables including custom enumerable types are stored in exactly the same way as a JavaScript array literal, i.e:
[1,2,3,4,5]
All elements in an array must be of the same type. If a custom type is both an IEnumerable and has properties it will be treated as an array and the extra properties will be ignored.
The JSON object type is the most flexible and is how most complex .NET types are serialized. The JSON object type is a key-value pair JavaScript object literal where the key is always a double-quoted string.
Any IDictionary is serialized into a standard JSON object, i.e:
{"A":1,"B":2,"C":3,"D":4}
Which happens to be the same as C# POCO types (inc. Interfaces) with the values:
new MyClass { A=1, B=2, C=3, D=4 }
{"A":1,"B":2,"C":3,"D":4}
Only public properties on reference types are serialized with the C# Property Name used for object key and the Property Value as the value. At the moment it is not possible to customize the Property Name.
JsonSerializer also supports serialization of anonymous types in much the same way:
new { A=1, B=2, C=3, D=4 }
{"A":1,"B":2,"C":3,"D":4}
Although JsonSerializer is optimized for serializing .NET POCO types, it still provides some options to change the convention-based serialization routine.
This makes it possible to customize the serialization routine and provide an even more compact wire format.
E.g. Instead of using a JSON object to represent a point
{ Width=20, Height=10 }
You could use a struct and reduce it to just:
"20x10"
By overriding ToString() and providing a static Size ParseJson() method:
public struct Size
{
public double Width { get; set; }
public double Height { get; set; }
public override string ToString()
{
return Width + "x" + Height;
}
public static Size ParseJson(string json)
{
var size = json.Split('x');
return new Size {
Width = double.Parse(size[0]),
Height = double.Parse(size[1])
};
}
}Which would change it to the more compact JSON output:
new Size { Width = 20, Height = 10 }.ToJson() // = "20x10"That allows you to deserialize it back in the same way:
var size = "20x10".FromJson<Size>(); In addition to using a Struct you can optionally use a custom C# IEnumerable type to provide a strong-typed wrapper around a JSON array:
public class Point : IEnumerable
{
double[] points = new double[2];
public double X
{
get { return points[0]; }
set { points[0] = value; }
}
public double Y
{
get { return points[1]; }
set { points[1] = value; }
}
public IEnumerator GetEnumerator()
{
foreach (var point in points)
yield return point;
}
}Which serializes the Point into a compact JSON array:
new Point { X = 1, Y = 2 }.ToJson() // = [1,2]If you can't change the definition of a ValueType (e.g. because its in the BCL), you can assign a custom serialization /
deserialization routine to use instead. E.g. here's how you can add support for System.Drawing.Color:
JsConfig<System.Drawing.Color>.SerializeFn = c => c.ToString().Replace("Color ","").Replace("[","").Replace("]","");
JsConfig<System.Drawing.Color>.DeSerializeFn = System.Drawing.Color.FromName;Because the same wire format shared between Dictionaries, POCOs and anonymous types, in most cases what you serialize with one type can be deserialized with another, i.e. an Anonymous type can be deserialized back into a Dictionary<string,string> which can be deserialized into a strong-typed POCO and vice-versa.
Although the JSON Serializer is best optimized for serializing and deserializing .NET types, it's flexible enough to consume 3rd party JSON apis although this generally requires custom de-serialization to convert it into an idiomatic .NET type.
- Using JsonObject
- Using Generic .NET Collection classes
- Using Customized DTO's in the shape of the 3rd party JSON response
CentroidTests is another example that uses the JsonObject to parse a complex custom JSON response.
#TypeSerializer Details (JSV Format)
Out of the box .NET provides a fairly quick but verbose Xml DataContractSerializer or a slightly more compact but slower JsonDataContractSerializer. Both of these options are fragile and likely to break with any significant schema changes. TypeSerializer addresses these shortcomings by being both smaller and significantly faster than the most popular options. It's also more resilient, e.g. a strongly-typed POCO object can be deserialized back into a loosely-typed string Dictionary and vice-versa.
With that in mind, TypeSerializer's main features are:
- Fastest and most compact text-serializer for .NET
- Human readable and writeable, self-describing text format
- Non-invasive and configuration-free
- Resilient to schema changes
- Serializes / De-serializes any .NET data type (by convention)
- Supports custom, compact serialization of structs by overriding
ToString()andstatic T Parse(string)methods - Can serialize inherited, interface or 'late-bound objects' data types
- Respects opt-in DataMember custom serialization for DataContract dto types.
- Supports custom, compact serialization of structs by overriding
These characteristics make it ideal for use anywhere you need to store or transport .NET data-types, e.g. for text blobs in a ORM, data in and out of a key-value store or as the text-protocol in .NET to .NET web services.
As such, it's utilized within ServiceStack's other components:
- OrmLite - to store complex types on table models as text blobs in a database field and
- ServiceStack.Redis - to store rich POCO data types into the very fast redis instances.
You may also be interested in the very useful T.Dump() extension method for recursively viewing the contents of any C# POCO Type.
Type Serializer is actually the fastest and most compact text serializer available for .NET. Out of all the serializers benchmarked, it is the only one to remain competitive with protobuf-net's very fast implementation of Protocol Buffers - google's high-speed binary protocol.
Below is a series of benchmarks serialize the different tables in the Northwind database (3202 records) with the most popular serializers available for .NET:
Combined results for serializing / deserialzing a single row of each table in the Northwind database 1,000,000 times
| Serializer | Size | Peformance |
|---|---|---|
| Microsoft DataContractSerializer | 4.68x | 6.72x |
| Microsoft JsonDataContractSerializer | 2.24x | 10.18x |
| Microsoft BinaryFormatter | 5.62x | 9.06x |
| NewtonSoft.Json | 2.30x | 8.15x |
| ProtoBuf.net | 1x | 1x |
| ServiceStack TypeSerializer | 1.78x | 1.92x |
number of times larger in size and slower in performance than the best - lower is better
Microsoft's JavaScriptSerializer was also benchmarked but excluded as it was up to 280x times slower - basically don't use it, ever.
Type Serializer uses a hybrid CSV-style escaping + JavaScript-like text-based format that is optimized for both size and speed. I'm naming this JSV-format (i.e. JSON + CSV)
In many ways it is similar to JavaScript, e.g. any List, Array, Collection of ints, longs, etc are stored in exactly the same way, i.e:
[1,2,3,4,5]
Any IDictionary is serialized like JavaScript, i.e:
{A:1,B:2,C:3,D:4}
Which also happens to be the same as C# POCO class with the values
new MyClass { A=1, B=2, C=3, D=4 }
{A:1,B:2,C:3,D:4}
JSV is white-space significant, which means normal string values can be serialized without quotes, e.g:
new MyClass { Foo="Bar", Greet="Hello World!"} is serialized as:
{Foo:Bar,Greet:Hello World!}
Any string with any of the following characters: []{},"
is escaped using CSV-style escaping where the value is wrapped in double quotes, e.g:
new MyClass { Name = "Me, Junior" } is serialized as:
{Name:"Me, Junior"}
A value with a double-quote is escaped with another double quote e.g:
new MyClass { Size = "2\" x 1\"" } is serialized as:
{Size:"2"" x 1"""}
To better illustrate the resilience of TypeSerializer and the JSV Format check out a real world example of it when it's used to Painlessly migrate between old and new types in Redis.
Support for dynamic payloads and late-bound objects is explained in the post Versatility of JSV Late-bound objects.