Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yyvess/guice-configuration
Guice configuration module allows inject values from files as JSON, HOCON and Properties format
https://github.com/yyvess/guice-configuration
guice guice-configuration json yaml
Last synced: about 7 hours ago
JSON representation
Guice configuration module allows inject values from files as JSON, HOCON and Properties format
- Host: GitHub
- URL: https://github.com/yyvess/guice-configuration
- Owner: yyvess
- License: apache-2.0
- Created: 2015-12-22T20:21:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T22:39:18.000Z (12 months ago)
- Last Synced: 2024-11-16T15:06:33.964Z (about 7 hours ago)
- Topics: guice, guice-configuration, json, yaml
- Language: Java
- Homepage:
- Size: 97.7 KB
- Stars: 34
- Watchers: 4
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Guice configuration module, JSON, HOCON & Properties formats supported, build on the top of Typesafe config
[](https://maven-badges.herokuapp.com/maven-central/net.jmob/guice.conf?gav=true) [](https://github.com/semantic-release/semantic-release)
[](https://sonarcloud.io/dashboard?id=net.jmob%3Aguice.conf) [](https://sonarcloud.io/dashboard?id=net.jmob%3Aguice.conf)
Guice configuration
======
## Overview
- Guice injection
- JSON, HOCON and Properties formats
- Substitutions ${foo.bar}
- Validation
## Binary Releases
You can find published releases on Maven Central.
net.jmob
guice.conf
v1.5.0
Optionally, to active validation, you must import a validator like Hibernate validator
org.hibernate.validator
hibernate-validator-cdi
6.2.0.Final
org.glassfish
javax.el
3.0.0
Link for direct download if you don't use a dependency manager:
- https://mvnrepository.com/artifact/net.jmob/guice.conf
## Quickstart
A configuration file `app.json` :
```javascript
{
"port": 8080,
"complexEntries": {
"hostname": "www.github.com",
"aMap": {
"key1": "value1",
"key2": "value2"
},
"aList": [
"value1",
"value2"
]
}
}
```
An interface where inject your structured configuration
```java
public interface MyServiceConfiguration {
@Length(min = 5)
String getHostname();
Map getAMap();
List getAList();
}
```
A service where configuration should be inject
```java
@BindConfig(value = "app", syntax = JSON)
public class Service {
@InjectConfig
private Optional port;
@InjectConfig("complexEntries")
private MyServiceConfiguration config;
public int getPort() {
return port.orElse(0);
}
public ServiceConfiguration getConfig() {
return config;
}
}
```
```java
public class GuiceModule extends AbstractModule {
@Override
protected void configure() {
install(new ConfigurationModule());
requestInjection(Service.class);
}
}
```
Configuration files are loaded of classpath by default
A directory can be specified to load configuration outside of classpath
```java
public class GuiceModule extends AbstractModule {
@Override
protected void configure() {
install(new ConfigurationModule()
.fromPath(new File("/etc")));
requestInjection(Service.class);
}
}
```
Variables on your configuration file can be substitued with environment variables.
Substitution should be active with the option 'resolve'
```java
@BindConfig(value = "config, resolve = true)
```
```javascript
{
myconfig: ${my.environement.property}
}
```
Please find more examples on src/test/samples
## Supported types
- boolean, Boolean
- String
- int, Integer, double, Double
- List>, Map>, with typed value support
- Optional>
- Any Interface, a proxy of this interface is injected
## References
- https://github.com/typesafehub/config
- https://github.com/google/guice
## License
The license is Apache 2.0, see LICENSE file.
Copyright (c) 2015-2016, Yves Galante