Friday, 1 June 2018

How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

Enjoying this Java & Spring tutorial?

Subscribe to Ram N Java on YouTube

Introduction

In Spring Framework applications, configuring collections via constructor injection allows beans to remain immutable and completely initialized upon creation. A frequent use case involves mapping a basic identifier (like a String or Integer key) to a custom dependent object as the map value.

In this guide, you will learn step-by-step how to inject a Map having a simple key and a dependent object as its value using constructor dependency injection in Spring XML configuration.

1. Create the Dependent Class (Fruit)

First, define the dependent object class (for example, Fruit) that will serve as the value inside our map:

public class Fruit {
    private String name;
    private int price;

    public Fruit(String name, int price) {
        this.name = name;
        this.price = price;
    }

    @Override
    public String toString() {
        return "Fruit [name=" + name + ", price=" + price + "]";
    }
}
  

2. Create the Target Class (FruitShop)

Create the target class FruitShop that receives a Map<String, Fruit> through its constructor:

import java.util.Map;

public class FruitShop {
    private String shopName;
    private Map<String, Fruit> fruitMap;

    public FruitShop(String shopName, Map<String, Fruit> fruitMap) {
        this.shopName = shopName;
        this.fruitMap = fruitMap;
    }

    public void displayFruitShopInfo() {
        System.out.println("Shop Name: " + shopName);
        for (Map.Entry<String, Fruit> entry : fruitMap.entrySet()) {
            System.out.println("Key: " + entry.getKey() + " -> Value: " + entry.getValue());
        }
    }
}
  

3. Configure Spring XML with <entry key="..." value-ref="...">

In your applicationContext.xml, declare the dependent Fruit beans and inject them into the target bean's map using the value-ref attribute:

<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.xsd">

    <!-- Dependent Beans -->
    <bean id="appleBean" class="Fruit">
        <constructor-arg value="Kashmiri Apple" />
        <constructor-arg value="120" />
    </bean>

    <bean id="mangoBean" class="Fruit">
        <constructor-arg value="Alphonso Mango" />
        <constructor-arg value="250" />
    </bean>

    <!-- Target Bean -->
    <bean id="fruitShop" class="FruitShop">
        <constructor-arg value="Green Valley Mart" />
        <constructor-arg>
            <map>
                <entry key="fruit_1" value-ref="appleBean" />
                <entry key="fruit_2" value-ref="mangoBean" />
            </map>
        </constructor-arg>
    </bean>

</beans>
  

4. Test the Application

Load the application context and execute your application:

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        FruitShop shop = (FruitShop) context.getBean("fruitShop");
        shop.displayFruitShopInfo();
    }
}
  

Watch More Spring Tutorials


Click here to watch on Youtube:
https://www.youtube.com/watch?v=WPk0U8vG-JA&list=UUhwKlOVR041tngjerWxVccw

Click the below Image to Enlarge:
How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

How to Inject Map having dependent Object in value using Spring dependency injection by constructor?

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>

Fruit.java

package com.ram.model;

public class Fruit
{
    private String name;
    private String color;

    public Fruit(String name, String color)
    {
        System.out.println("Fruit(String name, String color) "
                + "constructor is called by the Spring container");
        this.name = name;
        this.color = color;
    }

    @Override
    public String toString()
    {
        return "Fruit [name=" + name + ", color=" + color + "]";
    }

}

FruitShop.java

package com.ram.core;

import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import com.ram.model.Fruit;

public class FruitShop
{
    private String shopName;
    private Map<Integer, Fruit> mapOfAvailableFruits;

    public FruitShop(String shopName, Map<Integer, Fruit> mapOfAvailableFruits)
    {
        System.out.println(
                "FruitShop(String shopName, Map<Integer, Fruit> mapOfAvailableFruits) "
                        + "constructor is called by the Spring container");
        this.shopName = shopName;
        this.mapOfAvailableFruits = mapOfAvailableFruits;
    }

    public void displayFruitShopInfo()
    {
        System.out.println("Fruit ShopName = " + shopName);

        Set<Entry<Integer, Fruit>> set = mapOfAvailableFruits.entrySet();
        Iterator<Entry<Integer, Fruit>> itr = set.iterator();
        while (itr.hasNext())
        {
            Entry<Integer, Fruit> entry = itr.next();
            System.out.println("Fruit Id = " + entry.getKey()
                    + ", Fruit Info = " + entry.getValue());
        }

    }

}

applicationContext.xml

<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-4.3.xsd">


    <bean id="fruit1" class="com.ram.model.Fruit">
        <constructor-arg type="String" value="Apple"></constructor-arg>
        <constructor-arg type="String" value="Red"></constructor-arg>
    </bean>

    <bean id="fruit2" class="com.ram.model.Fruit">
        <constructor-arg type="String" value="Grapes"></constructor-arg>
        <constructor-arg type="String" value="Violet"></constructor-arg>
    </bean>

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

        <constructor-arg type="String" value="Fruit Mart"></constructor-arg>
        <constructor-arg type="java.util.Map">
            <map>
                <entry key="1" value-ref="fruit1"></entry>
                <entry key="2" value-ref="fruit2"></entry>
            </map>
        </constructor-arg>

    </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

Apr 29, 2018 9:38:15 AM org.springframework.context.support.AbstractApplicationContext prepareRefresh
INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Sun Apr 29 09:38:15 IST 2018]; root of context hierarchy
Apr 29, 2018 9:38:15 AM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [applicationContext.xml]
Fruit(String name, String color) constructor is called by the Spring container
Fruit(String name, String color) constructor is called by the Spring container
FruitShop(String shopName, Map<Integer, Fruit> mapOfAvailableFruits) constructor is called by the Spring container
---------------------------------------
Got fruitShop object from the ApplicationContext(Spring Container)
Fruit ShopName = Fruit Mart
Fruit Id = 1, Fruit Info = Fruit [name=Apple, color=Red]
Fruit Id = 2, Fruit Info = Fruit [name=Grapes, color=Violet]

Click the below link to download the code:
https://sites.google.com/site/ramj2eev2/java_basics/SpringDemo_DI_Map_value_ref.zip?attredirects=0&d=1

Github Link:
https://github.com/ramram43210/javaee/tree/master/Spring_2018/SpringDemo_DI_Map_value_ref

Bitbucket Link:
https://bitbucket.org/ramram43210/spring/src/a1d5b66cf948298a0bb7c33e9b2c0967275f5a95/Spring_2018/SpringDemo_DI_Map_value_ref/?at=master

See also:

  • All JavaEE Videos Playlist
  • All JavaEE Videos
  • All JAVA EE Links
  • Spring Tutorial
  • Servlets Tutorial
  • All Design Patterns Links
  • JDBC Tutorial
  • Java Collection Framework Tutorial
  • JAVA Tutorial
  • Kids Tutorial
  • Cooking Tutorial
  • No comments:

    Post a Comment

    Tutorials