https://github.com/racc/typesafeconfig-guice
Allows Guice Injection of configuration values from Typesafe Config
https://github.com/racc/typesafeconfig-guice
dependency-injection guice hocon typesafe-config
Last synced: 5 months ago
JSON representation
Allows Guice Injection of configuration values from Typesafe Config
- Host: GitHub
- URL: https://github.com/racc/typesafeconfig-guice
- Owner: racc
- License: apache-2.0
- Created: 2015-05-27T09:55:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-08-01T20:04:07.000Z (almost 6 years ago)
- Last Synced: 2023-07-26T22:03:17.760Z (almost 3 years ago)
- Topics: dependency-injection, guice, hocon, typesafe-config
- Language: Java
- Homepage:
- Size: 65.4 KB
- Stars: 70
- Watchers: 5
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typesafe Config Guice
Allows [Guice](https://github.com/google/guice) to @Inject configuration values into your application derived from [Typesafe Config](https://github.com/typesafehub/config).
[](https://travis-ci.org/racc/typesafeconfig-guice)
Available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22typesafeconfig-guice%22).
```xml
com.github.racc
typesafeconfig-guice
0.1.0
```
### Quickstart
#### Step 1:
Annotate configuration injection points (Constructors, Providers, Provider methods, Setter methods, Fields) with ```@TypesafeConfig("config.path.key")```
#### Step 2:
Bootstrap your application with Guice and the TypesafeConfigModule.
Configuration values annotated with `@TypesafeConfig` will be scanned for on the classpath, and then bound from your supplied Typesafe Config file.
```java
Config config = ConfigFactory.load("config.conf");
Injector injector = Guice.createInjector(
TypesafeConfigModule.fromConfigWithPackage(config, "com.my.package");
// ... Add your other modules here
);
```
#### Step 3:
Profit!
### Features
- Plain Old Java Objects which follow JavaBean conventions (zero-args constructor, getters and setters) can be injected.
- Supports injections of `java.time.Duration` objects with config parameters defined as "10 seconds", "10 minutes" etc.
- Supports injections of `com.typesafe.config.ConfigMemorySize` objects with config parameters defined as "512k" or "2M" etc.
- Supports injections of `boolean`, where the matching config parameter can be "true", "false", "yes" or "no".
- Supports injections of List types of primitives: `boolean`, `int`, `double`, `long`, `string`, `java.time.Duration`, `com.typesafe.config.ConfigMemorySize`
- Supports injections of `java.util.Map`
- Supports injections of POJO Lists.
- Extensive test coverage
AUTHOR
-----------
Jason Then
Any comments and feedback appreciated!
LICENSE
-----------
Copyright 2018 Jason Then
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.