Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hhblaze/biser
Biser is a cross-platform Binary and JSON Serializer for .NET / dotnet / core / standard / CoreRT / Mono WASM / C#
https://github.com/hhblaze/biser
alternative binary cross-platform dbreeze decoder encoder framework javascript json net netcore netstandard protobuf protobuf-net raft react reactjs serialization serializer vue
Last synced: 20 days ago
JSON representation
Biser is a cross-platform Binary and JSON Serializer for .NET / dotnet / core / standard / CoreRT / Mono WASM / C#
- Host: GitHub
- URL: https://github.com/hhblaze/biser
- Owner: hhblaze
- License: bsd-2-clause
- Created: 2018-02-19T15:24:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T09:44:52.000Z (over 1 year ago)
- Last Synced: 2024-10-13T04:10:55.738Z (about 1 month ago)
- Topics: alternative, binary, cross-platform, dbreeze, decoder, encoder, framework, javascript, json, net, netcore, netstandard, protobuf, protobuf-net, raft, react, reactjs, serialization, serializer, vue
- Language: C#
- Homepage:
- Size: 7.97 MB
- Stars: 41
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Biser.NET
[](https://github.com/hhblaze/Biser/blob/master/LICENSE)
[](https://www.nuget.org/packages/Biser/)
[](https://www.nuget.org/packages/BiserObjectify/)
[](http://tiesky.com)
Cross-platform BINARY and JSON serializer for .NET dotnet.
- Doesn't use reflection inside, only managed code, perfectly works in [MONO WASM](https://github.com/aspnet/Blazor) and [CoreRT](https://github.com/dotnet/corert) where AOT compilers are used,
that makes it a possible alternative to [protobuf-net](https://github.com/mgravell/protobuf-net), [MessagePack](https://github.com/neuecc/MessagePack-CSharp), [NetJSON](https://github.com/rpgmaker/NetJSON), [JSON.NET](https://www.newtonsoft.com/json).
- Has the same [operational speed (Benchmark)](https://github.com/hhblaze/Biser/blob/master/Benchmark/Program.cs) as protobuf-net and NetJSON, smaller payload and a tiny source code.
- Has custom encoding possibilities of any complexity.
- Different encoding/decoding scenarios for one object are supported.
- Thread safe. No need to "warm up" serializing/encoding entities.
Integrated part of [DBreeze database](https://github.com/hhblaze/DBreeze), used in [Raft.NET](https://github.com/hhblaze/Raft.Net)
### Quick start
- Grab from NuGet **Biser** (or **DBreeze** that contains Biser), grab from Nuget **BiserObjectify**.
- Let’s assume you have several objects to serialize. It is necessary to prepare them:
Call next line to create code for the serialzer:
```C#
var resbof = BiserObjectify.Generator.Run(typeof(TS6),true,
@"D:\Temp\1\", forBiserBinary: true, forBiserJson: true, null);
```
First argument is the type of the root object to be serialized (it can contain other objects that also must be serialized).
Second argument means that BiserObjectify must prepare serializer for all objects included into the root object.
Third argument points to the folder where C# files per object will be created.
The fourth and fifth arguments mean that we want to use both Binary and JSON serializers.
The sixth argument is a HashSet (or null) with the property names that will not be serialized.
resbof variable will contain the same information that in generated files also as a Dictionary.
- Copy generated files into your project and embed/link them to the project. Try to recompile.
- Probably, it will be necessary to add “partial” keyword to objects that must be serialized:
```C#
public partial class TS6
{
public string P1 { get; set; }
...
```
- Remove BiserObjectify from your project, it will not be necessary until next time.
Usage:
```C#
TS6 t6 = new TS6()
{
P1 = "dsfs",
P2 = 456,
P3 = DateTime.UtcNow,
P4 = new List>>
{
new Dictionary>{
{ DateTime.UtcNow.AddMinutes(-1), new Tuple(12,"testvar") },
{ DateTime.UtcNow.AddMinutes(-2), new Tuple(125,"testvar123") }
},
new Dictionary>{
{ DateTime.UtcNow.AddMinutes(-3), new Tuple(17,"dsfsdtestvar") },
{ DateTime.UtcNow.AddMinutes(-4), new Tuple(15625,"sdfsdtestvar") }
}
},
P5 = new Dictionary> {
{ 12, new Tuple(478,"dsffdf") },
{ 178, new Tuple(5687,"sdfsd") }
},
P6 = new Tuple, DateTime>>(445, "dsfdfgfgfg",
new Tuple, DateTime>(new List { "a1", "a2" }, DateTime.Now.AddDays(58))),
P7 = new List { "fgdfgrdfg", "dfgfdgdfg" },
P8 = new Dictionary> {
{ 34,new List { "drtttz","ghhtht"} },
{ 4534,new List { "dfgfghfgz","6546ghhtht"} }
},
P25 = new Dictionary>[,,,][][,,]
...
}
```
#### Binary serialization:
```C#
var serializedObjectAsByteArray = t6.BiserEncoder().Encode();
var retoredBinaryObject= TS6.BiserDecode(serializedObjectAsByteArray);
```
###### NOTE (for Binary serializer only)
- To have consistent data, after first serialization and storing byte[] into database - never delete serialized object/class properties.
- To have consistent data, after first serialization and storing byte[] into database - add new properties only to the end of the object/class, after all other properties are listed.
#### JSON serialization:
```C#
var jsonSettings = new Biser.JsonSettings { DateFormat = Biser.JsonSettings.DateTimeStyle.ISO };
string prettifiedJsonString = new Biser.JsonEncoder(t6, jsonSettings)
.GetJSON(Biser.JsonSettings.JsonStringStyle.Prettify);
var restoredJsonObject= TS6.BiserJsonDecode(prettifiedJsonString, settings: jsonSettings);
```
###### NOTE (for JSON serializer only)
- JSON serializer can also store multi-dimensional arrays like [,,] [,] [,,,] etc., representing it as a Tuple, object itself> where Item1 represents array dimensions.
###### Example of the [TS6 object for serialization](https://github.com/hhblaze/Biser/blob/da3a6ef3e993f8cb820f4ba497fdc714f68c95da/BiserTest_Net/TS6.cs) and generated by BiserObjectify [Binary and JSON serializer](https://github.com/hhblaze/Biser/blob/da3a6ef3e993f8cb820f4ba497fdc714f68c95da/BiserTest_Net/TS6_Biser.cs)
-------------
For the deep understanding:
- [Documentation binary Biser](https://docs.google.com/document/d/e/2PACX-1vQa3C506Esw3Fkroj4OA5erGOHEZpAtnXcQQ90R0w1wnFqO_16CH0dUfBJZt_ppB15ykoZWI9eR8KcG/pub)
- [Documentation JSON Biser](https://docs.google.com/document/d/e/2PACX-1vQa3C506Esw3Fkroj4OA5erGOHEZpAtnXcQQ90R0w1wnFqO_16CH0dUfBJZt_ppB15ykoZWI9eR8KcG/pub#id.yqadcf2f2moz)
- [Examples of manual encoders/decoders](https://github.com/hhblaze/Biser/blob/master/BiserTest_Net)
-------------