|
| 1 | +package io.toolisticon.spring.condition |
| 2 | + |
| 3 | +import org.slf4j.LoggerFactory |
| 4 | +import org.springframework.beans.factory.NoSuchBeanDefinitionException |
| 5 | +import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition |
| 6 | +import org.springframework.beans.factory.annotation.Qualifier |
| 7 | +import org.springframework.beans.factory.config.ConfigurableListableBeanFactory |
| 8 | +import org.springframework.beans.factory.support.AbstractBeanDefinition |
| 9 | +import org.springframework.beans.factory.support.RootBeanDefinition |
| 10 | +import org.springframework.boot.autoconfigure.condition.ConditionOutcome |
| 11 | +import org.springframework.boot.autoconfigure.condition.SpringBootCondition |
| 12 | +import org.springframework.context.annotation.ConditionContext |
| 13 | +import org.springframework.context.annotation.ConfigurationCondition |
| 14 | +import org.springframework.context.annotation.ConfigurationCondition.ConfigurationPhase |
| 15 | +import org.springframework.core.annotation.AnnotationUtils |
| 16 | +import org.springframework.core.type.AnnotatedTypeMetadata |
| 17 | +import org.springframework.util.ObjectUtils |
| 18 | +import java.lang.invoke.MethodHandles |
| 19 | +import java.util.stream.Stream |
| 20 | + |
| 21 | +/** |
| 22 | + * Inspired by [org.axonframework.springboot.util.AbstractQualifiedBeanCondition] |
| 23 | + * Abstract implementations for conditions that match against the availability of beans of a specific type with a |
| 24 | + * given qualifier. |
| 25 | +
|
| 26 | + * Initialize the condition, looking for properties on a given annotation |
| 27 | + * |
| 28 | + * @param annotationName The fully qualified class name of the annotation to find attributes on. |
| 29 | + * @param beanClassAttribute The attribute containing the bean class. |
| 30 | + * @param qualifierAttribute The attribute containing the qualifier. |
| 31 | + */ |
| 32 | +abstract class AbstractQualifiedBeanCondition( |
| 33 | + private val annotationName: String, |
| 34 | + private val beanClassAttribute: String, |
| 35 | + private val qualifierAttribute: String |
| 36 | +) : SpringBootCondition(), ConfigurationCondition { |
| 37 | + |
| 38 | + companion object { |
| 39 | + private val logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()) |
| 40 | + } |
| 41 | + |
| 42 | + override fun getConfigurationPhase(): ConfigurationPhase { |
| 43 | + return ConfigurationPhase.REGISTER_BEAN |
| 44 | + } |
| 45 | + |
| 46 | + override fun getMatchOutcome(context: ConditionContext, metadata: AnnotatedTypeMetadata): ConditionOutcome { |
| 47 | + |
| 48 | + val annotationAttributes = metadata.getAllAnnotationAttributes(annotationName, true)!! |
| 49 | + val beanType = annotationAttributes.getFirst(beanClassAttribute) as String |
| 50 | + val qualifierAttr = annotationAttributes.getFirst(qualifierAttribute) as String |
| 51 | + |
| 52 | + val qualifier: String? |
| 53 | + val qualifierMatch: Boolean |
| 54 | + |
| 55 | + if (qualifierAttr.startsWith("!")) { |
| 56 | + qualifier = qualifierAttr.substring(1) |
| 57 | + qualifierMatch = false |
| 58 | + } else { |
| 59 | + qualifier = qualifierAttr |
| 60 | + qualifierMatch = true |
| 61 | + } |
| 62 | + |
| 63 | + val qualifiers = qualifier.split(",".toRegex()).toTypedArray() |
| 64 | + val conditionalClass: Class<*> = try { |
| 65 | + Class.forName(beanType) |
| 66 | + } catch (e: ClassNotFoundException) { |
| 67 | + val failureMessage = String.format( |
| 68 | + "Failed to extract a class instance for fully qualified class name [%s]", |
| 69 | + beanType |
| 70 | + ) |
| 71 | + logger.warn(failureMessage, e) |
| 72 | + return ConditionOutcome(false, failureMessage) |
| 73 | + } |
| 74 | + val bf = context.beanFactory!! |
| 75 | + val anyMatch = Stream.of(*bf.getBeanNamesForType(conditionalClass)) |
| 76 | + .anyMatch { beanName: String -> qualifierMatch == isOneMatching(beanName, bf, qualifiers) } |
| 77 | + val message = if (anyMatch) String.format( |
| 78 | + "Match found for class [%s] and qualifier [%s]", |
| 79 | + conditionalClass, |
| 80 | + qualifier |
| 81 | + ) else String.format("No match found for class [%s] and qualifier [%s]", conditionalClass, qualifier) |
| 82 | + return buildOutcome(anyMatch, message) |
| 83 | + } |
| 84 | + |
| 85 | + private fun isOneMatching(beanName: String, bf: ConfigurableListableBeanFactory, qualifiers: Array<String>): Boolean { |
| 86 | + for (qualifier in qualifiers) { |
| 87 | + if (isQualifierMatch(beanName, bf, qualifier)) { |
| 88 | + return true |
| 89 | + } |
| 90 | + } |
| 91 | + return false |
| 92 | + } |
| 93 | + |
| 94 | + protected abstract fun buildOutcome(anyMatch: Boolean, message: String): ConditionOutcome |
| 95 | + |
| 96 | +} |
| 97 | + |
| 98 | +/** |
| 99 | + * Inspired by org.axonframework.spring.SpringUtils.isQualifierMatch |
| 100 | + */ |
| 101 | +fun isQualifierMatch(beanName: String, beanFactory: ConfigurableListableBeanFactory, qualifier: String): Boolean { |
| 102 | + return if (!beanFactory.containsBean(beanName)) { |
| 103 | + false |
| 104 | + } else { |
| 105 | + try { |
| 106 | + val bd = beanFactory.getMergedBeanDefinition(beanName) |
| 107 | + if (bd is AnnotatedBeanDefinition) { |
| 108 | + val factoryMethodMetadata = bd.factoryMethodMetadata |
| 109 | + val qualifierAttributes = factoryMethodMetadata!!.getAnnotationAttributes(Qualifier::class.java.name) |
| 110 | + if (qualifierAttributes != null && qualifier == qualifierAttributes["value"]) { |
| 111 | + return true |
| 112 | + } |
| 113 | + } |
| 114 | + if (bd is AbstractBeanDefinition) { |
| 115 | + val candidate = bd.getQualifier(Qualifier::class.java.name) |
| 116 | + if (candidate != null && qualifier == candidate.getAttribute("value") || qualifier == beanName || ObjectUtils.containsElement( |
| 117 | + beanFactory.getAliases( |
| 118 | + beanName |
| 119 | + ), qualifier |
| 120 | + ) |
| 121 | + ) { |
| 122 | + return true |
| 123 | + } |
| 124 | + } |
| 125 | + var targetAnnotation: Qualifier? |
| 126 | + if (bd is RootBeanDefinition) { |
| 127 | + val factoryMethod = bd.resolvedFactoryMethod |
| 128 | + if (factoryMethod != null) { |
| 129 | + targetAnnotation = AnnotationUtils.getAnnotation(factoryMethod, Qualifier::class.java) |
| 130 | + if (targetAnnotation != null) { |
| 131 | + return qualifier == targetAnnotation.value |
| 132 | + } |
| 133 | + } |
| 134 | + } |
| 135 | + val beanType = beanFactory.getType(beanName) |
| 136 | + if (beanType != null) { |
| 137 | + targetAnnotation = AnnotationUtils.getAnnotation(beanType, Qualifier::class.java) |
| 138 | + if (targetAnnotation != null) { |
| 139 | + return qualifier == targetAnnotation.value |
| 140 | + } |
| 141 | + } |
| 142 | + } catch (_: NoSuchBeanDefinitionException) { |
| 143 | + } |
| 144 | + false |
| 145 | + } |
| 146 | +} |
0 commit comments