Skip to content

io microsphere spring beans factory annotation ConfigurationBeanBindingRegistrar

github-actions[bot] edited this page Jul 11, 2026 · 26 revisions

ConfigurationBeanBindingRegistrar

Type: Class | Module: microsphere-spring-context | Package: io.microsphere.spring.beans.factory.annotation | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/beans/factory/annotation/ConfigurationBeanBindingRegistrar.java

Overview

A registrar for registering EnableConfigurationBeanBinding @EnableConfigurationBeanBinding-annotated bean definitions.

This class processes the EnableConfigurationBeanBinding annotation, binding its attributes to corresponding Spring beans. It supports configuration options such as prefix resolution, bean naming strategies, and handling of unknown or invalid fields.

Example Usage

Basic Configuration

{@code

### Declaration

```java
class ConfigurationBeanBindingRegistrar extends AnnotatedBeanCapableImportBeanDefinitionRegistrar
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.36-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
@Configuration
@EnableConfigurationBeanBinding(prefix = "my.config", type = MyConfig.class)
public class MyConfig {}
```

### Example 2

```java
@Configuration
@EnableConfigurationBeanBinding(prefix = "multi.config", type = MultiConfig.class, multiple = true)
public class MultiConfig {}
```

### Example 3

```java
@Configuration
@EnableConfigurationBeanBinding(
    prefix = "strict.config",
    type = StrictConfig.class,
    ignoreUnknownFields = false,
    ignoreInvalidFields = false
)
public class StrictConfig {}
```

## 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.beans.factory.annotation.ConfigurationBeanBindingRegistrar;
```

## API Reference

### Public Methods

| Method | Description |
|--------|-------------|
| `registerConfigurationBeanDefinitions` |  |

## See Also

- `EnableConfigurationBeanBinding`
- `ConfigurationBeanBindingPostProcessor`

---

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

Home

spring-context

spring-guice

spring-jdbc

spring-test

spring-web

spring-webflux

spring-webmvc

Clone this wiki locally