https://github.com/mkulak/ebon
Object graphs serialization/deserialization library for java
https://github.com/mkulak/ebon
Last synced: about 2 months ago
JSON representation
Object graphs serialization/deserialization library for java
- Host: GitHub
- URL: https://github.com/mkulak/ebon
- Owner: mkulak
- Created: 2012-06-05T19:45:06.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-01-22T19:57:51.000Z (over 12 years ago)
- Last Synced: 2025-02-09T07:15:09.690Z (4 months ago)
- Language: Java
- Homepage:
- Size: 215 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
EBON (efficient binary object notation)
=======================================
EBON is a binary data representation format for network transfer and data storage.
It was designed to represent graphs of simple [DTO](http://en.wikipedia.org/wiki/Data_transfer_object)-like objects
(much like [BSON](http://bsonspec.org/) but without MongoDb stuff).
EBON specification:
Terminals
byte 1 byte (8-bits)
int32 4 bytes (32-bit signed integer) big-endian
int64 8 bytes (64-bit signed integer) big-endian
double64 8 bytes (64-bit IEEE 754 floating point)
Non-terminals
entity ::= null | boolean | int | long | double | enum | string | list | map | object | byte_array | ref
null ::= \x00 Null
boolean ::= \x01 \x01 | \x01 \x00 Boolean (1 for 'true' and 0 for 'false')
int ::= \x02 int32 Integer
long ::= \x03 int64 Long integer
double ::= \x04 double64 Double precision floating point value
enum ::= \x10 string string Enum value (first string - class name, second - name of enum value)
string ::= ref | \x05 id size (byte*) UTF-8 encoded string (size - number of bytes in array)
byte_array ::= ref | \x08 id size (byte*) Array of bytes (size - length of array in bytes)
list ::= ref | \x06 id size (entity*) List (size - number of elements)
map ::= ref | \x09 id size (key_value*) Map (size - number of key-value pairs)
object ::= ref | \x07 id string size (field*) Object (string - class name, size - number of fields)
key_value ::= entity entity Entity-key and entity-value
field ::= string entity Name of field and its value
ref ::= \x11 id Reference to already serialized object
size ::= int32 Size
id ::= int32 Entity's identifier
This is very early draft. Specification is subject to change with no backward compatibility.
This project is a java library for serializing/deserializing object graphs in EBON format.
Library is released under [apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) license.
To use this lib in maven project:
ebon-repo
https://github.com/mkulak/ebon/raw/master/releases
com.xap4o
ebon
0.7
Serialization/deserialization is that simple:
class MyObjectTree {
public int a;
private boolean b;
private Map> foo;
@Skip
private String secretField;
@Getter("calculated-field-name")
public int calcBar() { .... }
@Setter("some-other-name")
public void setBaz(long value) { .... }
}
MyObjectTree obj = ...
byte[] bytes = EBON.serialize(obj);
MyObjectTree newObj = EBON.deserialize(bytes);
Features:
* dead simple spec and API
* no external dependencies
* can serialize graphs
* java/actionscript support
* no dinosaur legacy code
* no Serializable or any other mandatory interface
* no need to declare default constructors
Limitations:
All serialized objects should contain only fields of type boolean, int, long, double, String, List, Map, byte[], enum and
can contain objects of custom classes which themselves comply with same restrictions. So byte, char, short, float, Set
and arrays of any type are not supported. This is purely design decision in order to make lib more simple, clean and cross-language.
Also current version depends on sun.reflect.ReflectionFactory which is internal class of Oracle JVM and may not be available on other JVMs.
Actionscript 3 implementation is [here](https://github.com/mkulak/ebon-as).