Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shihyuho/jackson-dynamic-filter-spring-boot-starter
An easy way to determine filters dynamically with Jackson
https://github.com/shihyuho/jackson-dynamic-filter-spring-boot-starter
filter gson jackson property spring-boot spring-boot-starter spring-mb
Last synced: 3 months ago
JSON representation
An easy way to determine filters dynamically with Jackson
- Host: GitHub
- URL: https://github.com/shihyuho/jackson-dynamic-filter-spring-boot-starter
- Owner: shihyuho
- License: apache-2.0
- Created: 2018-07-27T03:26:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-31T03:02:51.000Z (over 6 years ago)
- Last Synced: 2023-07-27T15:43:36.652Z (over 1 year ago)
- Topics: filter, gson, jackson, property, spring-boot, spring-boot-starter, spring-mb
- Language: Java
- Homepage:
- Size: 48.8 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/shihyuho/jackson-dynamic-filter-spring-boot-starter
)
[](https://maven-badges.herokuapp.com/maven-central/com.github.shihyuho/jackson-dynamic-filter-spring-boot-starter)
[](https://github.com/shihyuho/jackson-dynamic-filter-spring-boot-starter/blob/master/LICENSE)
# Jackson Dynamic Property Filter - Spring Boot Starter
Spring Boot Starter for [jackson-dynamic-filter](https://github.com/shihyuho/jackson-dynamic-filter), which provides an easy way to determine filters dynamically with [jackson](https://github.com/FasterXML/jackson) WITHOUT writing annotations directly on java object, and it also well integration with Spring MVC/Spring Boot.
## Prerequisites
- Java 8 and above
- [Maven](http://maven.apache.org/) 3.0 and above
- Supported Spring IO Platform:
- [Athens-SR1](http://docs.spring.io/platform/docs/Athens-SR1/reference/htmlsingle/#appendix-dependency-versions)
- [Brussels-SR11](http://docs.spring.io/platform/docs/Brussels-SR11/reference/htmlsingle/#appendix-dependency-versions)
- [Cairo-SR2](http://docs.spring.io/platform/docs/Cairo-SR2/reference/htmlsingle/#appendix-dependency-versions)
## Setup
All you need to do is to add dependency in your Spring Boot Maven project:
```xml
com.github.shihyuho
jackson-dynamic-filter-spring-boot-starter
1.0.1
```
Or in your Spring Boot Gradle project:
````groovy
compile 'com.github.shihyuho:jackson-dynamic-filter-spring-boot-starter:1.0.1'
````
and it's done, have fun!
## Using annotation
- `@SerializeAllExcept` - Serializing all properties, except for ones explicitly listed to be filtered out.
- `@FilterOutAllExcept` - Filtering out unknown properties and only serializes ones explicitly listed.
```java
@RestController
public class SomeController {
@SerializeAllExcept({"someField", "anotherField"})
@RequestMapping(value = "/without/some-fields", method = RequestMethod.GET)
public SomeObject withoutSomeFields() {
return someObject;
}
@FilterOutAllExcept({"someField", "anotherField"})
@RequestMapping(value = "/only/some-fields", method = RequestMethod.GET)
public SomeObject onlySomeFields() {
return someObject;
}
}
```
## Custom annotation
Define a custom annotation:
```java
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface WithoutAuditingFields {
}
```
then register a resolver, extends `DynamicFilterResolver`, as Spring bean. Starter will auto find out all `DynamicFilterResolver` (including subclasses) in Spring context.
```java
@Component
public class WithoutAuditingFieldsResolver extends DynamicFilterResolver {
@Override
public PropertyFilter apply(WithoutAuditingFields annotation) {
return SimpleBeanPropertyFilter.serializeAllExcept(
"id", "createdBy", "createdTime", "modifiedBy", "modifiedTime");
}
}
```
> More detail about [SimpleBeanPropertyFilter](https://fasterxml.github.io/jackson-databind/javadoc/2.3.0/com/fasterxml/jackson/databind/ser/impl/SimpleBeanPropertyFilter.html)
then use it for you controller as follows:
```java
@RestController
public class SomeController {
@WithoutAuditingFields
@GetMapping(value = "/some-path")
public SomeObject getSomeObject() {
return someObject;
}
}
```
## Application properties
The following properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
```properties
# Application will halt if any exception occurred while initialing jackson-dynamic-filter; otherwise just write a error log.
jackson.dynamic.filter.fail-fast=false
# Resolver classes (with a default constructor) that are not Spring beans, but still need to inject into jackson-dynamic-filter
jackson.dynamic.filter.resolver.class-names=this.is.my.Resolver,yet.another.Resolver
```
## Code Examples
Actual Spring Boot configurations and examples can be found in the [./_examples/](_examples) directory.