https://github.com/arakelian/json-filter
High speed filtering of arbitrarily large JSON documents
https://github.com/arakelian/json-filter
filter filtering high-performance java java-8 json json-filter json-stream streaming
Last synced: 5 months ago
JSON representation
High speed filtering of arbitrarily large JSON documents
- Host: GitHub
- URL: https://github.com/arakelian/json-filter
- Owner: arakelian
- License: apache-2.0
- Created: 2017-05-11T22:09:35.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-04-24T03:53:26.000Z (about 2 years ago)
- Last Synced: 2024-05-01T20:43:46.163Z (about 1 year ago)
- Topics: filter, filtering, high-performance, java, java-8, json, json-filter, json-stream, streaming
- Language: Java
- Size: 495 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# json-filter
[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.arakelian%22%20AND%20a%3A%22json-filter%22)
[](https://github.com/arakelian/json-filter/actions/workflows/ci.yml)
High-speed stream-based filtering of arbitrarily large JSON documents.
This library takes extraordinary pains to insure that Java objects are not created unnecessarily while processing
the input and output streams.
There are no dependencies on any third-party JSON libraries to ensure small code size, and to maximum performance
of JSON streaming for the purpose of filtering.
Applications:
* Redacting content that client is not allowed to see
* Reducing the size of large JSON before parsing using a library like Jackson
## Requirements
* Compatible with Java 8+
## Usage
Filtering a JSON stream is very easy:
```java
// configure input and output streams
JsonReader reader = new JsonReader()
JsonWriter writer = new JsonWriter()
// configure filter
JsonFilterOptions opts = ImmutableJsonFilterOptions.builder() //
.addExcludes("some/path/to/exclude") //
.addExcludes("another/path/to/exclude") //
.pretty(true) //
.build();
// execute filter
JsonFilter filter = new JsonFilter(reader,writer,options);
filter.process();
```
## Paths
Paths are used to identify JSON fragments that should be included or excluded. The forward slash (`/`)
character can be used to identify nested JSON elements.
Consider the following JSON:
```java
{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
},
"expensive": 10
}
```
The following paths could be constructed:
* `expensive` would resolve to a single node with a value of `10`
* `store/book/category` would resolve to 4 nodes with values of `reference` and `fiction`.
* `store/bicycle/color` would resolve to a single node with a value of `19.95`.
Note that paths do not need to contain array indices, e.g. `[]`. In the example above, `store/book` is an array,
but the path `store/book/category` implies traversal through the elements of each of `book`.
## Installation
The library is available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.arakelian%22%20AND%20a%3A%22json-filter%22).
### Maven
Add the following to your `pom.xml`:
```xml
central
Central Repository
http://repo.maven.apache.org/maven2
true
...
com.arakelian
json-filter
4.0.1
compile
```
### Gradle
Add the following to your `build.gradle`:
```groovy
repositories {
mavenCentral()
}
dependencies {
compile 'com.arakelian:json-filter:4.0.1'
}
```
## Licence
Apache Version 2.0