Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shyiko/dotenv
A twelve-factor configuration (12factor.net/config) library for Java 8+
https://github.com/shyiko/dotenv
Last synced: 12 days ago
JSON representation
A twelve-factor configuration (12factor.net/config) library for Java 8+
- Host: GitHub
- URL: https://github.com/shyiko/dotenv
- Owner: shyiko
- Created: 2017-07-14T18:20:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-07T21:02:54.000Z (almost 7 years ago)
- Last Synced: 2024-08-01T18:24:28.714Z (3 months ago)
- Language: Java
- Size: 59.6 KB
- Stars: 46
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-java - dotenv - Twelve-factor configuration library which uses environment-specific files. (Projects / Configuration)
- awesome-java-zh - dotenv - 使用特定于环境的文件的十二因素配置库。 (项目 / 配置)
- awesome-java - dotenv - Twelve-factor configuration library which uses environment-specific files. (Projects / Configuration)
README
# dotenv [](https://travis-ci.org/shyiko/dotenv) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.github.shyiko.dotenv%22%20AND%20a%3A%22dotenv%22)
A [twelve-factor configuration](https://12factor.net/config) library for Java 8+.
Features:
- [seamless integration with Guice](https://github.com/shyiko/dotenv#integration-with-guice) (prefer Spring? see [here](https://github.com/shyiko/dotenv#integration-with-spring));
- zero dependencies;
- available in Maven Central.
## Usage
```xml
com.github.shyiko.dotenv
dotenv
0.1.1
```
ENV resolution order (sources higher in the list take precedence over those located lower):
- System.getenv()
- `.env` file in current working directory (might not exist)
- `.env` file on the classpath
> (java example)
Let's assume you have a jar file (say `app.jar`) which contains .env file (e.g. `printf "SCHEME=http\nHOST=localhost\n# comment\nPORT=8080" > src/main/resources/.env`) and Main.java with the following `public static void main(...)`:
```java
Map dotEnv = DotEnv.load();
System.out.println(dotEnv.get("SCHEME") + "://" + dotEnv.get("HOST") + ":" + dotEnv.get("PORT"))
```
Executing the following
```sh
printf "HOST=0.0.0.0" > .env
PORT=5050 app.jar
```
will then output `http://0.0.0.0:5050`
### Integration with [Guice](https://github.com/google/guice)
```xml
com.github.shyiko.dotenv
dotenv-guice
0.1.1
```
> (Main.java)
```java
static class S {
private final String scheme;
private final String host;
private final int port;
@Inject
public S(
@DotEnvValue("SCHEME") String scheme,
@DotEnvValue("HOST") String host,
@DotEnvValue("PORT") int port
) {
this.scheme = scheme;
this.host = host;
this.port = port;
}
public void run() {
System.out.println(scheme + "://" + host + ":" + port);
}
}
public static void main(String[] args) {
Injector injector = Guice.createInjector(new DotEnvModule()/*, ... */);
S s = injector.getInstance(S.class);
s.run();
}
```
### Integration with [Spring](https://spring.io/)
> (Main.java)
```java
static class S {
private final String scheme;
private final String host;
private final int port;
@Autowired
public S(
@Value("${SCHEME}") String scheme,
@Value("${HOST}") String host,
@Value("${PORT}") int port
) {
this.scheme = scheme;
this.host = host;
this.port = port;
}
public void run() {
System.out.println(scheme + "://" + host + ":" + port);
}
}
public static void main(String[] args) {
ConfigurableApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.getEnvironment().getPropertySources().addFirst(
new MapPropertySource("dotenv", new HashMap<>(DotEnv.load()))
);
ctx.refresh();
S s = ctx.getBeanFactory().createBean(S.class);
s.run();
}
```
## Development
```sh
git clone https://github.com/shyiko/dotenv && cd dotenv
./mvnw # shows how to build, test, etc. project
```
## Legal
All code, unless specified otherwise, is licensed under the [MIT](https://opensource.org/licenses/MIT) license.
Copyright (c) 2017 Stanley Shyiko.