Osaru

Object Serialization And RPC Utilities

.Net3.5(Unity) Serialization library.

                     +----------+
                     |RPC method|
                     +----------+
                       ^     |
+----------------+     |     v    +--------------+
|IDeserializer<T>| ->  T     U -> |ISerializer<U>|
+----------------+                +--------------+
  ^                                 |
  |                                 v
+-------+    convert              +----------+
|IParser| ----------------------> |IFormatter|
+-------+                         +----------+
  ^                               |IStore    | --> Stream
  |           +-----------+       +--------- +
  +-----------|JSON       |<--------+
              |MessagePack|         Byte[]
              +-----------+
            serialized byte[]

Features

• separate deserializer and parser
• separate serializer and formatter
• inplace serialization
• inplace deserialization(but struct field setter use boxing)
• UWP compatible

Formats

JSON

• http://www.json.org/index.html
• http://www.jsonrpc.org/specification

MessagePack

• https://github.com/msgpack/msgpack/blob/master/spec.md
• https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Usage

parse json

var src = "{\"key\":{ \"nestedKey\": \"nestedValue\" } }";
var json = JsonParser.Parse(src);

Assert.AreEqual("nestedValue", json["key"]["nestedKey"].GetString());

json array

var json = JsonParser.Parse("[1, 2, 3]");
for(var item in json.ListItems)
{
    Console.WriteLine(item.GetInt32());
}

json object

using Osaru;

var json = "{\"key\": \"value\"}".ParseAsJson();
for(var item in json.ObjectItems)
{
    Console.WriteLine(item.Key); // JSON allow only string key
    Console.WriteLine(item.Value.GetString());
}

json formatter

using Osaru.Json;

var f=new JsonFormatter();
f.Value("abc");
Console.WriteLine(f.ToString()); // "abc"

f.Clear();
f.BeginList();
f.Value(true);
f.Null();
f.Value(1);
f.EndList();
Console.WriteLine(f.ToString()); // [true,null,1]

f.Clear();
f.BeginMap();
f.Key("key1"); f.Value(true);
f.Key("key2"); f.Null();
f.Key("key3"); f.Value(1);
f.EndMap();
Console.WriteLine(f.ToString()); // {"key1":true,"key2":null,"key3":1}

// get bytes
ArraySegment<Byte>=f.GetStore().Bytes;

customize json formatter

using Osaru.Json;

var s=new FileStream("out.json", FileMode.Create);
var f=new JsonFormatter(new StreamStore(s));

serialize & deserialize

using Osaru;
using Osaru.Serialization;

class Point
{
    public int X;
    public int Y;
    public Point(int x, int y)
    {
        X=x;
        Y=y;
    }
}

var r=new TypeRegistory();

// serialize
var bytes=r.SerializeToJsonBytes(new Point(1, 2));

// parse as json
var json=bytes.ParseAsJson();
Console.WriteLine(json["X"]); // 1
Console.WriteLine(json["Y"]); // 2

// deserialize
var p=default(Point);
r.Deserialize(json, ref p);
Console.WriteLine(p.X); // 1
Console.WriteLine(p.Y); // 2

custom serialization

RPC

using Osaru;
using Osaru.Serialization;
using Osaru.RPC;


// setup
var typeRegistory = new TypeRegistory();
var method = typeRegistory.RPCFunc((int a, int b) => a + b);
var dispatcher = new RPCDispatcher();
dispatcher.AddMethod("Add", method);

// request
var request = "{\"jsonrpc\":\"2.0\",\"method\":\"Add\",\"params\":[1,2],\"id\":1}";
var responseBytes = dispatcher.Dispatch(request.ParseAsJson());
var response=Encoding.UTF8.GetString(responseBytes.Array, responseBytes.Offset, responseBytes.Count);
Assert.AreEqual("{\"jsonrpc\":\"2.0\",\"result\":3,\"id\":1}", response);

ToDO

• integrate MsgPack library
• reorganize messagepack library
• fix UWP UnitTest
• RPCFormatter
• user class serialization
• json and messagepack converter
• json-rpc-2.0
• messagepack-rpc
• code generator for RPC client
• json base64 string for binary support
• json byte[] backend not string
• StreamStore
• BytesStore
• fix IParser.Dump
• rpc proxy
• endian conversion use union
• add Endian interface to IStore
• commonalize tests for json and messagepack
• organize extensions
• rpc error handling