Initializing the Environment

    Initializing the Environment

    1. ApplicationContext applicationContext = ApplicationContext.run(
    2. PropertySource.of(
    3. "test",
    4. [
    5. "micronaut.server.host": "foo",
    6. "micronaut.server.port": 8080
    7. ]
    8. ),
    9. "test", "android")
    10. Environment environment = applicationContext.getEnvironment()
    11. then:
    12. "foo" == environment.getProperty("micronaut.server.host", String.class).orElse("localhost")

    Initializing the Environment

    1. val applicationContext = ApplicationContext.run(
    2. PropertySource.of(
    3. "test",
    4. mapOf(
    5. "micronaut.server.host" to "foo",
    6. "micronaut.server.port" to 8080
    7. ),
    8. "test", "android")
    9. val environment = applicationContext.getEnvironment()
    10. assertEquals(
    11. "foo",
    12. environment.getProperty("micronaut.server.host", String::class.java).orElse("localhost")
    13. )

    The method can be used to create a ProperySource from a map of values.

    Alternatively one can register a PropertySourceLoader by creating a META-INF/services/io.micronaut.context.env.PropertySourceLoader containing a reference to the class name of the PropertySourceLoader.

    Micronaut by default contains PropertySourceLoader implementations that load properties from the given locations and priority:

    1. Command line arguments

    2. Properties from SPRING_APPLICATION_JSON (for Spring compatibility)

    3. Properties from MICRONAUT_APPLICATION_JSON

    4. Java System Properties

    5. OS environment variables

    6. Configuration files loaded in order from the system property ‘micronaut.config.files’ or the environment variable MICRONAUT_CONFIG_FILES. The value can be a comma separated list of paths with the last file having precedence. The files can be referenced from the file system as a path or the classpath with a classpath: prefix.

    7. Enviroment-specific properties from application-{environment}.{extension}

    8. Application-specific properties from application.{extension}

    Property Value Placeholders

    Micronaut includes a property placeholder syntax which can be used to reference configuration properties both within configuration values and with any Micronaut annotation (see @Value and the section on ).

    Programmatic usage is also possible via the PropertyPlaceholderResolver interface.

    The basic syntax is to wrap a reference to a property in ${…​}. For example in application.yml:

    Defining Property Placeholders

    The above example embeds references to the micronaut.server.host and micronaut.server.port properties.

    You can specify default values by defining a value after the : character. For example:

    Using Default Values

    1. myapp:
    2. endpoint: http://${micronaut.server.host:localhost}:${micronaut.server.port:8080}/foo

    The above example will default to localhost and port 8080 if no value is found (rather than throwing an exception). Note that if default value itself contains a : character, you should escape it using back ticks:

    1. myapp:
    2. endpoint: ${server.address:`http://localhost:8080`}/foo

    The above example tries to read a server.address property otherwise fallbacks back to [http://localhost:8080](http://localhost:8080), since the address has a : character we have to escape it with back ticks.

    Note that these property references should always be in kebab case (lowercase and hyphen-separated) when placing references in code or in placeholder values. For example, you should use micronaut.server.default-charset and not micronaut.server.defaultCharset.

    Micronaut still allows specifying the latter in configuration, but normalizes the properties into kebab case form to optimize memory consumption and reduce complexity when resolving properties. The following table summarizes how properties are normalized from different sources:

    Environment variables are given special treatment to allow the definition of environment variables to be more flexible.

    Because the number of properties generated is exponential based on the number of characters in the environment variable, it is recommended to refine which, if any, environment variables are included in configuration if the number of environment variables with a large number of underscores is high.

    To control how environment properties participate in configuration, call the respective methods on the Micronaut builder.

    Application class

    1. import io.micronaut.runtime.Micronaut
    2. class Application {
    3. static void main(String[] args) {
    4. Micronaut.build()
    5. .environmentPropertySource(false)
    6. //or
    7. .environmentVariableIncludes("THIS_ENV_ONLY")
    8. //or
    9. .environmentVariableExcludes("EXCLUDED_ENV")
    10. .start()
    11. }
    12. }

    Application class

    1. import io.micronaut.runtime.Micronaut
    2. object Application {
    3. @JvmStatic
    4. fun main(args: Array<String>) {
    5. Micronaut.build(null)
    6. .mainClass(Application::class.java)
    7. .environmentPropertySource(false)
    8. //or
    9. .environmentVariableIncludes("THIS_ENV_ONLY")
    10. //or
    11. .environmentVariableExcludes("EXCLUDED_ENV")
    12. .start()
    13. }
    14. }

    Using Random Properties

    You can use random values by using the following properties. These can be used in configuration files as variables like the following.

    Table 2. Random Values
    PropertyValue

    random.port

    An available random port number

    random.int

    Random int

    random.integer

    Random int

    random.long

    Random long

    random.float

    Random float

    random.shortuuid

    Random UUID of only 10 chars in length (Note: As this isn’t full UUID, collision COULD occur)

    random.uuid

    Random UUID with dashes

    random.uuid2

    Random UUID without dashes

    For beans that inject required properties, the injection and potential failure will not occur until the bean is requested. To verify at startup that the properties exist and can be injected, the bean can be annotated with @Context. Context scoped beans will be injected at startup time and thus will fail at startup time if any required properties are missing or could not be converted to the required type.

    Controlling Log Levels with Properties

    Log levels can be configured via properties defined in application.yml (and environment variables) with the log.level prefix:

    1. logger:
    2. levels:

    Note that the ability to control log levels via config is controlled via the LoggingSystem interface. Currently Micronaut ships with a single implementation that allows setting log levels for the Logback library. If another library is chosen you should provide a bean that implements this interface.