Showing posts with label Java Spring Tutorial. Show all posts
Showing posts with label Java Spring Tutorial. Show all posts

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
  • Friday, 1 June 2018

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    Enjoying this Java & Spring tutorial?

    Subscribe to Ram N Java on YouTube

    Introduction

    In Spring Framework, constructor injection is the preferred way to ensure all mandatory dependencies are initialized properly. When working with collections such as a java.util.Map, scenarios often arise where both the key and the value are custom dependent objects rather than simple primitives or strings.

    In this tutorial, you will learn how to configure Spring XML to inject a Map containing custom objects as both its keys and values using constructor dependency injection.

    1. Create the Key and Value Model Classes

    Let's create two separate model classes: Customer (to act as the Map key) and Car (to act as the Map value).

    public class Customer {
        private String name;
    
        public Customer(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "Customer [name=" + name + "]";
        }
    }
      
    public class Car {
        private String model;
    
        public Car(String model) {
            this.model = model;
        }
    
        @Override
        public String toString() {
            return "Car [model=" + model + "]";
        }
    }
      

    2. Create the Service or Container Class

    Next, create a class named CarRentalService that accepts a Map<Customer, Car> through its constructor:

    import java.util.Map;
    
    public class CarRentalService {
        private Map<Customer, Car> rentalMap;
    
        public CarRentalService(Map<Customer, Car> rentalMap) {
            this.rentalMap = rentalMap;
        }
    
        public void displayRentalInfo() {
            for (Map.Entry<Customer, Car> entry : rentalMap.entrySet()) {
                System.out.println(entry.getKey() + " rented " + entry.getValue());
            }
        }
    }
      

    3. Configure Spring XML with <key-ref> and <value-ref>

    In your applicationContext.xml, declare the dependent beans and then wire them inside the <map> element using key-ref and value-ref attributes inside <entry>:

    <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">
    
        <!-- Key Beans -->
        <bean id="customer1" class="Customer">
            <constructor-arg value="John" />
        </bean>
    
        <!-- Value Beans -->
        <bean id="car1" class="Car">
            <constructor-arg value="Tesla Model 3" />
        </bean>
    
        <!-- Target Bean -->
        <bean id="rentalService" class="CarRentalService">
            <constructor-arg>
                <map>
                    <entry key-ref="customer1" value-ref="car1" />
                </map>
            </constructor-arg>
        </bean>
    
    </beans>
      

    4. Run and Test the Code

    Initialize the Spring context and call the display method to see your injected dependent objects:

    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");
            CarRentalService service = (CarRentalService) context.getBean("rentalService");
            service.displayRentalInfo();
        }
    }
      

    Watch More Spring Tutorials


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

    Click the below Image to Enlarge:

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    How to Inject Map having dependent Object in key and value using dependency injection by constructor

    How to Inject Map having dependent Object in key and value using 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>

    FruitSeller.java

    package com.ram.model;

    public class FruitSeller
    {
        private String name;
        private String emailId;

        public FruitSeller(String name, String emailId)
        {
            System.out.println("FruitSeller(String name, String emailId) "
                    + "constructor is called by the Spring container");

            this.name = name;
            this.emailId = emailId;
        }

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

    }

    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 + "]";
        }

    }

    FruitInfo.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;
    import com.ram.model.FruitSeller;

    public class FruitInfo
    {
        private Map<FruitSeller, Fruit> mapOfFruitSellerAndFruit;

        public FruitInfo(Map<FruitSeller, Fruit> mapOfFruitSellerAndFruit)
        {
            System.out.println(
                    "FruitInfo(Map<FruitSeller, Fruit> mapOfFruitSellerAndFruit) "
                            + "constructor is called by the Spring container");
            this.mapOfFruitSellerAndFruit = mapOfFruitSellerAndFruit;
        }

        public void displayFruitInfo()
        {
            System.out.println("FruitInfo [mapOfFruitSellerAndFruit="
                    + mapOfFruitSellerAndFruit + "]");

            Set<Entry<FruitSeller, Fruit>> set = mapOfFruitSellerAndFruit
                    .entrySet();

            Iterator<Entry<FruitSeller, Fruit>> itr = set.iterator();
            while (itr.hasNext())
            {
                Entry<FruitSeller, Fruit> entry = itr.next();
                System.out.println("FruitSeller = " + entry.getKey() + ", Fruit = "
                        + 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="fruitSeller1" class="com.ram.model.FruitSeller">
            <constructor-arg type="String" value="Peter"></constructor-arg>
            <constructor-arg type="String" value="Peter@yahoo.com"></constructor-arg>
        </bean>

        <bean id="fruitSeller2" class="com.ram.model.FruitSeller">
            <constructor-arg type="String" value="John"></constructor-arg>
            <constructor-arg type="String" value="John@gmail.com"></constructor-arg>
        </bean>
     
        <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="fruitInfo" class="com.ram.core.FruitInfo">

            <constructor-arg type="java.util.Map">
                <map>
                    <entry key-ref="fruitSeller1" value-ref="fruit1"></entry>
                    <entry key-ref="fruitSeller2" 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("---------------------------------------");

            FruitInfo fruitShop = (FruitInfo) context.getBean("fruitInfo");
            System.out.println(
                    "Got fruitInfo object from the ApplicationContext(Spring container)");
            fruitShop.displayFruitInfo();
        }

    }

    Output

    Apr 30, 2018 9:47:13 AM org.springframework.context.support.AbstractApplicationContext prepareRefresh
    INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Mon Apr 30 09:47:13 IST 2018]; root of context hierarchy
    Apr 30, 2018 9:47:13 AM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
    INFO: Loading XML bean definitions from class path resource [applicationContext.xml]
    FruitSeller(String name, String emailId) constructor is called by the Spring container
    FruitSeller(String name, String emailId) constructor is called by the Spring container
    Fruit(String name, String color) constructor is called by the Spring container
    Fruit(String name, String color) constructor is called by the Spring container
    FruitInfo(Map<FruitSeller, Fruit> mapOfFruitSellerAndFruit) constructor is called by the Spring container
    ---------------------------------------
    Got fruitInfo object from the ApplicationContext(Spring container)
    FruitInfo [mapOfFruitSellerAndFruit={FruitSeller [name=Peter, emailId=Peter@yahoo.com]=Fruit [name=Apple, color=Red], FruitSeller [name=John, emailId=John@gmail.com]=Fruit [name=Grapes, color=Violet]}]
    FruitSeller = FruitSeller [name=Peter, emailId=Peter@yahoo.com], Fruit = Fruit [name=Apple, color=Red]
    FruitSeller = FruitSeller [name=John, emailId=John@gmail.com], Fruit = Fruit [name=Grapes, color=Violet]

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

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

    Bitbucket Link:
    https://bitbucket.org/ramram43210/spring/src/a1d5b66cf948298a0bb7c33e9b2c0967275f5a95/Spring_2018/SpringDemo_DI_Map_Key_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
  • Tutorials