Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michel-kraemer/bson4jackson
🦬 A pluggable BSON generator and parser for the Jackson JSON processor.
https://github.com/michel-kraemer/bson4jackson
binary bson jackson jackson-json-processor java json mongodb
Last synced: 11 days ago
JSON representation
🦬 A pluggable BSON generator and parser for the Jackson JSON processor.
- Host: GitHub
- URL: https://github.com/michel-kraemer/bson4jackson
- Owner: michel-kraemer
- License: apache-2.0
- Created: 2010-09-08T05:46:47.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2024-02-16T06:51:52.000Z (9 months ago)
- Last Synced: 2024-10-10T20:50:50.722Z (about 1 month ago)
- Topics: binary, bson, jackson, jackson-json-processor, java, json, mongodb
- Language: Java
- Homepage: https://michelkraemer.com/binary-json-with-bson4jackson
- Size: 962 KB
- Stars: 291
- Watchers: 24
- Forks: 84
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# BSON for Jackson [](https://github.com/michel-kraemer/bson4jackson/actions) [](http://www.apache.org/licenses/LICENSE-2.0)
This library adds support for [BSON](http://bsonspec.org) to the
[Jackson JSON processor](https://github.com/FasterXML/jackson).
BSON is a binary representation of [JSON](https://json.org/). It is
well known as the main exchange and persistence
format of [MongoDB](https://www.mongodb.com/).
## Quick start
Just create a Jackson `ObjectMapper` with a `BsonFactory` as follows:
```java
ObjectMapper mapper = new ObjectMapper(new BsonFactory());
```
For more information, you may read my
[bson4jackson tutorial](https://michelkraemer.com/binary-json-with-bson4jackson)
or the complete [documentation of Jackson](https://github.com/FasterXML/jackson).
## Download
bson4jackson binaries are available from the
[GitHub releases page](https://github.com/michel-kraemer/bson4jackson/releases>).
You may also use [Maven](http://maven.apache.org/) to download bson4jackson:
```xml
de.undercouch
bson4jackson
2.15.1
```
If you are using [Gradle](https://gradle.org/), you may add the
following snippet to your `build.gradle`:
```gradle
dependencies {
implementation 'de.undercouch:bson4jackson:2.15.1'
}
```
## Compatibility
The latest version of bson4jackson is backward compatible to all versions of
Jackson 2.x released up to date. It should be compatible to newer versions as
well. If you experience compatibility issues,
[just let me know](https://github.com/michel-kraemer/bson4jackson/issues).
If you are looking for a version compatible to Jackson 1.x, please use
bson4jackson 1.3.0. It's the last version for the 1.x branch.
bson4jackson 1.3.0 is compatible to Jackson 1.7 up to 1.9.
## Compiling
Execute the following command to compile the library and to run the
unit tests:
./gradlew test
The script automatically downloads the correct Gradle version so you
won't have to do anything else. If everything runs successfully, you
may create a .jar library:
./gradlew jar
The library will be located under `build/libs`.
## License
bson4jackson is licensed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.