Awesome
vertx-bson-codec
BSON Codec for Vert.x 3
Why another codec?
The standard EventBus from Vert.x allows Verticles to communicate with each other using JSON. JSON is a generic and fairly simple encoding scheme, however it limits the data types to be:
- Number (normally a Double)
- String
- Boolean
- Array (Ordered List)
- Object (Map)
- null
Although for most cases these data types are enough, in some more complex cases a Verticle might need to exchange more rich type data such as Dates, Integers, UUIDs, Regular Expressions, Binary data. This is where the BSON EventBus comes in.
Implementation details
The module has no external dependencies, I've decided to implement the bson codec myself to optimize the usage of vert.x buffers, and for that reason it is quite basic for the moment.
Type mapping implementation status
| BSON | Java | Implemented | Comments |
|---|---|---|---|
| Floating Point | Double | ✔ | |
| UTF-8 String | String | ✔ | |
| Embedded Document | java.util.Map | ✔ | |
| Array | java.util.List | ✔ | |
| Binary::Generic | byte[] | ✔ | |
| Binary::Function | |||
| Binary::Binary (OLD) | byte[] | ✔ | Deprecated/Only ReadOnly Support (when other sources write data to the Bus |
| Binary::UUID (OLD) | Deprecated | ||
| Binary::UUID | java.util.UUID | ✔ | |
| Binary::MD5 | com.jetdrone.bson.vertx.MD5 | ✔ | This is a interface that you need to implement getHash() : byte[] |
| Binary::User Defined | com.jetdrone.bson.vertx.Binary | ✔ | This is a interface that you need to implement getBytes() : byte[] |
| Undefined | Deprecated | ||
| ObjectId | com.jetdrone.bson.vertx.ObjectId | ✔ | |
| Boolean | Boolean | ✔ | |
| UTC Datetime | java.util.Date | ✔ | |
| Null | null | ✔ | |
| Regular Expression | java.util.regex.Pattern | ✔ | |
| DBPointer | Deprecated | ||
| JavaScript Code | |||
| Symbol | Deprecated | ||
| JavaScript Code w/scope | |||
| 32bit Integer | Integer | ✔ | |
| Timestamp | java.sql.Timestamp | ✔ | |
| 64bit Integer | Long | ✔ | |
| MinKey | com.jetdrone.bson.vertx.Key.MIN | ✔ | |
| MaxKey | com.jetdrone.bson.vertx.Key.MAX | ✔ |
Quickstart
Just register the Codec as any other codec:
EventBus eb = vertx.eventBus();
eb.registerDefaultCodec(BSONDocument.class, new BSONMessageCodec());