JarCastingProperlty - Simple configuration library with placeholders resolution and no magic!
Properlty provides a simple way to configure an application from multiple sources — built in resources, system properties, property files, environment variables, and whatever else you like.
Some features:
- Recursive placeholders resolution
- Only 30Kb and no external dependencies
- Java and Kotlin versions
Getting Started
- To get started, add Properlty dependency to your project.
For Kotlin:
<dependency>
<groupId>com.ufoscout.properlty</groupId>
<artifactId>properlty-kotlin</artifactId>
<version>1.8.1</version>
</dependency>
For Java:
<dependency>
<groupId>com.ufoscout.properlty</groupId>
<artifactId>properlty</artifactId>
<version>1.9.0</version>
</dependency>
WARN: use one OR the other. Do not import both the dependencies!
- Define some properties. You can use placeholders, for example, in
config.properties:
server.port=9090
server.host=127.0.0.1
server.url=http://${server.host}:${server.port}/
- Build a Properlty object that loads properties:
Kotlin:
val properlty = Properlty.builder()
.add("classpath:config.properties") // loads from the classpath
.build()
Java:
final Properlty properlty = Properlty.builder()
.add("classpath:config.properties") // loads from the classpath
.build();
- Look up properties by key:
Kotlin:
val port: Int = properlty.getInt("server.port", 8080); // returns 9090
val serverUrl = properlty["server.url"] // returns http://127.0.0.1:9090/
val defaultVal = properlty["unknownKey", "defaultValue"] // returns defaultValue
Java:
int port = properlty.getInt("server.port", 8080); // returns 9090
// the Java API uses Optional for methods that could not produce a valid result.
// In this case the Optional contains the Strind 'http://127.0.0.1:9090/'
Optional<String> serverUrl = properlty.get("server.url")
String defaultVal = properlty.get("unknownKey", "defaultValue") // returns defaultValue
(All examples are in Kotlin from now on; btw, Java code is exactly the same)
Readers
In Properlty a "reader" is whatever source of properties. By default, Properlty offers readers to load properties from:
- Java property files in the file system and in the classpath
- Java system properties
- Environment variables
- Programmatically typed properties
Custom properties readers can be created implementing the com.ufoscout.properlty.reader.Reader interface.
Placeholders resolution
Properlty is able to resolve placeholders recursively. For example:
fileOne.properties:
server.url=http://${${environment}.server.host}:${server.port}
server.port=8080
fileTwo.properties:
environment=PROD
PROD.server.host=10.10.10.10
DEV.server.host=127.0.0.1
val properlty = Properlty.builder()
.add("./fileOne.properties") // loads from the file system
.add("./fileTwo.properties") // loads from the file system
.build()
println(properlty["server.url"]) // this prints 'http://10.10.10.10:8080'
By default ${ and } delimiters are used. Custom delimiters can be easily defined:
val properlty = Properlty.builder()
.delimiters("%(", ")") // using %( and ) as delimiters
.add( bla bla bla)
Default Values
Placeholders can have default values which are used if the key is not otherwise provided. Example:
config.properties:
# the default value "8080" is used if 'PORT_NUMBER' is not provided
server.port=${PORT_NUMBER:8080}
# default is 127.0.0.1
server.ip=${IP:127.0.0.1}
server.url=${server.ip}/${server.port}
The default separator for the default value is ":". A custom value can be set through the 'defaultValueSeparator()' method of Properlty.builder().
Case Sensitive settings
By default keys and placeholders are case sensitive. The default behavior can be modified with the caseSensitive() builder method:
server.PORT=9090
server.host=127.0.0.1
server.url=http://${SerVeR.host}:${SERVER.port}/
Kotlin:
val properlty = Properlty.builder()
.caseSensitive(false)
.add("classpath:config.properties") // loads from the classpath
.build()
val serverUrl = properlty["server.url"] // returns http://127.0.0.1:9090/
Case insensitive can simplify key overriding through environment variables.
Readers priority -> Last one wins
Properties defined in later readers will override properties defined earlier readers, in case of overlapping keys. Hence, make sure that the most specific readers are the last ones in the given list of locations.
For example:
fileOne.properties:
server.url=urlFromOne
fileTwo.properties:
server.url=urlFromTwo
val properlty = Properlty.builder()
.add("classpath:fileOne.properties") // loads from the classpath
.add("file:./fileTwo.properties") // loads from the file system
.add(SystemPropertiesReader()) // loads the Java system properties
.build()
// this prints 'urlFromTwo'
println(properlty["server.url"])
BTW, due to the fact that we used SystemPropertiesReader() as last reader, if the "server.url" system property is specified at runtime, it will override the other values.
In addition, it is possible to specify a custom priority:
val properlty = Properlty.builder()
// load the properties from the file system and specify their priority
.add(resourcePath = "file:./fileTwo.properties", priority = Default.HIGHEST_PRIORITY)
.add("classpath:fileOne.properties") // loads from the classpath
.add(SystemPropertiesReader()) // loads the Java system properties
.build()
// this prints 'urlFromTwo'
println(properlty["server.url"])
The default priority is 100. The highest priority is 0. As usual, when more readers have the same priority, the last one wins in case of overlapping keys.
Real life example
A typical real life configuration would look like:
val properlty = Properlty.builder()
// case insensitive behavior simplifies matching of environment variables, especially in Linux systems
.caseSensitive(false)
// load a resource from the classpath
.add("classpath:default.properties")
// load a file from the file system
.add("file:./config/config.properties")
// Add a not mandatory reader, resource not found exceptions are ignored.
// Here I am adding properties present only during testing.
.add(resourcePath = "classpath:test.properties", ignoreNotFound = true)
// load the Environment variables and convert their keys
// from JAVA_HOME=XXX to JAVA.HOME=XXX
// This could be desired to override default properties
.add(EnvironmentVariablesReader().replace("_", "."))
// Load the Java system properties. They override the Environment variables.
.add(SystemPropertiesReader())
// build the properlty object
.build()
Properlty API
Properlty has a straightforward API that hopefully does not need detailed documentation.
Some examples:
val properlty = Properlty.builder()
.add("classpath:test.properties")
.build()
// get a String. "defaultValue" is returned if the key is not found
val aString = properlty["key", "defaultValue"]
// get an array from the comma separated tokens of the property value
val anArray = properlty.getArray("key", ",")
// get an Enum
val anEnum = properlty.getEnum<NeedSomebodyToLoveEnum>("key")
// get a Long
val aLong = properlty.getLong("key")
// get a Long or default value
val anotherLong = properlty.getLong("key", 10L)
// get a BigDecimal
val aBigDecimal = properlty.getBigDecimal("key")
// or get a BigDecimal by applying a transformation function to the returned String value
val anotherBigDecimal = properlty["key", { BigDecimal(it) }]
// get a list of BigDecimal. The property value is split in tokens using the default list
// separator (a comma) then the transformation function is applied to each token
val aListOfBigDecimals = properlty.getList("key") {BigDecimal(it)}