Collection of independent libraries on top of Spring Boot to provide a faster setup of jvm microservices.
"How can I die, when I have so much of the Universe left to explore?" - Stephen Hawking
Have a look at the release notes for details about updates and changes.
This project contains a number of independent libraries on top of Spring Boot to provide a faster setup of jvm microservices. The libraries are used in different projects at Breuninger. It's purpose is to provide a common implementation for cross-cutting requirements like:
- Health checks that are used to tell the load balancer whether or not a service is healthy.
- A status page/document that is used to give information about the current state of the service. Status information also include details about sub-components, background jobs like imports, and so on.
- A simple job handling library that is used to run asynchronous background jobs, which for example can be used to run data imports from other systems.
- An optional MongoDB-based implementation of a JobRepository
- Support for MongoDB-based repositories in case you do not like Spring Data
- Support for feature toggles based on Togglz
... plus all the features of Spring Boot.
Future Releases aka Roadmap
Semantic Versioning v2.0.0 is used to specify the version numbers.
2.0.0: spring-boot-starter-breuninger for Spring Boot 2.0
spring-boot-starter-breuninger-core: Main library of spring-boot-starter-breuninger.
spring-boot-starter-breuninger-jobs: Optional module providing a simple job library.
spring-boot-starter-breuninger-mongo: Auto-configuration for MongoDB repositories plus implementation of MongoJobRepository and Togglz StateRepository.
spring-boot-starter-breuninger-togglz: Optional support for feature toggles for spring-boot-starter-breuninger based on Togglz.
spring-boot-starter-breuninger-testsupport: Test support for feature toggles plus utilities.
spring-boot-starter-breuninger-validation: Optional module for validation in Spring with a specific response format.
example-status: Service only relying on
spring-boot-starter-breuninger-coreto show the usage of health and status features.
example-metrics: Service that is using
example-jobs: Spring-boot-starter-breuninger service using spring-boot-starter-breuninger-jobs to run background tasks.
example-togglz: Example using
spring-boot-starter-breuninger-togglzto implement feature toggles.
spring-boot-starter-breuninger-toggz, but with a MongoDB configuration to auto-configure persistence of feature toggles.
Make sure you have Java 10 or later and gradle 4.6 or later installed on your computer.
Test and create coverage report
Determine possible dependency updates
gradle dependencyUpdates -Drevision=release
Publish new releases
Known java 10 problems
To make gradle work with jdk10 you have to run it with jdk8 and set the compiling jdk path to 10.
You can do this by putting this into your ~/.gradle/gradle.properties:
When running gradle tasks you then have to set
-Djava.endorsed.dirs= as shown in this example:
$ gradle bootRun -Djava.endorsed.dirs=
Have a look at our contribution guidelines.