techatpark / sjson Goto Github PK

Tailer made JSON Parser for Server Side workloads (API Server/Client)

License: BSD 2-Clause "Simplified" License

Java 100.00%

java json jsonparser rest-api

sjson's Introduction

SJson

SJson is a lightweight tailer made json parser for server side workloads. It tries to get optimized memory and performance with below goals.

Optimized for Serialization, Deserialization and validation.
Represent Json in native java format.
No external dependencies
Trust the validity of json documents. It is just enough to say invalid, reasoning is optional
Utilize latest java features

Note: This is not general purpose parser. This is specifically written for REST API use cases.

Service to Service Communications in microservices
Client SDK such as Elastic REST Client.

Usage

Include below in your pom.xml

<dependency>
   <groupId>com.techatpark.sjson</groupId>
   <artifactId>json-parser</artifactId>
   <version>1.0.0</version>
<dependency>

Below is the code to read JSON as Java Object

   Json json = new Json();
   Object obj = json.read(new StringReader("{ \"abc\" : \"def\" }"));

Development

Below VM Options should be added for JVM. This is required to calculate the size of the objects

-javaagent:<<PATH_TO_JAR>>/jamm-0.4.1.jar --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.math=ALL-UNNAMED

How it works

SJson was part of the tech talk series at Bangalore Opensource Java User Group. This will give an idea behind this work.

Setup : https://www.youtube.com/watch?v=q_1H8ZJceA8
Optimization: https://www.youtube.com/watch?v=XMRaLCRfvlQ
Collection: https://www.youtube.com/watch?v=tMgy5PxPFQ4

sjson's People

Contributors

Stargazers

Watchers

Forkers

ravindersravi devyanshirai amir-suhel karishma0905 vish7777 mohit-sahu hks-26 developeranand17 vikrampatil98 toshi-singh aman-palya jaydeosahu97 dineshchintagunta naman-fasterman

sjson's Issues

Json Schema Generator for Primitive Array

We need to create JSON Schema for Complex Java Objects

Different Primitives
Nested Objects
Nested Arrays

Test Isolation

s of now both valid and invalid test cases are together. this should be separated as they have senate flow

Generate JSON Schema from Java Types

Ref: https://github.com/reinert/JJSchema/

Parse Trusted JSON

PArser for Trusted JSON

Json Schema Abstract factory

Abstract factory for creating JSON Schema

Support List of Primitives from Generator

List << Integer >>
List << String >>

Invalid Parsing with Objects

@Test
    void testJSon() throws IOException {
        String jsonText = """
                {
                  "trueKey": true,
                  "falseKey": false,
                  "trueStrKey": "true",
                  "falseStrKey": "false",
                  "stringKey": "hello world!",
                  "intKey": 42,
                  "intStrKey": "43",
                  "longKey": 1234567890123456789,
                  "longStrKey": "987654321098765432",
                  "doubleKey": -23.45e7,
                  "doubleStrKey": "00001.000",
                  "BigDecimalStrKey": "19007199254740993.35481234487103587486413587843213584",
                  "negZeroKey": -0.0,
                  "negZeroStrKey": "-0.0",
                  "arrayKey": [0, 1, 2],
                  "objectKey": {
                    "myKey": "myVal"
                  }
                }
                """;
        Map<String,Object> ourJsonObject = (Map<String, Object>) new Json().read(new StringReader(jsonText));
        JsonNode jacksonJsonNode = new ObjectMapper().readTree(jsonText);
        String reversedJsonText = jackson.writeValueAsString(ourJsonObject);

        Assertions.assertEquals(jacksonJsonNode,
                jackson.readTree(new StringReader(reversedJsonText)),
                "Reverse JSON Failed");
    }

JSONSchema Model Definision

Preparation of Model to Define JSon Scheme

Stack Overflow with Nested Objects

Issue654WellFormedObject.json

Can not Catch Boolean Issues

{
  "bool": truewa,
  "dddd" : 2
}

Json Schema Type as Enum

JSON Schema Type is now represented as String. But it has to be Enum

Parameterised Test Cases

Create Parameterzed Unit 5 Test Cases

.mvn dir should not be commited in repo

Reasons are

This is a generated directory, none should touch nor version control
even mvnw.cmd mvnw should not be changed, let dev know to use the command ./mvnw -N wrapper:wrapper -Dmaven=3.8.7 to upgrade maven from command line
I love developers using a different versions of java, mvn etc to report compliance issues early on, rather than enforcing just xyz version of java etc..
If strictly required java version and mvn version should be captured in pom.xml