Giter VIP home page Giter VIP logo

serizilla's Introduction

serizilla

๐Ÿ“š Introduction

This project aims to easily serialize objects to and from byte streams. While Java presents its own features, there are some use cases, e.g. sharing objects between programming languages, sending objects over the network or creating protocols.

With the 2.0, you are able to create byte streams that are similar to those of protocols:

                           0         15 16      31 32             95
                            โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” 
                        0   โ”‚   Type   โ”‚  Topic   โ”‚   unique id   โ”‚ 
                            โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค 
                            โ”‚                                     โ”‚ 
                            โ”‚               Message               โ”‚ 
                        96  โ”‚          (Variable length)          โ”‚ 
                            โ”‚                                     โ”‚ 
                            โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ 

These byte streams are being deconstructed and reconstructed from objects to objects and thus can be shared between languages and networks.

๐ŸŽˆ Getting started

The serializer heavily depends on annotations as most of my other projects do as well. To get started, add the following annotation on top of you class:

@Description(
    uuid = "SomeUniqueId"
)
public class MyTestClass {
    
    // With empty constructor
    
}

Fields that need to be serialized, need to be public and annotated. As serizilla uses byte streams to create protocols, you are required to reserve byte lengths for each field. The default length is 128 bytes per field.

@Serialize(1000)
public List<String> names = Arrays.asList("Hans", "Peter", "Dieter");

@Serialize(16) // Only 16 bytes long name
public String test;

Serializing classes

You can also serialize classes that are not top level. This only requires to have an toString and valueOf method as many other Java classes already provide by default.

serizilla's People

Contributors

github-actions[bot] avatar micartey avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.