Skip to content

Commit eb604b6

Browse files
committed
Allow chained BeanRegistry registration
Add a `register(BeanRegistry registry)` method to `BeanRegistry` to allow registration chaining.
1 parent 86d8163 commit eb604b6

File tree

4 files changed

+53
-24
lines changed

4 files changed

+53
-24
lines changed

spring-beans/src/main/java/org/springframework/beans/factory/BeanRegistry.java

+7
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ public interface BeanRegistry {
7777
*/
7878
<T> void registerBean(String name, Class<T> beanClass, Consumer<Spec<T>> customizer);
7979

80+
/**
81+
* Register beans using given {@link BeanRegistrar}.
82+
* @param registrar the bean registrar that will be called to register
83+
* additional beans
84+
*/
85+
void register(BeanRegistrar registrar);
86+
8087
/**
8188
* Specification for customizing a bean.
8289
* @param <T> the bean type

spring-beans/src/main/java/org/springframework/beans/factory/support/BeanRegistryAdapter.java

+16-3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
import org.springframework.beans.factory.config.BeanDefinition;
3232
import org.springframework.beans.factory.config.BeanDefinitionCustomizer;
3333
import org.springframework.core.ResolvableType;
34+
import org.springframework.core.env.Environment;
35+
import org.springframework.util.Assert;
3436
import org.springframework.util.MultiValueMap;
3537

3638
/**
@@ -46,21 +48,26 @@ public class BeanRegistryAdapter implements BeanRegistry {
4648

4749
private final ListableBeanFactory beanFactory;
4850

51+
private final Environment environment;
52+
4953
private final Class<? extends BeanRegistrar> beanRegistrarClass;
5054

5155
private final @Nullable MultiValueMap<String, BeanDefinitionCustomizer> customizers;
5256

5357

5458
public BeanRegistryAdapter(BeanDefinitionRegistry beanRegistry, ListableBeanFactory beanFactory,
55-
Class<? extends BeanRegistrar> beanRegistrarClass) {
56-
this(beanRegistry, beanFactory, beanRegistrarClass, null);
59+
Environment environment, Class<? extends BeanRegistrar> beanRegistrarClass) {
60+
61+
this(beanRegistry, beanFactory, environment, beanRegistrarClass, null);
5762
}
5863

5964
public BeanRegistryAdapter(BeanDefinitionRegistry beanRegistry, ListableBeanFactory beanFactory,
60-
Class<? extends BeanRegistrar> beanRegistrarClass, @Nullable MultiValueMap<String, BeanDefinitionCustomizer> customizers) {
65+
Environment environment, Class<? extends BeanRegistrar> beanRegistrarClass,
66+
@Nullable MultiValueMap<String, BeanDefinitionCustomizer> customizers) {
6167

6268
this.beanRegistry = beanRegistry;
6369
this.beanFactory = beanFactory;
70+
this.environment = environment;
6471
this.beanRegistrarClass = beanRegistrarClass;
6572
this.customizers = customizers;
6673
}
@@ -102,6 +109,12 @@ public <T> void registerBean(String name, Class<T> beanClass, Consumer<Spec<T>>
102109
this.beanRegistry.registerBeanDefinition(name, beanDefinition);
103110
}
104111

112+
@Override
113+
public void register(BeanRegistrar registrar) {
114+
Assert.notNull(registrar, "'registrar' must not be null");
115+
registrar.register(this, this.environment);
116+
}
117+
105118

106119
/**
107120
* {@link RootBeanDefinition} subclass for {@code #registerBean} based

spring-beans/src/test/java/org/springframework/beans/factory/support/BeanRegistryAdapterTests.java

+29-20
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import org.springframework.core.env.StandardEnvironment;
2828

2929
import static org.assertj.core.api.Assertions.assertThat;
30+
import static org.junit.jupiter.api.Assertions.*;
3031

3132
/**
3233
* Tests for {@link BeanRegistryAdapter}.
@@ -41,103 +42,103 @@ public class BeanRegistryAdapterTests {
4142

4243
@Test
4344
void defaultBackgroundInit() {
44-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
45+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
4546
new DefaultBeanRegistrar().register(adapter, env);
4647
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
4748
assertThat(beanDefinition.isBackgroundInit()).isFalse();
4849
}
4950

5051
@Test
5152
void enableBackgroundInit() {
52-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, BackgroundInitBeanRegistrar.class);
53+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, BackgroundInitBeanRegistrar.class);
5354
new BackgroundInitBeanRegistrar().register(adapter, env);
5455
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
5556
assertThat(beanDefinition.isBackgroundInit()).isTrue();
5657
}
5758

5859
@Test
5960
void defaultDescription() {
60-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
61+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
6162
new DefaultBeanRegistrar().register(adapter, env);
6263
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
6364
assertThat(beanDefinition.getDescription()).isNull();
6465
}
6566

6667
@Test
6768
void customDescription() {
68-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, CustomDescriptionBeanRegistrar.class);
69+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, CustomDescriptionBeanRegistrar.class);
6970
new CustomDescriptionBeanRegistrar().register(adapter, env);
7071
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
7172
assertThat(beanDefinition.getDescription()).isEqualTo("custom");
7273
}
7374

7475
@Test
7576
void defaultFallback() {
76-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
77+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
7778
new DefaultBeanRegistrar().register(adapter, env);
7879
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
7980
assertThat(beanDefinition.isFallback()).isFalse();
8081
}
8182

8283
@Test
8384
void enableFallback() {
84-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, FallbackBeanRegistrar.class);
85+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, FallbackBeanRegistrar.class);
8586
new FallbackBeanRegistrar().register(adapter, env);
8687
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
8788
assertThat(beanDefinition.isFallback()).isTrue();
8889
}
8990

9091
@Test
9192
void defaultRole() {
92-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
93+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
9394
new DefaultBeanRegistrar().register(adapter, env);
9495
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
9596
assertThat(beanDefinition.getRole()).isEqualTo(AbstractBeanDefinition.ROLE_APPLICATION);
9697
}
9798

9899
@Test
99100
void infrastructureRole() {
100-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, InfrastructureBeanRegistrar.class);
101+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, InfrastructureBeanRegistrar.class);
101102
new InfrastructureBeanRegistrar().register(adapter, env);
102103
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
103104
assertThat(beanDefinition.getRole()).isEqualTo(AbstractBeanDefinition.ROLE_INFRASTRUCTURE);
104105
}
105106

106107
@Test
107108
void defaultLazyInit() {
108-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
109+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
109110
new DefaultBeanRegistrar().register(adapter, env);
110111
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
111112
assertThat(beanDefinition.isLazyInit()).isFalse();
112113
}
113114

114115
@Test
115116
void enableLazyInit() {
116-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, LazyInitBeanRegistrar.class);
117+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, LazyInitBeanRegistrar.class);
117118
new LazyInitBeanRegistrar().register(adapter, env);
118119
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
119120
assertThat(beanDefinition.isLazyInit()).isTrue();
120121
}
121122

122123
@Test
123124
void defaultAutowirable() {
124-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
125+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
125126
new DefaultBeanRegistrar().register(adapter, env);
126127
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
127128
assertThat(beanDefinition.isAutowireCandidate()).isTrue();
128129
}
129130

130131
@Test
131132
void notAutowirable() {
132-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, NotAutowirableBeanRegistrar.class);
133+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, NotAutowirableBeanRegistrar.class);
133134
new NotAutowirableBeanRegistrar().register(adapter, env);
134135
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
135136
assertThat(beanDefinition.isAutowireCandidate()).isFalse();
136137
}
137138

138139
@Test
139140
void defaultOrder() {
140-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
141+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
141142
new DefaultBeanRegistrar().register(adapter, env);
142143
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
143144
Integer order = (Integer)beanDefinition.getAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE);
@@ -146,7 +147,7 @@ void defaultOrder() {
146147

147148
@Test
148149
void customOrder() {
149-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, CustomOrderBeanRegistrar.class);
150+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, CustomOrderBeanRegistrar.class);
150151
new CustomOrderBeanRegistrar().register(adapter, env);
151152
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition) this.beanFactory.getBeanDefinition("foo");
152153
Integer order = (Integer)beanDefinition.getAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE);
@@ -155,54 +156,62 @@ void customOrder() {
155156

156157
@Test
157158
void defaultPrimary() {
158-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
159+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
159160
new DefaultBeanRegistrar().register(adapter, env);
160161
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
161162
assertThat(beanDefinition.isPrimary()).isFalse();
162163
}
163164

164165
@Test
165166
void enablePrimary() {
166-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, PrimaryBeanRegistrar.class);
167+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, PrimaryBeanRegistrar.class);
167168
new PrimaryBeanRegistrar().register(adapter, env);
168169
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
169170
assertThat(beanDefinition.isPrimary()).isTrue();
170171
}
171172

172173
@Test
173174
void defaultScope() {
174-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
175+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
175176
new DefaultBeanRegistrar().register(adapter, env);
176177
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
177178
assertThat(beanDefinition.getScope()).isEqualTo(AbstractBeanDefinition.SCOPE_DEFAULT);
178179
}
179180

180181
@Test
181182
void prototypeScope() {
182-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, PrototypeBeanRegistrar.class);
183+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, PrototypeBeanRegistrar.class);
183184
new PrototypeBeanRegistrar().register(adapter, env);
184185
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("foo");
185186
assertThat(beanDefinition.getScope()).isEqualTo(AbstractBeanDefinition.SCOPE_PROTOTYPE);
186187
}
187188

188189
@Test
189190
void defaultSupplier() {
190-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, DefaultBeanRegistrar.class);
191+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
191192
new DefaultBeanRegistrar().register(adapter, env);
192193
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition)this.beanFactory.getBeanDefinition("foo");
193194
assertThat(beanDefinition.getInstanceSupplier()).isNull();
194195
}
195196

196197
@Test
197198
void customSupplier() {
198-
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, SupplierBeanRegistrar.class);
199+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, SupplierBeanRegistrar.class);
199200
new SupplierBeanRegistrar().register(adapter, env);
200201
AbstractBeanDefinition beanDefinition = (AbstractBeanDefinition)this.beanFactory.getBeanDefinition("foo");
201202
Supplier<?> supplier = beanDefinition.getInstanceSupplier();
202203
assertThat(supplier).isNotNull();
203204
assertThat(supplier.get()).isNotNull().isInstanceOf(Foo.class);
204205
}
205206

207+
@Test
208+
void registerViaAnotherRegistrar() {
209+
BeanRegistryAdapter adapter = new BeanRegistryAdapter(this.beanFactory, this.beanFactory, this.env, DefaultBeanRegistrar.class);
210+
BeanRegistrar registrar = (registry, env) -> registry.register(new DefaultBeanRegistrar());
211+
registrar.register(adapter, env);
212+
assertThat(this.beanFactory.getBeanDefinition("foo")).isNotNull();
213+
}
214+
206215

207216
private static class DefaultBeanRegistrar implements BeanRegistrar {
208217

spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ private void loadBeanDefinitionsFromBeanRegistrars(Set<BeanRegistrar> registrars
409409
"Cannot support bean registrars since " + this.registry.getClass().getName() +
410410
" does not implement BeanDefinitionRegistry");
411411
registrars.forEach(registrar -> registrar.register(new BeanRegistryAdapter(this.registry,
412-
(ListableBeanFactory) this.registry, registrar.getClass()), this.environment));
412+
(ListableBeanFactory) this.registry, this.environment, registrar.getClass()), this.environment));
413413
}
414414

415415

0 commit comments

Comments
 (0)