Skip to main content

classpath*: making your Modular Spring Resources

Spring gives multiple options to load XML resources for building contexts. the reference documentation does explain this feature quite well. However, I am taking my shot at explaining the different practical scenarios ( by order of growing modularisation)

For Example, A simplest Spring based web Context Loader can be configured with resources like this
<context-param> 
  <param-name>contextConfigLocation</param-name>
  <param-value>applicationContext.xml</param-value>
</context-param>

<listener>
   <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

You just need to put applicationContext.xml in WEB-INF/ folder of your webapp.

However, Typically an application is n-tiered. You can also have multiple files setup and in relative paths.
like
<param-value>
  context-files/applicationContext.xml
  context-files/dao.xml
  context-files/service.xml 
</param-value>

put them in WEB-INF/context-files folder.

But as Spring Conventions suggest, generally, applicationContext is generally the file that is defined in context loading, and the others are "imported" into the context
<param-value>
  context-files/applicationContext.xml
</param-value>
and in applicationContext.xml
<import  resource="dao.xml"/>
note that the resource is relative (no context-files/dao.xml)

Again, as projects grow, each tier (service, dao .. ) are modularised into separate jars, so the respective config file(s) also move to those jars. so, referencing those xml files relatively will not work, because they are may be loaded by a different class loader. So to reference across class loaders
<!-- applicationContext.xml is same, dao.xml is jar-ed in dao-module.jar under context-file/ --> <import  resource="classpath:context-files/dao.xml"/>

Further down, daos, themselves might be separated by components in applications
 <import  resource="classpath:com/company/common/dao.xml"/>
 <import  resource="classpath:com/company/order/dao.xml"/>
 <import  resource="classpath:com/company/account/dao.xml"/>
 <import  resource="classpath:com/company/account/legacy/dao.xml"/>
 <import  resource="classpath:com/company/cs/dao.xml"/>

The above can be achieved using ant wild card like in
<!-- notice, the all directories and sub directories (account/legacy/ too) --> 
<import  resource="classpath:com/company/**/dao.xml"/> 

Getting the drift? Best is yet to come. You know you could actually have these context files loaded by different class loaders but in same application. Ex: EAR loading contexts in war and META-INF jars in separate class loaders. As Long as these are in the same VM, You can do a multi classloader resource look up like this:
<!-- notice, the asterisk --> 
<import  resource="classpath*:com/company/**/dao.xml"/> 

There are other less used schemes like file: and http:. There are to be avoided in JEE for apparent reasons. Albeit, they are extremely useful in some scenarios, like, TestCases and WebServices.

Popular posts from this blog

Powered By

As it goes, We ought to give thanks to people who power us. This page will be updated, like the version page , to show all the tools, and people this site is Powered By! Ubuntu GIMP Firebug Blogger Google [AppEngine, Ajax and other Apis] AddtoAny Project Fondue jQuery

Decorator for Memcache Get/Set in python

I have suggested some time back that you could modularize and stitch together fragments of js and css to spit out in one HTTP connection. That makes the page load faster. I also indicated that there ways to tune them by adding cache-control headers. On the server-side however, you could have a memcache layer on the stitching operation. This saves a lot of Resources (CPU) on your server. I will demonstrate this using a python script I use currently on my site to generate the combined js and css fragments. So My stitching method is like this @memize(region="jscss") def joinAndPut(files, ext): res = files.split("/") o = StringIO.StringIO() for f in res: writeFileTo(o, ext + "/" + f + "." + ext) #writes file out ret = o.getvalue() o.close() return ret; The method joinAndPut is * decorated * by memize. What this means is, all calls to joinAndPut are now wrapped (at runtime) with the logic in memize. All you wa...

Faster webpages with fewer CSS and JS

Its easy, have lesser images, css and js files. I will cover reducing number of images in another post. But If you are like me, You always write js and css in a modular fashion. Grouping functions and classes into smaller files (and Following the DRY rule, Strictly!). But what happens is, when you start writing a page to have these css and js files, you are putting them in muliple link rel=style-sheet or script tags. Your server is being hit by (same) number of HTTP Requests for each page call. At this point, its not the size of files but the number server roundtrips on a page that slows your page down. Yslow shows how many server roundtrips happen for css and js. If you have more than one css call and one js call, You are not using your server well. How do you achieve this? By concatinating them and spitting out the content as one stream. So Lets say I have util.js, blog.js and so.js. If I have a blog template that depends on these three, I would call them in three script tags. Wh...