Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FasterXML/jackson-dataformats-binary
Uber-project for standard Jackson binary format backends: avro, cbor, ion, protobuf, smile
https://github.com/FasterXML/jackson-dataformats-binary
avro cbor hacktoberfest jackson-backends protobuf smile
Last synced: 2 months ago
JSON representation
Uber-project for standard Jackson binary format backends: avro, cbor, ion, protobuf, smile
- Host: GitHub
- URL: https://github.com/FasterXML/jackson-dataformats-binary
- Owner: FasterXML
- License: apache-2.0
- Created: 2016-05-03T04:54:56.000Z (over 8 years ago)
- Default Branch: 2.19
- Last Pushed: 2024-11-01T21:18:13.000Z (3 months ago)
- Last Synced: 2024-11-11T05:16:34.920Z (2 months ago)
- Topics: avro, cbor, hacktoberfest, jackson-backends, protobuf, smile
- Language: Java
- Homepage:
- Size: 10 MB
- Stars: 315
- Watchers: 19
- Forks: 136
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Overview
This is a multi-module umbrella project for [Jackson](../../../jackson)
standard binary dataformat backends.
Dataformat backends are used to support format alternatives to JSON, using
general-purpose Jackson API. Formats included allow access using all 3
API styles (streaming, databinding, tree model).
For Jackson 2.x this is done by sub-classing Jackson core abstractions of:
* All backends sub-class `JsonFactory`, which is factory for:
* `JsonParser` for reading data (decoding data encoding in supported format)
* `JsonGenerator` for writing data (encoding data using supported format)
* Starting with 2.10 there is also sub-class of `ObjectMapper` (like `CBORMapper`, `SmileMapper`) for all formats, mostly for convenience
* Jackson 2.10 also added "Builder" style construction for above-mentioned factories, mappers.
# Status
[](https://github.com/FasterXML/jackson-dataformats-binary/actions/workflows/main.yml)
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:jackson-dataformats-binary)
# Binary formats supported
Currently included backends are:
* [Avro](avro/) ([Avro format](http://avro.apache.org/docs/current))
* [CBOR](cbor/) ([CBOR format](https://tools.ietf.org/html/rfc7049))
* [Ion](ion/) ([Ion format](https://amznlabs.github.io/ion-docs/))
* [Protobuf](protobuf/) ([Protobuf format](https://developers.google.com/protocol-buffers/))
* [Smile](smile/) ([Smile format](https://github.com/FasterXML/smile-format-specification))
# License
All modules are licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt).
# Maven dependencies
To use these format backends Maven-based projects, use following dependency:
```xml
com.fasterxml.jackson.dataformat
jackson-dataformat-[FORMAT]
2.18.1
```
where `[FORMAT]` is one of supported modules (`avro`, `cbor`, `smile` etc)
# Development
## Maintainers
* Author: Tatu Saloranta (@cowtowncoder)
* Active Maintainers:
* Michael Liedtke (@mcliedtke) (Ion backend)
You may at-reference them as necessary but please keep in mind that all
maintenance work is strictly voluntary (no one gets paid to work on this
or any other Jackson components) so there is no guarantee for timeliness of
responses.
## Branches
`master` branch is for developing the next major Jackson version -- 3.0 -- but there
are active maintenance branches in which much of development happens:
* `2.19` is for developing the next 2.x version
* `2.18` and `2.17` are for backported fixes for 2.18/2.17 versions (respectively)
Older branches are usually not changed but are available for historic reasons.
All released versions have matching git tags (`jackson-dataformats-binary-2.10.3`).
Note that since individual format modules used to live in their own repositories,
older branches (before 2.8) and tags do not exist in this repository.
# Other Jackson binary backends
In addition to binary format backends hosted by FasterXML in this repo, there are other
known Jackson backends for binary data formats.
For example:
* [bson4jackson](https://github.com/michel-kraemer/bson4jackson) for [BSON](http://en.wikipedia.org/wiki/BSON)
* [EXIficient](https://github.com/EXIficient/exificient-for-json) for [Efficient XML Interchange](https://en.wikipedia.org/wiki/Efficient_XML_Interchange)
* [jackson-dataformat-msgpack](https://github.com/msgpack/msgpack-java/tree/develop/msgpack-jackson) for [MessagePack](http://en.wikipedia.org/wiki/MessagePack) (aka `MsgPack`) format
# More
See [Wiki](../../wiki) for more information (javadocs).