https://github.com/mariazevedo88/json-formatter-validator
Java tool for JSON validation via string or file and correction of invalid JSON-like string
https://github.com/mariazevedo88/json-formatter-validator
coveralls gson jacoco java java-8 java8 json json-formatter json-formatters json-validation junit5 string-manipulation
Last synced: 10 months ago
JSON representation
Java tool for JSON validation via string or file and correction of invalid JSON-like string
- Host: GitHub
- URL: https://github.com/mariazevedo88/json-formatter-validator
- Owner: mariazevedo88
- License: mit
- Created: 2019-02-11T01:04:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T03:01:02.000Z (over 2 years ago)
- Last Synced: 2025-07-04T18:11:21.778Z (11 months ago)
- Topics: coveralls, gson, jacoco, java, java-8, java8, json, json-formatter, json-formatters, json-validation, junit5, string-manipulation
- Language: Java
- Homepage:
- Size: 188 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# json-formatter-validator
[](https://travis-ci.org/mariazevedo88/json-formatter-validator) [](https://coveralls.io/github/mariazevedo88/json-formatter-validator?branch=master)         
## About json-formatter-validator
Library used to format an invalid JSON: a string in a JSON-like format, but no quotation marks on keys and values, or with other errors. The tool works with two input types: string and JSON file.
The method `checkValidityAndFormatObject()` checks if JSON is valid or not. If JSON is invalid, the string is formatted via regex to add the quotation marks. If JSON is already valid, nothing is done and JSON itself is returned. This functionality can be called as follows:
**Input**
```
String invalidJSON = "{id:267107086801,productCode:02-671070868,lastUpdate:2018-07-15,lastUpdateTimestamp:2018-07-15 01:49:58,payment:[{sequential:1,id:CREDIT_CARD,value:188,installments:9}]}";
CustomJSONFormatter formatter = new CustomJSONFormatter();
formatter.checkValidityAndFormatObject(invalidJSON);
```
**Output**
```
19/02/14 00:08:57 INFO jsonformattervalidator.JsonFormatterValidatorApplication: Started Json Formatter Validator Aplication
19/02/14 00:08:57 INFO formatter.CustomJSONFormatter: Invalid json: {id: 267107086801,productCode:02-671070868,lastUpdate:2018-07-15,lastUpdateTimestamp:2018-07-15 01:49:58,payment:[{sequential:1,id: CREDIT_CARD,value: 188,installments:9}]}
19/02/14 00:08:57 INFO formatter.CustomJSONFormatter: Valid json: {"id":"267107086801","productCode":"02-671070868","lastUpdate":"2018-07-15","lastUpdateTimestamp":"2018-07-15 01:49:58","payment":[{"sequential":"1","id":"CREDIT_CARD","value":"188","installments":"9"}]}
```
In versions 2.0 onwards (v.2.0.0, v.2.0.1, etc ...), it is possible to filter one or more attributes of the string that looks like a json or remove one or more attributes, either to discard them by not use or because they are completely corrupted.
Example of the filter option:
**Input**
```
String invalidJson = "{id:265998308001,productCode:02-659983080,purchaseDate:2018-01-17,person:{name:Mariana,document:0123456789},deliveryAddress:{street:Rua Fechada,number:666,additionalInfo:casa,city:Lavras,state:MG,zipcode:00000000}}";
String[] filterById = {"id"};
String jsonFiltered = formatter.filterJSONObjectsFromString(invalidJson, filterById);
```
**Output**
```
"{id:265998308001,}"
```
Example of the remove option:
**Input**
```
String invalidJson = "{id:265998308001,productCode:02-659983080,purchaseDate:2018-01-17,person:{name:Mariana,document:0123456789},deliveryAddress:{street:Rua Fechada,number:666,additionalInfo:casa,city:Lavras,state:MG,zipcode:00000000}}";
String[] fieldsToRemove = {"person","deliveryAddress"};
String jsonFiltered = formatter.removeJSONObjectsFromString(invalidJson, fieldsToRemove);
```
**Output**
```
"{id:265998308001,productCode:02-659983080,purchaseDate:2018-01-17,}"
```
You can also mute the application logs and thrown exceptions. Just use as a parameter `true` and `true` values for the `muteLog` and the `muteException` variables, respectively, in the method `checkValidityAndFormatObject`, as the example below:
```
JsonObject invalidJson = formatter.checkValidityAndFormatObject(jsonFormatted, true, true);
```
To access the valid JSON, the `getValidJson()` method should be used. Example:
**Input**
```
JsonObject validJson = formatter.getValidJson();
JsonElement id = validJson.get("id");
logger.info(id.getAsLong());
```
**Output**
```
19/02/14 00:08:57 INFO jsonformattervalidator.JsonFormatterValidatorApplication: 267107086801
```
## Dependencies
- [Java 8](https://www.oracle.com/technetwork/pt/java/javase/downloads/index.html)
- [Maven](https://maven.apache.org/)
- [Gson 2.8.9](https://mvnrepository.com/artifact/com.google.code.gson/gson)
- [log4j 2.16.0](https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core)
- [JUnit 5](https://junit.org/junit5/docs/current/user-guide/)
## How to use
You must import .jar into the classpath of your project. If your project is a maven project, just set it as dependency in `pom.xml`, as follows:
```
io.github.mariazevedo88
json-formatter-validator
2.0.6
```
## Contributing
[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/0)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/1)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/2)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/3)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/4)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/5)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/6)[](https://sourcerer.io/fame/mariazevedo88/mariazevedo88/json-formatter-validator/links/7)