Splitting applicationContext to multiple files

Question

What is the correct way to split Spring s configuration to multiple xml files   At the moment I have    WEB-INF foo-servlet xml  WEB-INF foo-service xml  WEB-INF foo-persistence xml   My web xml has the following    lt servlet gt       lt description gt Spring MVC Dispatcher Servlet lt  description gt       lt servlet-name gt intrafest lt  servlet-name gt       lt servlet-class gt          org springframework web servlet DispatcherServlet      lt  servlet-class gt       lt init-param gt           lt param-name gt contextConfigLocation lt  param-name gt           lt param-value gt               WEB-INF foo-  xml          lt  param-value gt       lt  init-param gt       lt load-on-startup gt 2 lt  load-on-startup gt   lt  servlet gt    lt context-param gt       lt param-name gt contextConfigLocation lt  param-name gt       lt param-value gt               WEB-INF foo-  xml      lt  param-value gt   lt  context-param gt     lt listener gt       lt listener-class gt          org springframework web context ContextLoaderListener      lt  listener-class gt   lt  listener gt    The actual questions    Is this approach correct best  Do I really need to specify the config locations both in the DispatcherServlet AND the context-param sections    What do I need to keep in mind to be able to reference beans defined in foo-servlet xml from foo-service xml  Does this have something to do with specifying contextConfigLocation in web xml   Update 1   I m using Spring framework 3 0  It s my understanding that I don t need to do resource importing like this     lt import resource  foo-services xml   gt     Is this a correct assumption

User · Answer

Mike Nereson has this to say on his blog at:

http://blog.codehangover.com/load-multiple-contexts-into-spring/

There are a couple of ways to do this.

1. web.xml contextConfigLocation

Your first option is to load them all into your Web application context via the ContextConfigLocation element. You’re already going to have your primary applicationContext here, assuming you’re writing a web application. All you need to do is put some white space between the declaration of the next context.
  <context-param>
      <param-name> contextConfigLocation </param-name>
      <param-value>
          applicationContext1.xml
          applicationContext2.xml
      </param-value>
  </context-param>

  <listener>
      <listener-class>
          org.springframework.web.context.ContextLoaderListener
      </listener-class>
  </listener>
The above uses carriage returns. Alternatively, yo could just put in a space.
  <context-param>
      <param-name> contextConfigLocation </param-name>
      <param-value> applicationContext1.xml applicationContext2.xml </param-value>
  </context-param>

  <listener>
      <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class>
  </listener>
2. applicationContext.xml import resource

Your other option is to just add your primary applicationContext.xml to the web.xml and then use import statements in that primary context.

In applicationContext.xml you might have…
  
  <import resource="applicationContext-hibernate.xml"/>

  
  <import resource="applicationContext-ldap.xml"/>

  
  <import resource="applicationContext-aspects.xml"/>
Which strategy should you use?

1. I always prefer to load up via web.xml.

Because , this allows me to keep all contexts isolated from each other. With tests, we can load just the contexts that we need to run those tests. This makes development more modular too as components stay loosely coupled, so that in the future I can extract a package or vertical layer and move it to its own module.

2. If you are loading contexts into a non-web application, I would use the import resource.

User · Answer

I find the following setup the easiest   Use the default config file loading mechanism of DispatcherServlet      The framework will  on initialization   of a DispatcherServlet  look for a   file named  servlet-name -servlet xml   in the WEB-INF directory of your web   application and create the beans   defined there  overriding the   definitions of any beans defined with   the same name in the global scope     In your case  simply create a file intrafest-servlet xml in the WEB-INF dir and don t need to specify anything specific information in web xml   In intrafest-servlet xml file you can use import to compose your XML configuration    lt beans gt     lt bean id  bean1  class        gt     lt bean id  bean2  class        gt      lt import resource  foo-services xml   gt     lt import resource  foo-persistence xml   gt   lt  beans gt    Note that the Spring team actually prefers to load multiple config files when creating the  Web ApplicationContext  If you still want to do it this way  I think you don t need to specify both context parameters  context-param  and servlet initialization parameters  init-param   One of the two will do  You can also use commas to specify multiple config locations

User · Answer

eljenso   intrafest-servlet xml webapplication context xml will be used if the application uses SPRING WEB MVC   Otherwise the  kosoant configuration is fine   Simple example if you dont use SPRING WEB MVC  but want to utitlize SPRING IOC    In web xml    lt context-param gt           lt param-name gt contextConfigLocation lt  param-name gt           lt param-value gt classpath application-context xml lt  param-value gt   lt  context-param gt    Then  your application-context xml will contain   lt import resource  foo-services xml   gt  these import statements to load various application context files and put into main application-context xml   Thanks and hope this helps

