io microsphere spring config env annotation YamlPropertySource

YamlPropertySource

Type: Annotation | Module: microsphere-spring-context | Package: io.microsphere.spring.config.env.annotation | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/config/env/annotation/YamlPropertySource.java

Overview

The extension annotation of ResourcePropertySource @ResourcePropertySource providing a convenient and declarative mechanism for adding a YAML ImmutableMapPropertySource to Spring's Environment. To be used in conjunction with Configuration @Configuration classes.

Example Usage

Example 1: Basic usage

{@code

### Declaration

```java
public @interface YamlPropertySource
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.32-SNAPSHOT`

## Version Compatibility

This component is tested and compatible with the following Java versions:

| Java Version | Status |
|:---:|:---:|
| Java 17 | ✅ Compatible |
| Java 21 | ✅ Compatible |
| Java 25 | ✅ Compatible |

## Examples

### Example 1

```java
@YamlPropertySource(value = "classpath:/app.yaml", first = true)
@Configuration
public class AppConfig {
    // configuration beans
}
```

### Example 2

```java
@YamlPropertySource(value = "classpath:/app.yaml", encoding = "ISO-8859-1")
@Configuration
public class AppConfig {
    // configuration beans
}
```

## Usage

### Maven Dependency

Add the following dependency to your `pom.xml`:

```xml

    io.github.microsphere-projects
    microsphere-spring-context
    ${microsphere-spring.version}

```

> **Tip:** Use the BOM (`microsphere-spring-dependencies`) for consistent version management. See the [Getting Started](https://github.com/microsphere-projects/microsphere-spring#getting-started) guide.

### Import

```java
import io.microsphere.spring.config.env.annotation.YamlPropertySource;
```

## See Also

- `ResourcePropertySource`
- `ImmutableMapPropertySource`
- `YamlPropertySourceFactory`

---

*This documentation was auto-generated from the source code of [microsphere-spring](https://github.com/microsphere-projects/microsphere-spring).*