https://github.com/yingzhuo/spring-boot-stater-env

spring boot starter for yaml/toml/hocon property-source
https://github.com/yingzhuo/spring-boot-stater-env

hocon properties property-source spring-boot spring-boot-starter toml yaml

Last synced: 25 days ago
JSON representation

spring boot starter for yaml/toml/hocon property-source

• Host: GitHub
• URL: https://github.com/yingzhuo/spring-boot-stater-env
• Owner: yingzhuo
• License: apache-2.0
• Created: 2020-01-05T05:04:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-26T22:14:20.000Z (over 1 year ago)
• Last Synced: 2024-04-16T07:57:58.178Z (7 months ago)
• Topics: hocon, properties, property-source, spring-boot, spring-boot-starter, toml, yaml
• Language: Makefile
• Homepage:
• Size: 57.6 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![JDK](http://img.shields.io/badge/JDK-v8.0-yellow.svg)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)

[![Build](http://img.shields.io/badge/Build-Maven_2-green.svg)](https://maven.apache.org/)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.yingzhuo/spring-boot-stater-env.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.yingzhuo%22%20AND%20a:%22spring-boot-stater-env%22)

# spring-boot-starter-env

### Requires

* Java 8+

* SpringBoot 2.2.0+

### Download

* maven / gradle is highly recommended.

```xml

    com.github.yingzhuo

    spring-boot-stater-env

    2.0.3

```

### Usage

#### (1) use `toml` file as property source

```java

@Configuration

@PropertySource(value = "classpath:/config.toml", factory = TomlPropertySourceFactory.class)

public class ApplicationConfig {

    // ...

}

```

#### (2) use `yaml` file as property source

```java

@Configuration

@PropertySource(value = "classpath:/config.yaml", factory = YamlPropertySourceFactory.class)

public class ApplicationConfig {

    // ...

}

```

#### (3) use `hocon` file as property source **(highly recommended)**

```java

@Configuration

@PropertySource(value = "classpath:/config.conf", factory = HoconPropertySourceFactory.class)

public class ApplicationConfig {

    // ...

}

```

#### (4) use `AbstractConventionEnvironmentPostProcessor` load property-source file(s) implicitly

```java

package my.project;

public class MyEnvironmentPostProcessor extends AbstractConventionEnvironmentPostProcessor {

    @Override

    protected String getName(ConfigurableEnvironment environment, SpringApplication application) {

        return "property-source";

    }

    @Override

    protected String[] getLocationsPrefix(ConfigurableEnvironment environment, SpringApplication application) {

        return new String[]{

                "classpath:my-project"

        };

    }

}

```

**DO NOT** forget to register it. In your `classpath:/META-INF/spring.factories`:

```txt

org.springframework.boot.env.EnvironmentPostProcessor=my.project.MyEnvironmentPostProcessor

```

Now, file(s) will be loaded if exists.

- `classpath:my-project.conf`

- `classpath:my-project.toml`

- `classpath:my-project.yml`

- `classpath:my-project.yaml`

- `classpath:my-project.properties`

- `classpath:my-project.xml` (also properties)

Also, file(s) will be loaded if exists and `myprofile` profile is active.

- `classpath:my-project-myprofile.conf`

- `classpath:my-project-myprofile.toml`

- `classpath:my-project-myprofile.yml`

- `classpath:my-project-myprofile.yaml`

- `classpath:my-project-myprofile.properties`

- `classpath:my-project-myprofile.xml` (also properties)

### Contributing

* Fork it

* Create your feature branch (git checkout -b my-new-feature)

* Commit your changes (git commit -am 'add some feature')

* Push to the branch (git push origin my-new-feature)

* Create new Pull Request

### Authors

* 应卓 - [github](https://github.com/yingzhuo)

### License

Apache 2.0 license. See [LICENSE](./LICENSE)