tinyconfig

Tiny config loader for Java

SYNOPSIS

ConfigReader reader = ConfigReaderBuilder.create()
        .build();
ConfigFile config = reader.read(ConfigFile.class);

Usage

Load from resources

TinyConfig loads config-${profile}.yml from resource by default. Default $profile is local. You can overwrite $profile by -Dconfig.profile system property.

# load config-release.yml from resources
java -Dconfig.profile=release

# load config-staging.yml from resources
java -Dconfig.profile=staging

Load from specified file

If there's a configuration file specified by config.file system property, config loads it.

java -Dconfig.file=path/to/config.yml

Overwrite configuration at runtime

You can overwrite configurations at runtime by environment variable and system properties.

For example, declare the following configuration file model.

@Data
public static class ConfigFile {
    private String env;
    private DataSourceConfig dataSource;

    @Data
    public static class DataSourceConfig {
        private String uri;
    }
}

System properties

You can overwrite dataSource.uri via -DdataSource.uri.

Environment variable

You can write overwrite configuration by environment variable.

If there's a configuration file like this, you can overwrite dataSource.uri by ENV['DATA_SOURCE_URI'].

If you want to check the real environment variable name, you can enable the TRACE level logging.

Include YAML

You can include YAML from YAML. TinyConfig defines custom tag for including.

---
mybatis: !file /etc/mybatis.yml
freemarker: !resource config/freemarker-devel.yml

!file includes YAML from file.

!resource includes YAML from classpath.

Customize your config reader

setConfigFilePrefix

Set prefix of configuration file resource.

Default value is config-.

ConfigReader configReader = ConfigReaderBuilder.create()
    .setConfigFilePrefix("application-")
    .build();

setConfigFileProperty

Set configuration file name property name.

Default value is config.file.

ConfigReader configReader = ConfigReaderBuilder.create()
    .setConfigFileProperty("config.location")
    .build();

setConfigProfileProperty

Set property name for configuration profile.

Default value is config.profile.

ConfigReader configReader = ConfigReaderBuilder.create()
    .setConfigProfileProperty("myapp.env")
    .build();

Supported Java version

Java 8+

LICENSE

The MIT License (MIT)
Copyright © 2016 Tokuhiro Matsuno, http://64p.org/ <tokuhirom@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.