spring中 allowBeanDefinitionOverriding(spring.main.allow-bean-definition-overriding) 分析
文章目錄
問題描述
問題分析
到底allowBeanDefinitionOverriding應該設置true還是false？
問題描述
最近在學習spring cloud sleuth過程中，遇到了一個問題：
The bean 'characterEncodingFilter', defined in class path resource [zipkin/autoconfigure/ui/ZipkinUiAutoConfiguration.class], could not be registered. A bean with that name has already been defined in class path resource [org/springframework/boot/autoconfigure/web/servlet/HttpEncodingAutoConfiguration.class] and overriding is disabled.
Action:
Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true
1
2
3
4
從錯誤信息中可以看到，characterEncodingFilter這個bean被定義了兩次，ZipkinUiAutoConfiguration和HttpEncodingAutoConfiguration都有定義。在大型項目開發過程中，這種情況并不少見。畢竟各個不同的組件都是獨立開發的，集成到一起后總會遇到各種驚喜。spring.main.allow-bean-definition-overriding=true就是解決bean重復定義的。設置為true時，后定義的bean會覆蓋之前定義的相同名稱的bean。
具體參見我的另一篇文章 spring cloud Greenwich 學習筆記（十）spring cloud sleuth 服務鏈路追蹤。
問題分析
上面已經看到，spring.main.allow-bean-definition-overriding設置為true，表示后發現的bean會覆蓋之前相同名稱的bean。
問題就出在spring初始化時bean工廠加載bean的時候。我們來看一下DefaultListableBeanFactory代碼：
/** 是否允許使用相同名稱重新注冊不同的bean實現. 默認是允許*/
private boolean allowBeanDefinitionOverriding = true;
/**
?* Set whether it should be allowed to override bean definitions by registering
?* a different definition with the same name, automatically replacing the former.
?* If not, an exception will be thrown. This also applies to overriding aliases.
?* <p>Default is "true".【這里明確說明了默認是true】
?* @see #registerBeanDefinition
?*/
public boolean isAllowBeanDefinitionOverriding() {
?? ?return this.allowBeanDefinitionOverriding;
}
@Override
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
?? ??? ?throws BeanDefinitionStoreException {
?? ?Assert.hasText(beanName, "Bean name must not be empty");
?? ?Assert.notNull(beanDefinition, "BeanDefinition must not be null");
?? ?if (beanDefinition instanceof AbstractBeanDefinition) {
?? ??? ?try {
?? ??? ??? ?((AbstractBeanDefinition) beanDefinition).validate();
?? ??? ?}
?? ??? ?catch (BeanDefinitionValidationException ex) {
?? ??? ??? ?throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
?? ??? ??? ??? ??? ?"Validation of bean definition failed", ex);
?? ??? ?}
?? ?}
?? ?//bean加載到spring的工程中后，會存儲在beanDefinitionMap中，key是bean的名稱。
?? ?BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
?? ?if (existingDefinition != null) {//不為空，說明相同名稱的bean已經存在了
?? ??? ?if (!isAllowBeanDefinitionOverriding()) {//如果不允許相同名稱的bean存在，則直接拋出異常
?? ??? ??? ?throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
?? ??? ?}
?? ??? ?else if (existingDefinition.getRole() < beanDefinition.getRole()) {
?? ??? ??? ?// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
?? ??? ??? ?if (logger.isInfoEnabled()) {
?? ??? ??? ??? ?logger.info("Overriding user-defined bean definition for bean '" + beanName +
?? ??? ??? ??? ??? ??? ?"' with a framework-generated bean definition: replacing [" +
?? ??? ??? ??? ??? ??? ?existingDefinition + "] with [" + beanDefinition + "]");
?? ??? ??? ?}
?? ??? ?}
?? ??? ?else if (!beanDefinition.equals(existingDefinition)) {
?? ??? ??? ?if (logger.isDebugEnabled()) {
?? ??? ??? ??? ?logger.debug("Overriding bean definition for bean '" + beanName +
?? ??? ??? ??? ??? ??? ?"' with a different definition: replacing [" + existingDefinition +
?? ??? ??? ??? ??? ??? ?"] with [" + beanDefinition + "]");
?? ??? ??? ?}
?? ??? ?}
?? ??? ?else {
?? ??? ??? ?if (logger.isTraceEnabled()) {
?? ??? ??? ??? ?logger.trace("Overriding bean definition for bean '" + beanName +
?? ??? ??? ??? ??? ??? ?"' with an equivalent definition: replacing [" + existingDefinition +
?? ??? ??? ??? ??? ??? ?"] with [" + beanDefinition + "]");
?? ??? ??? ?}
?? ??? ?}
?? ??? ?//可見，上面allowBeanDefinitionOverriding =true時，只是記錄了一些日志，然后后來發現的這個bean，會覆蓋之前老的bean。
?? ??? ?this.beanDefinitionMap.put(beanName, beanDefinition);
?? ?}
?? ?else {
?? ??? ?if (hasBeanCreationStarted()) {
?? ??? ??? ?// Cannot modify startup-time collection elements anymore (for stable iteration)
?? ??? ??? ?synchronized (this.beanDefinitionMap) {
?? ??? ??? ??? ?this.beanDefinitionMap.put(beanName, beanDefinition);
?? ??? ??? ??? ?List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
?? ??? ??? ??? ?updatedDefinitions.addAll(this.beanDefinitionNames);
?? ??? ??? ??? ?updatedDefinitions.add(beanName);
?? ??? ??? ??? ?this.beanDefinitionNames = updatedDefinitions;
?? ??? ??? ??? ?if (this.manualSingletonNames.contains(beanName)) {
?? ??? ??? ??? ??? ?Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);
?? ??? ??? ??? ??? ?updatedSingletons.remove(beanName);
?? ??? ??? ??? ??? ?this.manualSingletonNames = updatedSingletons;
?? ??? ??? ??? ?}
?? ??? ??? ?}
?? ??? ?}
?? ??? ?else {
?? ??? ??? ?// Still in startup registration phase
?? ??? ??? ?this.beanDefinitionMap.put(beanName, beanDefinition);
?? ??? ??? ?this.beanDefinitionNames.add(beanName);
?? ??? ??? ?this.manualSingletonNames.remove(beanName);
?? ??? ?}
?? ??? ?this.frozenBeanDefinitionNames = null;
?? ?}
?? ?if (existingDefinition != null || containsSingleton(beanName)) {
?? ??? ?resetBeanDefinition(beanName);
?? ?}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
具體可以看上面代碼中添加的注釋。
可以看一下BeanDefinitionOverrideException的定義，我們上面拋出的異常，就是這里拋出的。
public BeanDefinitionOverrideException(
?? ??? ?String beanName, BeanDefinition beanDefinition, BeanDefinition existingDefinition) {
?? ?super(beanDefinition.getResourceDescription(), beanName,
?? ??? ??? ?"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +
?? ??? ??? ?"': There is already [" + existingDefinition + "] bound.");
?? ?this.beanDefinition = beanDefinition;
?? ?this.existingDefinition = existingDefinition;
}
1
2
3
4
5
6
7
8
9
實際錯誤時提示bean重復，不過這里spring又對其進行了封裝，最終打印出來的結果就是本文開頭的錯誤輸出，并且提示了我們要配置spring.main.allow-bean-definition-overriding=true。
可能有的人會問了，上面代碼中默認就是true啊，為什么還要我手動配置？
原因就是上面貼出來的是spring的代碼，而springboot對這個參數又進行了二次封裝，springboot中的allowBeanDefinitionOverriding是沒有初始化默認值的，我們知道，java中的boolean類型不初始化時是false。
springboot中源代碼：
//沒有默認初始化就是false
private boolean allowBeanDefinitionOverriding;
/**
?* Sets if bean definition overriding, by registering a definition with the same name
?* as an existing definition, should be allowed. Defaults to {@code false}.【這里寫的很明白了，默認是false】
?* @param allowBeanDefinitionOverriding if overriding is allowed
?* @since 2.1
?* @see DefaultListableBeanFactory#setAllowBeanDefinitionOverriding(boolean)
?*/
public void setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding) {
?? ?this.allowBeanDefinitionOverriding = allowBeanDefinitionOverriding;
}
private void prepareContext(ConfigurableApplicationContext context,
?? ??? ?ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
?? ??? ?ApplicationArguments applicationArguments, Banner printedBanner) {
?? ?context.setEnvironment(environment);
?? ?postProcessApplicationContext(context);
?? ?applyInitializers(context);
?? ?listeners.contextPrepared(context);
?? ?if (this.logStartupInfo) {
?? ??? ?logStartupInfo(context.getParent() == null);
?? ??? ?logStartupProfileInfo(context);
?? ?}
?? ?// Add boot specific singleton beans
?? ?ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
?? ?beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
?? ?if (printedBanner != null) {
?? ??? ?beanFactory.registerSingleton("springBootBanner", printedBanner);
?? ?}
?? ?if (beanFactory instanceof DefaultListableBeanFactory) {
?? ??? ?//**在此處給bean工程設置屬性**
?? ??? ?((DefaultListableBeanFactory) beanFactory)
?? ??? ??? ??? ?.setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
?? ?}
?? ?// Load the sources
?? ?Set<Object> sources = getAllSources();
?? ?Assert.notEmpty(sources, "Sources must not be empty");
?? ?load(context, sources.toArray(new Object[0]));
?? ?listeners.contextLoaded(context);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
到底allowBeanDefinitionOverriding應該設置true還是false？
上面代碼中可以看到，spring中默認是true，也就是默認支持名稱相同的bean的覆蓋。而springboot中的默認值是false，也就是不支持名稱相同的bean被覆蓋。
那么我們自己應該如何選擇呢？
這里筆者認為默認不覆蓋比較好。
因為還是推薦一個系統中不要存在名稱相同的bean，否則后者覆蓋前者，多人分工合作的時候，難以避免某些bean被覆蓋，會出現很多詭異的問題 ，甚至會帶來線上真實的業務損失。
bean的名稱不相同，依據具體的業務給bean起名字。這樣不但可以解決bean名稱重復的問題，還可以大大提高程序的可讀性與可維護性。
只有當集成了第三方的庫，不同庫直接由于是多個團隊開發的，甚至這些團隊屬于不同的國家，有可能會出現bean名稱相同的情況。這種情況就需要根據實際需求來設置allowBeanDefinitionOverriding的值了。
?
總結
以上是生活随笔為你收集整理的spring中 allowBeanDefinitionOverriding(spring.main.allow-bean-definition-overriding) 分析的全部內容，希望文章能夠幫你解決所遇到的問題。