User · Answer

I m the author of modular-spring-contexts    This is a small utility library to allow a more modular organization of spring contexts than is achieved by using Composing XML-based configuration metadata  modular-spring-contexts works by defining modules  which are basically stand alone application contexts and allowing modules to import beans from other modules  which are exported   n their originating module   The key points then are   control over dependencies between modules control over which beans are exported and where they are used reduced possibility of naming collisions of beans   A simple example would look like this   File moduleDefinitions xml    lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xmlns module  http   www gitlab com SpaceTrucker modular-spring-contexts      xmlns context  http   www springframework org schema context      xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans xsd                         http   www gitlab com SpaceTrucker modular-spring-contexts xsd modular-spring-contexts xsd                         http   www springframework org schema context http   www springframework org schema context spring-context xsd  gt        lt context annotation-config   gt        lt module module id  serverModule  gt           lt module config location   serverModule xml    gt       lt  module module gt        lt module module id  clientModule  gt           lt module config location   clientModule xml    gt           lt module requires module  serverModule    gt       lt  module module gt    lt  beans gt    File serverModule xml     lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xmlns module  http   www gitlab com SpaceTrucker modular-spring-contexts      xmlns context  http   www springframework org schema context      xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans xsd                         http   www gitlab com SpaceTrucker modular-spring-contexts xsd modular-spring-contexts xsd                         http   www springframework org schema context http   www springframework org schema context spring-context xsd  gt        lt context annotation-config   gt        lt bean id  serverSingleton  class  java math BigDecimal  scope  singleton  gt           lt constructor-arg index  0  value  123 45    gt           lt meta key  exported  value  true   gt       lt  bean gt    lt  beans gt    File clientModule xml   lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xmlns module  http   www gitlab com SpaceTrucker modular-spring-contexts      xmlns context  http   www springframework org schema context      xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans xsd                         http   www gitlab com SpaceTrucker modular-spring-contexts xsd modular-spring-contexts xsd                         http   www springframework org schema context http   www springframework org schema context spring-context xsd  gt        lt context annotation-config   gt        lt module import id  importedSingleton  sourceModule  serverModule  sourceBean  serverSingleton    gt    lt  beans gt

User · Answer

There are two types of contexts we are dealing with   1  root context  parent context  Typically include all jdbc ORM  Hibernate  initialisation and other spring security related configuration   2  individual servlet context  child context Typically Dispatcher Servlet Context and initialise all beans related to spring-mvc  controllers   URL Mapping etc     Here is an example of web xml which includes multiple application context file   x000D   x000D   lt  xml version  1 0  encoding  UTF-8   gt  x000D   lt web-app xmlns  http   java sun com xml ns javaee  x000D          xmlns xsi  http   www w3 org 2001 XMLSchema-instance  x000D          xsi schemaLocation  http   java sun com xml ns javaee x000D                              http   java sun com xml ns javaee web-app 3 0 xsd  gt  x000D   x000D       lt display-name gt Spring Web Application example lt  display-name gt  x000D   x000D       lt  -- Configurations for the root application context  parent context  -- gt  x000D       lt listener gt  x000D           lt listener-class gt org springframework web context ContextLoaderListener lt  listener-class gt  x000D       lt  listener gt  x000D       lt context-param gt  x000D           lt param-name gt contextConfigLocation lt  param-name gt  x000D           lt param-value gt  x000D               WEB-INF spring jdbc spring-jdbc xml  lt  -- JDBC related context -- gt  x000D               WEB-INF spring security spring-security-context xml  lt  -- Spring Security related context -- gt  x000D           lt  param-value gt  x000D       lt  context-param gt  x000D   x000D       lt  -- Configurations for the DispatcherServlet application context  child context  -- gt  x000D       lt servlet gt  x000D           lt servlet-name gt spring-mvc lt  servlet-name gt  x000D           lt servlet-class gt org springframework web servlet DispatcherServlet lt  servlet-class gt  x000D           lt init-param gt  x000D               lt param-name gt contextConfigLocation lt  param-name gt  x000D               lt param-value gt  x000D                   WEB-INF spring mvc spring-mvc-servlet xml x000D               lt  param-value gt  x000D           lt  init-param gt  x000D       lt  servlet gt  x000D       lt servlet-mapping gt  x000D           lt servlet-name gt spring-mvc lt  servlet-name gt  x000D           lt url-pattern gt  admin   lt  url-pattern gt  x000D       lt  servlet-mapping gt  x000D   x000D   lt  web-app gt  x000D   x000D   x000D

[spring] Splitting applicationContext to multiple files

Examples related to spring

Examples related to configuration