Статьи

Spring BeanDefinitionStoreException

Август 31, 2017

1. Обзор

В этой статье мы обсудим Spring org.springframework.beans.factory.BeanDefinitionStoreException — это обычно является обязанностью BeanFactory, когда определение бина недопустимо, загрузка этого бина является проблематичной. В статье будут обсуждаться наиболее распространенные причины этого исключения, а также решение для каждого из них.

2. Причина — исключение java.io.FileNotFoundException

2.1. IOException разбирает XML-документ из ресурса ServletContext

Обычно это происходит в веб-приложении Spring, когда в файле web.xml для Spring MVC установлен DispatcherServlet :

<servlet> 
   <servlet-name>mvc</servlet-name> 
   <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
</servlet>

По умолчанию Spring будет искать файл с именем именно springMvcServlet-servlet.xml в каталоге / WEB-INF веб-приложения.

Если этот файл не существует, то будет выдано следующее исключение:

org.springframework.beans.factory.BeanDefinitionStoreException:
IOException parsing XML document from ServletContext resource [/WEB-INF/mvc-servlet.xml];
nested exception is java.io.FileNotFoundException:
Could not open ServletContext resource [/WEB-INF/mvc-servlet.xml]

Решение , конечно , чтобы убедиться , что MVC-servlet.xml файл действительно существует в / WEB-INF ; если это не так, то можно создать образец:

<?xml version="1.0" encoding="UTF-8"?>
<beans
   xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="
      http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-3.2.xsd" >

</beans>

2.2. IOException разбирает XML-документ из ресурса пути к классу

Обычно это происходит, когда что-то в приложении указывает на ресурс XML, который не существует или не размещен там, где он должен быть.

Указание на такой ресурс может происходить разными способами.

Используя, например, Java Configuration, это может выглядеть так:

@Configuration
@ImportResource("beans.xml")
public class SpringConfig {...}

В XML это будет:

<import resource="beans.xml"/>

Или даже путем создания контекста Spring XML вручную:

ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");

Все это приведет к тому же исключению, если файл не существует:

org.springframework.beans.factory.BeanDefinitionStoreException:
IOException parsing XML document from ServletContext resource [/beans.xml];
nested exception is java.io.FileNotFoundException:
Could not open ServletContext resource [/beans.xml]

Решение , это создать файл и поместить его под основной / SRC / / ресурсы директории проекта — таким образом, файл будет существовать на пути к классам и он будет найден и использован весной.

3. Не удалось разрешить заполнитель…

Эта ошибка возникает, когда Spring пытается разрешить свойство, но не может — по одной из многих возможных причин.

Но сначала, использование свойства — это может быть использовано в XML:

... value="${some.property}" ...

Это свойство также может быть использовано в коде Java:

@Value("${some.property}")
private String someProperty

Первое, что нужно проверить, это то, что имя свойства действительно соответствует определению свойства; в этом примере нам нужно определить следующее свойство:

some.property=someValue

Then, we need to check where the properties file is defined in Spring – this is described in detail in my Properties with Spring article. A good best practice to follow is to have all properties files under the /src/main/resources directory of the application and to load them up via:

"classpath:app.properties"

Moving on from the obvious – another possible cause that Spring is not able to resolve the property is that there may be multiple PropertyPlaceholderConfigurer beans in the Spring context (or multiple property-placeholder elements)

If that is the case, then the solution is either collapsing these into a single one, or configuring the one in the parent context with ignoreUnresolvablePlaceholders.

4. java.lang.NoSuchMethodError

This error comes in a variety of forms – one of the more common ones is:

org.springframework.beans.factory.BeanDefinitionStoreException:
Unexpected exception parsing XML document from ServletContext resource [/WEB-INF/mvc-servlet.xml];
nested exception is java.lang.NoSuchMethodError:
org.springframework.beans.MutablePropertyValues.add (Ljava/lang/String;Ljava/lang/Object;)
Lorg/springframework/beans/MutablePropertyValues;

This usually happens when there are multiple versions of Spring on the classpath. Having an older version of Spring accidentally on the project classpath is more common than one would think – I described the problem and the solution for this in the Spring Security with Maven  article.

In short, the solution for this error is simple – check all the Spring jars on the classpath and make sure that they all have the same version – and that version is 3.0 or above.

Simillarly, the exception is not restricted to the MutablePropertyValues bean – there are several other incarnations of the same problem, caused by the same version inconsistency:

org.springframework.beans.factory.BeanDefinitionStoreException:
Unexpected exception parsing XML document from class path resource [/WEB-INF/mvc-servlet.xml];
- nested exception is java.lang.NoSuchMethodError:
org.springframework.util.ReflectionUtils.makeAccessible(Ljava/lang/reflect/Constructor;)V

5. java.lang.NoClassDefFoundError

A common problem, simillarly related to Maven and the existing Spring dependencies is:

org.springframework.beans.factory.BeanDefinitionStoreException:
Unexpected exception parsing XML document from ServletContext resource [/WEB-INF/mvc-servlet.xml];
nested exception is java.lang.NoClassDefFoundError:
org/springframework/transaction/interceptor/TransactionInterceptor

This occurs when transactional functionality is configured in the XML configuration:

<tx:annotation-driven/>

The NoClassDefFoundError means that the Spring Transactional support – namely spring-tx – does not exist on the classpath.

The solution is simple – spring-tx needs to be defined in the Maven pom:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-tx</artifactId>
    <version>3.2.2.RELEASE</version>
</dependency>

Of course this is not limited to the transaction functionality – a similar error is thrown if AOP is missing as well:

Exception in thread "main" org.springframework.beans.factory.BeanDefinitionStoreException:
Unexpected exception parsing XML document from class path resource [/WEB-INF/mvc-servlet.xml];
nested exception is java.lang.NoClassDefFoundError:
org/aopalliance/aop/Advice

The jars that are now required are: spring-aop (and implicitly aopalliance):

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>3.2.2.RELEASE</version>
</dependency>

6. Conclusion

At the end of this article, we should have a clear map to navigate the variety of causes and problems that may lead to a BeanDefinitionStoreException as well as a good grasp on how to fix all of these problems.

P.S. You might dig following me on Twitter.

53
Share: