https://github.com/dsx-tech/rhea
Reactive configuration framework for Kotlin and Java
https://github.com/dsx-tech/rhea
config java kotlin reactive
Last synced: 3 months ago
JSON representation
Reactive configuration framework for Kotlin and Java
- Host: GitHub
- URL: https://github.com/dsx-tech/rhea
- Owner: dsx-tech
- License: mit
- Created: 2019-10-23T14:00:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T13:17:38.000Z (almost 5 years ago)
- Last Synced: 2025-01-19T22:41:46.821Z (4 months ago)
- Topics: config, java, kotlin, reactive
- Language: Kotlin
- Homepage:
- Size: 1.31 MB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rhea
**Rhea** is a type-safe dynamic configuration library for JVM applications. This library uses *asynchronous data flows* that gives a natural auto-reloading feature in runtime, so it allows to change configuration properties and get the freshest values in your application without the need to restart.
## Features
* Open source project under the MIT License
* Extendable with user-defined property types
* Extendable with user-defined configuration sources
* Supports reading configuration from files (.yaml, .properties, .json), Vault, JDBC, MongoDB
## Getting Started
### Setting up dependency
To get started, add `uk.dsxt:rhea-core:` as a dependency:
#### Gradle
```groovy
dependencies {
compile group: "uk.dsxt", name:"rhea-core", version: "0.0.1-SNAPSHOT"
}
```
#### Maven
```xml
uk.dsxt
rhea-core
0.0.1-SNAPSHOT
```
### Configuration Sources
To read configuration from source other than .properties, add its rhea module as a dependency.
For example, to add .json as configuration source:
#### Gradle
```groovy
dependencies {
...
compile group: "uk.dsxt", name:"rhea-json", version: "0.0.1-SNAPSHOT"
}
```
#### Maven
```xml
...
uk.dsxt
rhea-json
0.0.1-SNAPSHOT
```
Note: If configuration source is not supported, you can add it by implementing ConfigSource interface.
## Usage
### Java
1. Build a configuration object that holds properties, add configuration sources
```java
ConfigSource jsonSource =
new JsonConfigSource(Paths.get("src" + File.separator + "test" + File.separator + "resources"), "jsonSource.json");
ReactiveConfig config = new ReactiveConfig.Builder()
.addSource("jsonConfig", jsonSource)
.build();
```
2. Create reloadable properties
```java
Reloadable isSomethingOn = config.get("flag", PropertyTypesKt.booleanType);
Reloadable port = config.get("port", PropertyTypesKt.intType);
// access the freshest typed values with get()
Server server = new Server(port.get(), "host");
if (isSomethingOn.get()) {
server.start();
}
```
3. Also, you can add some complex logic that will execute every time the property is changed
```java
port.onChange((Integer newValue) -> {
// for example, restart server
});
```
### Kotlin
1. Build a configuration object that holds properties, add configuration sources
```kotlin
val jsonSource: ConfigSource =
JsonConfigSource(Paths.get("src" + File.separator + "test" + File.separator + "resources"), "jsonSource.json")
val config: ReactiveConfig = ReactiveConfig.Builder()
.addSource("jsonConfig", jsonSource)
.build()
```
2. Create reloadable properties or declare objects that extend PropertyGroup to define hierarchies of properties
```kotlin
val isSomethingOn: Realoadable = config["flag", booleanType]
object server : PropertyGroup() {
val name by stringType
val port by intType
}
// access the freshest typed values with get()
val server = Server(config[server.port].get(), config[server.name].get())
if (isSomethingOn.get()) {
server.start()
}
```
3. Also, you can add some complex logic that will execute every time the property is changed
```kotlin
val port: Reloadable = config[server.port]
port.onChange() {
// for example, restart server
}
```
## Extending
### Property Types
To add a custom property type, you should create an instance of PropertyType class and provide it with default property value and parse function.
### Configuration Sources
To support a new configuration source, you should implement ConfigSource interface.
## Contributors
* **Dmitry Vologin** - [GitHub account](https://github.com/vologin-dmitry)
* **Alexandra Osipova** - [GitHub account](https://github.com/FemiLame)
* **Anton Plotnikov** - [GitHub account](https://github.com/pltanton)
* **Philipp Dolgolev** - [GitHub account](https://github.com/phil-dolgolev)
## License
This project is licensed under the MIT License. The full text could be found in [LICENSE.md](https://github.com/dsx-tech/rhea/blob/master/LICENSE).
## Acknowledgments
* Inspired by Tinkoff ReactiveConfig and [Konfig](https://github.com/npryce/konfig)
## Notes
* [Rhea](https://en.wikipedia.org/wiki/Rhea_(mythology)) is one of the Titans in Greek mythology, the mother of the first generation of the Olympian gods
* Rhea's name is believed to be derived from the word ῥέω (rheo), meaning “flow” or “ease”