Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meks77/easy-validation
Very easy way to validate simple and complex objects by using a fluent interface
https://github.com/meks77/easy-validation
fluent-api java validation
Last synced: 16 days ago
JSON representation
Very easy way to validate simple and complex objects by using a fluent interface
- Host: GitHub
- URL: https://github.com/meks77/easy-validation
- Owner: meks77
- License: apache-2.0
- Created: 2018-04-19T04:22:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T15:18:26.000Z (about 1 year ago)
- Last Synced: 2024-11-07T00:47:15.610Z (2 months ago)
- Topics: fluent-api, java, validation
- Language: Java
- Homepage:
- Size: 418 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
[](https://sonarcloud.io/dashboard?id=at.meks%3Aeasy-validation-parent)
# easy-validation
Very easy way to validate simple and complex objects by using an fluent interface.
## Goals
* No 3rd party dependencies
* Very small artefact size
* clean and natural api
## Examples
### Simply validate a method argument and throw an IllegalArgumentException
If you want to validate just a method argument you can do this by using the module easy-validation-args.
````
validate().that(arg1)
.withMessage(() -> "arg1")
.isNotBlank()
.hasMinLength(30)
.matches(value -> value.contains("whatIsExpected"));
````
Commonly when you implement a validation the code would look like this:
````
if (StringUtils.isBlank(arg1)) {
throw new IllegalArgumentException("arg1");
}
if (arg1.length() <= 30) {
throw new IllegalArgumentException("arg1");
}
if (arg1.contains("whatIsExpected") {
throw new IllegalArgumentException("arg1);
}
````
Just imagine you have 20+ different input values you have to validate. The code is growing very fast and it will get hard
to maintain as it grows.
You also have the possibility to set a seperate message per validation.
````
validate().that(arg1)
.withMessage(() -> "arg1 mustn't be blank").isNotBlank()
.withMessage(() -> "arg1 must have at leat 30 chars").hasMinLength(30)
.withMessage(() -> "arg1 must contain \"whatIsExpected\"").matches(value -> value.contains("whatIsExpected"));
````
### Do more validations to report in any way you want
Expect the case you want to validate the input to be not blank and it mustn't contain whitespace, but you want to report
it with different error messages.
````
List occuredErrorKeys = new ArrayList<>();
String validatedValue = " ";
Validator.reportTo(occuredErrorKeys::add)
.verify(validatedValue)
.usingKey("notBlank").matches(StringUtils::isNotBlank)
.and().usingKey("whitespaces").matches(StringUtils::doesNotContainWhitespace)
.and().usingKey("minLength").matches(value -> StringUtils.length(value) > 10);
````
In the list occuredErrorKeys the errors notBlank, whitespaces and minLength will be added. With this information you can report
the error however you want.
### Throw the Exception you want
If you have the need to throw your own exception in case of the first violation, e.g. for throwing an error code, just
go ahead like this:
````
Validator.stopOnFirstError()
.throwing(() -> new MyCheckedExceptionWithErrorCode(999))
.verify(validatedValue)
.matches(StringUtils::isNotBlank)
.and(StringUtils::doesNotContainWhitespace)
````
## Matchers
First I thought using commons-lang3 is fine. But I realized that commons-lang3 size is about 500 KB.
Furthermore: How to avoid dependency clashes?
Therefore I decided to use my own matchers. Currently in version 2.0.0-RC2 the size is ~ 6 KB.
Furthermore the whole validation has no dependency to any 3rd party library. So you can use always as long you use at least
java 11.
## Details and Maven Coordinates
More Details and Maven Coordinates can be found at the modules:
* [Matchers](matcher/Readme.md)
* [Core](core/Readme.md)
* [Args](args/Readme.md)
## History
While developing the first release I followed the main concept of using lambda combined with a fluent interface is from Joel Planes, what can be found [here](https://medium.com/@jplanes/lambda-validations-with-java-8-86aa8143bd9f).
But I was getting tired to always invoke the method test and afterwards the method throwIfInvalid.
Thanks to Eric Evans input I developed it from scratch with the possibility to decide if I want to throw an exception or not easy, without duplicating so much method signatures.
I hope you like the result.