https://github.com/microsphere-projects/microsphere-resilience4j
The microsphere projects for resilience4j
https://github.com/microsphere-projects/microsphere-resilience4j
bulkhead circuit-breaker cloud-native devops fault-tolerance java metrics microservices microsphere resilience4j spring time-limit
Last synced: 12 days ago
JSON representation
The microsphere projects for resilience4j
- Host: GitHub
- URL: https://github.com/microsphere-projects/microsphere-resilience4j
- Owner: microsphere-projects
- License: apache-2.0
- Created: 2023-11-04T10:56:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-31T03:04:30.000Z (14 days ago)
- Last Synced: 2026-05-31T05:05:42.661Z (14 days ago)
- Topics: bulkhead, circuit-breaker, cloud-native, devops, fault-tolerance, java, metrics, microservices, microsphere, resilience4j, spring, time-limit
- Language: Java
- Homepage:
- Size: 864 KB
- Stars: 2
- Watchers: 0
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Microsphere Resilience4j
> Microsphere Projects for [Resilience4j](https://github.com/resilience4j/microsphere-resilience4j)
[](https://deepwiki.com/microsphere-projects/microsphere-resilience4j)
[](https://github.com/microsphere-projects/microsphere-resilience4j/actions/workflows/maven-build.yml)
[](https://app.codecov.io/gh/microsphere-projects/microsphere-resilience4j)
Microsphere Resilience4j is an extension framework that enhances the capabilities of the Resilience4j library by
providing seamless integration with popular Java frameworks and libraries. It offers a unified approach to implementing
fault tolerance patterns across different parts of an application.
The project aims to simplify the application of resilience patterns such as Circuit Breaker, Bulkhead, Rate Limiter,
Retry, and Time Limiter in various contexts including:
- Spring Web MVC applications
- API clients (Feign)
- Database access (MyBatis, JDBC with Druid and P6Spy)
## Modules
| **Module** | **Purpose** |
|-------------------------------------------|------------------------------------------------------------------------|
| **microsphere-resilience4j-parent** | Defines the parent POM with dependency management and version profiles |
| **microsphere-resilience4j-dependencies** | Centralizes dependency management for all project modules |
| **microsphere-resilience4j-commons** | Common featurues of Resilience4j extension |
| **microsphere-resilience4j-plugins** | The plugins of Resilience4j |
| **microsphere-resilience4j-spring** | Integration for Resilience4j Spring |
## Getting Started
The easiest way to get started is by adding the Microsphere Resilience4j BOM (Bill of Materials) to your project's
pom.xml:
```xml
...
io.github.microsphere-projects
microsphere-resilience4j-dependencies
${microsphere-resilience4j.version}
pom
import
...
```
`${microsphere-resilience4j.version}` has two branches:
| **Branches** | **Purpose** | **Latest Version** |
|--------------|--------------------------------------------------|--------------------|
| **main** | Compatible with Spring Cloud 2022.0.x - 2025.0.x | 0.2.1 |
| **1.x** | Compatible with Spring Cloud Hoxton - 2021.0.x | 0.1.1 |
## Building from Source
You don't need to build from source unless you want to try out the latest code or contribute to the project.
To build the project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/microsphere-projects/microsphere-resilience4j.git
```
2. Build the source:
- Linux/MacOS:
```bash
./mvnw package
```
- Windows:
```powershell
mvnw.cmd package
```
## Contributing
We welcome your contributions! Please read [Code of Conduct](./CODE_OF_CONDUCT.md) before submitting a pull request.
## Reporting Issues
* Before you log a bug, please search
the [issues](https://github.com/microsphere-projects/microsphere-resilience4j/issues)
to see if someone has already reported the problem.
* If the issue doesn't already
exist, [create a new issue](https://github.com/microsphere-projects/microsphere-resilience4j/issues/new).
* Please provide as much information as possible with the issue report.
## Documentation
### User Guide
[DeepWiki Host](https://deepwiki.com/microsphere-projects/microsphere-resilience4j)
### Wiki
[Github Host](https://github.com/microsphere-projects/microsphere-resilience4j/wiki)
### JavaDoc
- [microsphere-resilience4j-commons](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-commons)
- [microsphere-resilience4j-spring](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-spring)
- [microsphere-resilience4j-alibaba-druid](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-alibaba-druid)
- [microsphere-resilience4j-mybatis](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-mybatis)
- [microsphere-resilience4j-openfeign](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-openfeign)
- [microsphere-resilience4j-spring-web](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-spring-web)
- [microsphere-resilience4j-spring](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-resilience4j-spring)
## License
The Microsphere Spring is released under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).