Skip to main content

Spring Custom Scope

Spring framework is one of the DI frameworks which is largely used to develop web applications(enterprise). It provides almost every feature which is required to develop a enterprise web application. Also it is extendable, so you can customize it the way it suits for your application.


Custom bean scope

Although bean scopes provided by Spring fulfills requirements of the application, some times you may need something different which is not available by default. In our application we faced the same situation.

Requirement

We had a requirement of the scope which uses an application value to decide which bean to use(return). The default scopes provided by Spring were not useful and was not providing the required functionality.

Implementation

As I said earlier, Spring is extendable. It provides an interface Scope, which you can implement to introduce custom scope in your application.

To create custom scope, Scope interface needs to be implemented. Scope interface has following methods -


  1. get - This is where bean is created if already not present in the scope. Depending upon your requirement you can change this behavior.
  2. remove - This method should remove the object from the scope with specified identifier.
  3. getConversationId - This method should return the conversation id or key which maps to the store where the beans in the current scope are maintained.
  4. registerDestructionCallback - This method should register/store the callbacks which should be executed when the bean in this scope is destroyed or when the scope is destroyed.
  5. resolveContextualReference - This method should return the contextual reference to the object.

Example

Following code snippet shows Spring custom scope example


public class SpringCustomScope implements Scope, BeanFactoryAware {
private ConcurrentHashMap springCustomScopeBeanMap = new ConcurrentHashMap<>();
private Object initLockObject = new Object();
private BeanFactory beanFactory;
@Override
public Object get(String name, ObjectFactory objectFactory) {
Object beanObject = springCustomScopeBeanMap.get(name);
if(beanObject == null){
synchronized (initLockObject) {
                              // you may use double null check
                              // initialize your bean here
                              beanObject = objectFactory.getObject();
                              springCustomScopeBeanMap.put(name, beanObject);
}
}
return beanObject;
}

@Override
public Object remove(String name) {
// Not supported in this scope
}

@Override
public void registerDestructionCallback(String name, Runnable callback) {
}

@Override
public Object resolveContextualObject(String key) {
return null;
}

@Override
public String getConversationId() {
return "customScope";
}

@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException         {
this.beanFactory = beanFactory;
}

}

In above example, SpringCustomScope implements BeanFactoryAware interface which is not required at all. In our case we needed some other beans as well to decide the bean for the current scope.

There are two ways to register your custom scope.

1. Using xml declaration -

  <bean class="org.springframework.beans.factory.config.CustomScopeConfigurer">
        <property name="scopes">
            <map>
                <entry key="customscope">
                    <bean class="com.yourcompany.package.SpringCustomScope">
                </entry>
            </map>
        </property>
    </bean>

2. Programmatically - 

 Scope threadScope= new CustomThreadScope();
 beanFactory.registerScope("customThread", threadScope);

That's all. Your custom scope is ready and can be used by writing -

<bean name="myBeanName" class="com.yourcompany.package.SomeImportantBean" scope="customscope" >

Comments

Popular posts from this blog

Spring AOP : JDK Proxy vs CGLib Proxy

Spring framework is one of the most widely used framework in Enterprise application development. It has so many features such as Dependency injection, Data access integration, MVC, AOP which takes care of most of the boilerplate part of project, and developers can then focus on business logic only.

One of the important feature in Spring is AOP. It is used by almost every enterprise application which is being developed using Spring.

AOP So what is AOP? Definition of AOP -
Aspect oriented programming is a programming paradigm which aims to increase modularity by allowing the separation of cross cutting concerns. Well, my understanding of AOP is - AOP allows us to introduce/join new modules in your project at pre-specified dynamic locations without having to code for it. Traditional examples of AOP is Transaction management, logging etc. You can read more about AOP at here.

This article is for those who know AOP, have used AOP in their projects but do not know how Spring or other DI fra…

Java Tools Plugin for Notepad++

This post and the plugin is outdated. Please use plugin from this link which is updated and allows customization of shortcut key mappings and much more.
Notepad++ is a great free editor. I like notepad++ because its a light weight editor and loads instantly. I use notepad++ for editing many files everyday. One plugin I always wanted was a plugin which lets me compile my java files and execute them from editor itself, but I couldn't find it so I wrote a myself. This plugin can be downloaded from this link.
I am working on this plugin to make it more effective, so that if user have more than one installations of JDK or JRE then user should be able to choose which one to use etc.
This is a simple plugin which has two commands-
Compile - compiles a java file.
Run - executes a java file.
For using this plugin Java must be installed on the system.

Notepad++ Compile and Run Java Programs

Notepad++ is a great file editor. It has many features. The most important feature which I like about Notepad++ is its light weight. It loads up so quickly, that's great. It also provides syntax highlighting for many languages. I use notepad++ to edit general files as well as my simple Java programs.
Although notepad++ provides functionality to run external programs, I prefer NppJavaTools plugin to compile and run Java programs using notepad++.
You can download NppJavaTools plugin from this page - NppJavaTools.

Installation
Installation of plugins in notepad++ is very simple process. All you have to do is copy plugin dll into plugins folder of notepad++ installation directory and restart the notepad++.

Features
This plugin provides following features,


Compile and run your Java files within Notepad++Set custom hotkeys for compiling and running Java CodeLibrary support Compile and RunThis function allows you to run your Java programs to compile and run from Notepad++. Set Custom hotkeysThi…