Limit ref() and provider() visibility in Kotlin DSL [SPR-17648]

[spring-projects-issues]

Sébastien Deleuze opened SPR-17648 and commented

Current Kotlin bean DSL makes it possible to shoot yourself in the foot easily by allowing to write:

beans {
	val bar = ref<Bar>()
	bean<Foo> { Foo(bar)}
}

Which will trigger java.lang.IllegalStateException: org.springframework.context.support.GenericApplicationContext@2c532cd8 has not been refreshed yet.

We should only expose ref() and provider() in the supplier responsible for providing the bean, since it will be call at the right time of the lifecycle.

We could maybe introduce some kind of BeanDefinitionContext:

open class BeanDefinitionContext(@PublishedApi internal val context: GenericApplicationContext) {

    inline fun <reified T : Any> ref(name: String? = null): T = when (name) {
        null -> context.getBean(T::class.java)
        else -> context.getBean(name, T::class.java)
    }

    inline fun <reified T : Any> provider() : ObjectProvider<T> = context.getBeanProvider()
}

And change crossinline function: () -> T to crossinline function: BeanDefinitionContext.() -> T in the bean supplier variant.

Additional notes:

• We should maybe use this opportunity to provide direct access to ObjectProvider methods, expose Sequence instead of Stream, etc.
• We should maybe think about providing a router() variant that leverages this BeanDefinitionContext since this is a common use case.

---

No further details from SPR-17648