JAVA EE: ListFactoryBean

Showing posts with label ListFactoryBean. Show all posts

Wednesday, 8 August 2018

How to create a concrete List collection (ArrayList and LinkedList) using ListFactoryBean in Spring

Enjoying This Tutorial?

Subscribe to Ram N Java for high-quality, practical Java and Spring tutorials!

Introduction

In Spring Framework, when you inject collections using standard <list> tags, Spring creates an internal default List implementation. However, if your application explicitly requires a specific concrete implementation such as java.util.ArrayList or java.util.LinkedList, Spring provides the ListFactoryBean helper class.

Why Use ListFactoryBean?

Explicit Implementation: Set whether the resulting List bean is backed by ArrayList or LinkedList using the targetListClass property.
Standalone Reusable Bean: Define the list as its own first-class Spring bean and inject it into multiple collaborator beans across your context.
Fine-Grained Control: Easily swap implementations for performance optimization (e.g., fast random access vs. frequent additions/removals) directly in XML.

Step-by-Step Configuration

1. Configuring an ArrayList with ListFactoryBean

To configure a concrete ArrayList, set targetListClass to java.util.ArrayList:

<bean id="cityArrayList" class="org.springframework.beans.factory.config.ListFactoryBean">
    <property name="targetListClass" value="java.util.ArrayList" />
    <property name="sourceList">
        <list>
            <value>New York</value>
            <value>London</value>
            <value>Tokyo</value>
        </list>
    </property>
</bean>

2. Configuring a LinkedList with ListFactoryBean

To switch to a LinkedList, simply change the targetListClass value:

<bean id="cityLinkedList" class="org.springframework.beans.factory.config.ListFactoryBean">
    <property name="targetListClass" value="java.util.LinkedList" />
    <property name="sourceList">
        <list>
            <value>New York</value>
            <value>London</value>
            <value>Tokyo</value>
        </list>
    </property>
</bean>

Key Takeaway

ListFactoryBean provides an explicit, clean way in Spring XML to control concrete List collection types without changing your Java bean source code. Use ArrayList when fast index-based retrieval is needed and LinkedList when elements are frequently added or removed.

Recommended Related Tutorials from Ram N Java

Click here to watch on Youtube:
https://www.youtube.com/watch?v=0qcalr8iIpk&list=UUhwKlOVR041tngjerWxVccw

Click the below Image to Enlarge:

How to create a concrete List collection (ArrayList and LinkedList) using ListFactoryBean in Spring

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ram.core</groupId>

    <artifactId>SpringDemo</artifactId>

    <packaging>jar</packaging>

    <version>1.0-SNAPSHOT</version>

    <name>SpringDemo</name>

    <url>http://maven.apache.org</url>

    <properties>

        <spring.version>5.0.2.RELEASE</spring.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>3.8.1</version>

            <scope>test</scope>

        </dependency>

        <!-- Spring 5 dependencies -->

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-core</artifactId>

            <version>${spring.version}</version>

        </dependency>

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-context</artifactId>

            <version>${spring.version}</version>

        </dependency>

    </dependencies>

</project>

FruitShop.java

package com.ram.core;

import java.util.List;

public class FruitShop

{

    private String shopName;

    private List<String> listOfAvailableFruits;

    public String getShopName()

    {

        return shopName;

    }

    public void setShopName(String shopName)

    {

        System.out.println("setShopName(String shopName) is "

                + "called by the Spring Container");

        this.shopName = shopName;

    }

    public List<String> getListOfAvailableFruits()

    {

        return listOfAvailableFruits;

    }

    public void setListOfAvailableFruits(List<String> listOfAvailableFruits)

    {

        System.out.println(

                "setListOfAvailableFruits(List<String> listOfAvailableFruits) is "

                        + "called by the Spring Container");

        this.listOfAvailableFruits = listOfAvailableFruits;

    }

    public void displayFruitShopInfo()

    {

        System.out.println("FruitShop [shopName=" + shopName

                + ", listOfAvailableFruits=" + listOfAvailableFruits + "]");

    }

}

applicationContext.xml

<beans xmlns="http://www.springframework.org/schema/beans"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

    xmlns:util="http://www.springframework.org/schema/util"

    xsi:schemaLocation="http://www.springframework.org/schema/beans

    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd

    http://www.springframework.org/schema/util

    http://www.springframework.org/schema/util/spring-util-4.3.xsd">

    <bean id="fruitShop" class="com.ram.core.FruitShop">

        <property name="shopName" value="Fruit Mart"></property>

        <property name="listOfAvailableFruits">

            <bean class="org.springframework.beans.factory.config.ListFactoryBean">

                <property name="targetListClass">

                    <value>java.util.ArrayList</value>

                </property>

                <property name="sourceList">

                    <list>

                        <value>apple</value>

                        <value>pineapple</value>

                        <value>orange</value>

                    </list>

                </property>

            </bean>

        </property>

    </bean>

</beans>

App.java

package com.ram.core;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class App

{

    public static void main(String[] args)

    {

        ApplicationContext context = new ClassPathXmlApplicationContext(

                "applicationContext.xml");

        System.out.println("---------------------------------------");

        FruitShop fruitShop = (FruitShop) context.getBean("fruitShop");

        System.out.println(

                "Got fruitShop object from the ApplicationContext(Spring Container)");

        fruitShop.displayFruitShopInfo();

    }

}

Output

Jul 28, 2018 12:08:50 PM org.springframework.context.support.AbstractApplicationContext prepareRefresh

INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Sat Jul 28 12:08:50 IST 2018]; root of context hierarchy

Jul 28, 2018 12:08:50 PM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions

INFO: Loading XML bean definitions from class path resource [applicationContext.xml]

setShopName(String shopName) is called by the Spring Container

setListOfAvailableFruits(List<String> listOfAvailableFruits) is called by the Spring Container

---------------------------------------

Got fruitShop object from the ApplicationContext(Spring Container)

FruitShop [shopName=Fruit Mart, listOfAvailableFruits=[apple, pineapple, orange]]