+| Feature | JSONex | JSON |
|---|
+
+ | optional json top level braces - object |
+ a:1,b:2 |
+
+
+```json
+{
+ "a": 1,
+ "b": 2
+}
+```
+ |
+
+
+ | optional json top level braces - array |
+ a,b,1 |
+
+
+```json
+["a", "b", 1]
+```
+ |
+
+
+ | optional json top level braces - array of objects |
+ {a:1},{b:2},c |
+
+
+```json
+[
+ {"a": 1},
+ {"b": 2},
+ "c"
+]
+```
+ |
+
+
+
+
+ | Path compression |
+ a:b:{c:1, d:2} |
+
+
+```json
+{
+ "a":{
+ "b":{
+ "c":1,
+ "d":2
+ }
+ }
+}
+```
+ |
+
+
+ | Type wrapper |
+ buyer:user{name:abc, age:10} |
+
+
+```json
+{
+ "buyer":{
+ "$type":"user",
+ "name":"abc",
+ "age":10
+ }
+}
+```
+ |
+
+
+ | Optional Quotes |
+ {a: value1, b: value2} |
+
+
+```json
+{"a": "value1", "b": "value2"}
+```
+ |
+
+
+ | Commas are allowed for last element |
+ {a: 1, b: 2, } |
+
+
+```json
+{"a": 1, "b": 2}
+```
+ |
+
+
+ | Multi-line value |
+ {
+ a:
+ `abc
+ line2`,
+ b: 2
+ } |
+
+
+```json
+{"a": "abc\nline2", "b": 2}
+```
+ |
+
+
+
+
## Other similar effort
- [Json5](https://json5.org/)
diff --git a/README.md b/README.md
index 06a30a9..8ab5c48 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# JSONCoder
-[](https://travis-ci.org/eBay/jsonex)
+[](https://github.com/jianwu/jsonex/actions/)
[](https://codecov.io/gh/eBay/jsonex)
## Description
Jsonex JSONCoder is a light-weight generic object serialization / deserialization library similar to Jackson, GSON or FastJson. This library has been widely used in various eBay projects for years. It's not a replacement for other popular libraries. But it solves some specific problems which are not available or not well-supported in other alternatives.
@@ -55,14 +55,14 @@ Please refer the unit test class for more detailed usage patterns:
You can get current version by searching [maven central](https://search.maven.org/search?q=g:org.jsonex)
- Simple Serialization / Deserialization
- ```java
+ ```java
// serialization
JSONCoder.global.encode(o)
// de-serialization
SomeClass obj = JSONCoder.global.decode(str, SomeClass.class);
```
- Filter out fields and classes
- ```java
+ ```java
JSONCoderOption opt = new JSONCoderOption();
// For TestBean2 and it's sub-classes, only include field: "enumField2", "testBean"
opt.addFilterFor(TestBean2.class, include("enumField2", "testBean"));("field1ForClass1", "field2ForClass1");
@@ -75,21 +75,21 @@ Please refer the unit test class for more detailed usage patterns:
String result = JSONCoder.encode(bean, opt);
```
- Mask out certain fields: for privacy reason, quite often when we serialize an object, we need to maskout certain fields such as emailAddress, here's example to do that:
- ```java
+ ```java
String result = JSONCoder.encode(bean, JSONCoderOption.ofIndentFactor(2).addFilterFor(SomeBean.class, mask("field1", "field2")));
```
- Deserialize with generic types
- ```java
+ ```java
String str = "['str1', 'str2', 'str3']";
List