Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akkadotnet/hyperion
Polymorphic serialization for .NET
https://github.com/akkadotnet/hyperion
dotnet dotnet-core hyperion serialization serializer
Last synced: about 5 hours ago
JSON representation
Polymorphic serialization for .NET
- Host: GitHub
- URL: https://github.com/akkadotnet/hyperion
- Owner: akkadotnet
- License: apache-2.0
- Created: 2016-12-12T17:43:18.000Z (about 8 years ago)
- Default Branch: dev
- Last Pushed: 2024-10-23T18:32:47.000Z (2 months ago)
- Last Synced: 2024-11-11T09:05:00.829Z (about 2 months ago)
- Topics: dotnet, dotnet-core, hyperion, serialization, serializer
- Language: C#
- Size: 7.28 MB
- Stars: 277
- Watchers: 20
- Forks: 62
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hyperion
[](https://gitter.im/akkadotnet/Hyperion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A high performance polymorphic serializer for the .NET framework.
Current status: **BETA** (v0.9.14).
## License
Licensed under Apache 2.0, see [LICENSE](LICENSE) for the full text.
## Polymorphic serializations
Hyperion was designed to safely transfer messages in distributed systems, for example service bus or actor model based systems.
In message based systems, it is common to receive different types of messages and apply pattern matching over those messages.
If the messages does not carry over all the relevant type information to the receiveing side, the message might no longer match exactly what your system expect.
Consider the following case:
```csharp
public class Envelope
{
//untyped property
public object Payload {get;set;}
//other properties..
...
}
...
var envelope = new Envelope { Payload = (float)1.2 };
```
If you for example are using a Json based serializer, it is very likely that the value `1.2` will be deserialized as a `double` as Json has no way to describe the type of the decimal value.
While if you use some sort of binary serializer like Google Protobuf, all messages needs to be designed with a strict contract up front.
Hyperion solves this by encoding a manifest for each value - a single byte prefix for primitive values, and fully qualified assembly names for complex types.
## Surrogates
Sometimes, you might have objects that simply can't be serialized in a safe way, the object might be contextual in some way.
Hyperion can solve those problems using "Surrogates", surrogates are a way to translate an object from and back to the context bound representation.
```csharp
var surrogate = Surrogate.Create(original => original.ToSurrogate(), surrogate => surrogate.Restore(someContext));
var options = new SerializerOptions(surrogates: new [] { surrogate });
var serializer = new Serializer(options);
```
This is essential for frameworks like Akka.NET where we need to be able to resolve live Actor References in the deserializing system.
## Whitelisting Types On Deserialization
Sometimes we need to limit the types that are allowed to be deserialized for security reasons. For this reason, you can either pass a class instance that implements the `ITypeFilter` interface into the `SerializerOptions` or use the `TypeFilterBuilder` class to build a `TypeFilter` that Hyperion can use to filter out any possibly harmful injection attack during deserialization.
using the `ITypeFilter` interface:
```c#
public sealed class TypeFilter : ITypeFilter
{
public ImmutableHashSet FilteredTypes { get; }
internal TypeFilter(IEnumerable types)
{
FilteredTypes = types.Select(t => t.GetShortAssemblyQualifiedName()).ToImmutableHashSet();
}
public bool IsAllowed(string typeName)
=> FilteredTypes.Any(t => t == typeName);
}
```
using the `TypeFilterBuilder` convenience builder:
```c#
var typeFilter = TypeFilterBuilder.Create()
.Include()
.Include()
.Build();
var options = SerializerOptions.Default
.WithTypeFilter(typeFilter);
var serializer = new Serializer(options);
```
### Convert Whitelist To Blacklist
To do blacklisting instead of whitelisting a list of types, you will need to do a slight modification to the TypeFilter class.
```c#
public sealed class TypeFilter : ITypeFilter
{
public ImmutableHashSet FilteredTypes { get; }
internal TypeFilter(IEnumerable types)
{
FilteredTypes = types.Select(t => t.GetShortAssemblyQualifiedName()).ToImmutableHashSet();
}
public bool IsAllowed(string typeName)
=> FilteredTypes.All(t => t != typeName);
}
```
## Version Tolerance
Hyperion has been designed to work in multiple modes in terms of version tolerance vs. performance.
1. Pre Register Types, when using "Pre registered types", Hyperion will only emit a type ID in the output stream.
This results in the best performance, but is also fragile if different clients have different versions of the contract types.
2. Non Versioned, this is largely the same as the above, but the serializer does not need to know about your types up front. it will embed the fully qualified typename
in the output stream. this results in a larger payload and some performance overhead.
3. Versioned, in this mode, Hyperion will emit both type names and field information in the output stream.
This allows systems to have slightly different versions of the contract types where some fields may have been added or removed.
Hyperion has been designed as a wire format, point to point for soft realtime scenarios.
If you need a format that is durable for persistence over time.
e.g. EventSourcing or for message queues, then Protobuf or MS Bond is probably a better choice as those formats have been designed for true version tolerance.
## Performance
Hyperion has been designed with a performance first mindset.
It is not _the_ most important aspect of Hyperion, Surrogates and polymorphism is more critical for what we want to solve.
But even with its rich featureset, Hyperion performs extremely well.
```text
Hyperion - preregister types
Serialize 312 ms
Deserialize 261 ms
Size 38 bytes
Total 573 ms
Hyperion - no version data
Serialize 327 ms
Deserialize 354 ms
Size 73 bytes
Total 681 ms
Hyperion - preserve object refs
Serialize 400 ms
Deserialize 369 ms
Size 73 bytes
Total 769 ms
MS Bond
Serialize 429 ms
Deserialize 404 ms
Size 50 bytes
Total 833 ms
Hyperion - version tolerant
Serialize 423 ms
Deserialize 674 ms
Size 195 bytes
Total 1097 ms
Protobuf.NET
Serialize 638 ms
Deserialize 721 ms
Size 42 bytes
Total 1359 ms
Jil
Serialize 1448 ms
Deserialize 714 ms
Size 123 bytes
Total 2162 ms
Net Serializer
Serialize 1289 ms
Deserialize 1113 ms
Size 39 bytes
Total 2402 ms
Json.NET
Serialize 3767 ms
Deserialize 5936 ms
Size 187 bytes
Total 9703 ms
Binary formatter
Serialize 10784 ms
Deserialize 11374 ms
Size 362 bytes
Total 22158 ms
```
This test was run using the following object definition:
```
public class Poco
{
public string StringProp { get; set; } //using the text "hello"
public int IntProp { get; set; } //123
public Guid GuidProp { get; set; } //Guid.NewGuid()
public DateTime DateProp { get; set; } //DateTime.Now
}
```
> Big disclaimer: The above results change drastically depending on your contracts, e.g. using smaller messages favor both NetSerializer and Jil.
There is no "best" or "fastest" serializer, it all depends on context and requirements.