Tuesday, 12 June 2018

How to Inject Array having Dependent Object using Spring dependency injection by constructor?

Enjoying this Java & Spring tutorial?

Subscribe to Ram N Java on YouTube

Introduction

In Spring Framework, constructor-based dependency injection is widely used to pass mandatory dependencies to a bean at the time of object initialization. In enterprise applications, you often deal with arrays of custom complex objects rather than just simple primitive types.

In this tutorial, you will learn how to configure Spring XML to inject an Array of Dependent Objects into another class through its constructor.

1. Create the Dependent Class (Fruit)

First, let's create a Fruit class which acts as the dependent model object. It contains basic attributes and a constructor:

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

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

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

2. Create the Target Class (FruitShop)

Next, create the FruitShop class containing an array of Fruit objects, which will be initialized through its constructor:

import java.util.Arrays;

public class FruitShop {
    private String shopName;
    private Fruit[] fruits;

    public FruitShop(String shopName, Fruit[] fruits) {
        this.shopName = shopName;
        this.fruits = fruits;
    }

    public void displayFruitShopInfo() {
        System.out.println("Shop Name: " + shopName);
        System.out.println("Fruits Array: " + Arrays.toString(fruits));
    }
}
  

3. Configure Spring XML with <array> and <ref>

In your applicationContext.xml, declare the Fruit beans first. Then, use <constructor-arg> with the <array> tag and reference the dependent beans using <ref bean="..." />:

<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="fruit1" class="Fruit">
        <constructor-arg value="Apple" />
        <constructor-arg value="Red" />
    </bean>

    <bean id="fruit2" class="Fruit">
        <constructor-arg value="Banana" />
        <constructor-arg value="Yellow" />
    </bean>

    <!-- Target Bean with Array Injection -->
    <bean id="fruitShop" class="FruitShop">
        <constructor-arg value="City Fresh Fruits" />
        <constructor-arg>
            <array value-type="Fruit">
                <ref bean="fruit1" />
                <ref bean="fruit2" />
            </array>
        </constructor-arg>
    </bean>

</beans>
  

4. Test the Implementation

Load the Spring IoC container and run the application to verify that the array with dependent objects is correctly initialized:

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=x2VVoaDMqDA&list=UUhwKlOVR041tngjerWxVccw

Click the below Image to Enlarge:

How to Inject Array having Dependent Object using Spring dependency injection by constructor?

How to Inject Array having Dependent Object using Spring dependency injection by constructor?

How to Inject Array having Dependent Object using Spring dependency injection by constructor?

How to Inject Array having Dependent Object 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.Arrays;

import com.ram.model.Fruit;

public class FruitShop
{
    private String shopName;
    private Fruit[] fruitArray;

    public FruitShop(String shopName, Fruit[] fruitArray)
    {
        System.out.println(
                "FruitShop(String shopName, Fruit[] fruitArray) "
                        + "constructor is called by the Spring container");
        this.shopName = shopName;
        this.fruitArray = fruitArray;
    }

    public void displayFruitShopInfo()
    {
        System.out.println("FruitShop [shopName=" + shopName
                + ", fruitArray=" + Arrays.toString(fruitArray) + "]");
    }

}

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 >
            <array>
                <ref bean="fruit1" />
                <ref bean="fruit2" />
            </array>
        </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

May 02, 2018 9:30:52 AM org.springframework.context.support.AbstractApplicationContext prepareRefresh
INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Wed May 02 09:30:52 IST 2018]; root of context hierarchy
May 02, 2018 9:30:52 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, Fruit[] fruitArray) constructor is called by the Spring container
---------------------------------------
Got fruitShop object from the ApplicationContext(Spring Container)
FruitShop [shopName=Fruit Mart, fruitArray=[Fruit [name=Apple, color=Red], Fruit [name=Grapes, color=Violet]]]

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

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

Bitbucket Link:
https://bitbucket.org/ramram43210/spring/src/86ee7b900f70a86db05f4e340d61f7dbde206934/Spring_2018/SpringDemo_DI_Array_dependentObject/?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