spring-beans/org.springframework.beans.factory/BeanRegistrarDsl

BeanRegistrarDsl

open class BeanRegistrarDsl(init: BeanRegistrarDsl.() -> Unit) : BeanRegistrar

Contract for registering programmatically beans.

Typically imported with an @Import annotation on @Configuration classes.

@Configuration
@Import(MyBeanRegistrar::class)
class MyConfiguration {
}

In Kotlin, a bean registrar is typically created with a BeanRegistrarDsl to register beans programmatically in a concise and flexible way.

class MyBeanRegistrar : BeanRegistrarDsl({
	   registerBean<Foo>()
	   registerBean(
        name = "bar",
        prototype = true,
        lazyInit = true,
        description = "Custom description") {
            Bar(bean<Foo>())
    }
    profile("baz") {
        registerBean { Baz("Hello World!") }
    }
})

Author

Sebastien Deleuze

Since

7.0

Constructors

BeanRegistrarDsl

constructor(init: BeanRegistrarDsl.() -> Unit)

Types

SupplierContextDsl

open class SupplierContextDsl<T>(context: BeanRegistry.SupplierContext)

Context available from the bean instance supplier designed to give access to bean dependencies.

Properties

env

lateinit var env: Environment

The environment that can be used to get the active profile or some properties.

Functions

profile

fun profile(expression: String, init: BeanRegistrarDsl.() -> Unit)

Apply the nested block if the given profile expression matches the active profiles.

fun register(registrar: BeanRegistrar)

open override fun register(registry: BeanRegistry, env: Environment)

registerBean

inline fun <T : Any> registerBean(autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String

inline fun <T : Any> registerBean(name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)