Showing posts with label Dependent Object Injection. Show all posts
Showing posts with label Dependent Object Injection. Show all posts

Friday, 25 May 2018

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

Enjoying this Java & Spring tutorial?

Subscribe to Ram N Java on YouTube

Introduction

In Spring Framework, Constructor Injection is the industry-standard approach for passing collaborator objects (dependencies) to a target bean. It ensures that a bean cannot be instantiated in an incomplete or invalid state, guaranteeing immutability and facilitating cleaner unit testing.

In this tutorial, you will learn how to inject a custom dependent object into another class using constructor dependency injection through Spring XML configuration.

1. Create the Dependent Class (Address)

Start by defining the dependent collaborator class (for instance, an Address class) with its attributes and constructor:

public class Address {
    private String city;
    private String state;
    private String country;

    public Address(String city, String state, String country) {
        this.city = city;
        this.state = state;
        this.country = country;
    }

    @Override
    public String toString() {
        return city + ", " + state + ", " + country;
    }
}
  

2. Create the Target Class (Employee)

Create the target class Employee which accepts the dependent Address object along with primitive values through its constructor:

public class Employee {
    private int id;
    private String name;
    private Address address;

    public Employee(int id, String name, Address address) {
        this.id = id;
        this.name = name;
        this.address = address;
    }

    public void showEmployeeDetails() {
        System.out.println("ID: " + id);
        System.out.println("Name: " + name);
        System.out.println("Address: " + address);
    }
}
  

3. Configure Spring XML using <constructor-arg ref="...">

In your applicationContext.xml, declare the Address bean first, then inject it into the Employee bean using the ref attribute inside <constructor-arg>:

<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 Bean -->
    <bean id="addressBean" class="Address">
        <constructor-arg value="Chennai" />
        <constructor-arg value="Tamil Nadu" />
        <constructor-arg value="India" />
    </bean>

    <!-- Target Bean with Dependent Object Injected -->
    <bean id="employeeBean" class="Employee">
        <constructor-arg value="101" type="int" />
        <constructor-arg value="Peter" type="java.lang.String" />
        <constructor-arg ref="addressBean" />
    </bean>

</beans>
  

4. Test the Bean Initialization

Load the application context with ClassPathXmlApplicationContext, fetch the bean, and print the output:

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");
        Employee emp = (Employee) context.getBean("employeeBean");
        emp.showEmployeeDetails();
    }
}
  

Watch More Spring Tutorials


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

Click the below Image to Enlarge:
How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

How to Inject Dependent Object using Spring dependency injection by constructor? | Spring Tutorial

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>

Address.java

package com.ram.model;

public class Address
{
    private String city;
    private String state;
    private String country;

    public Address(String city, String state, String country)
    {
        this.city = city;
        this.state = state;
        this.country = country;
    }

    @Override
    public String toString()
    {
        return "Address [city=" + city + ", state=" + state + ", country="
                + country + "]";
    }

}

Employee.java

package com.ram.model;

public class Employee
{
    private int id;
    private String name;
    private Address address;

    public Employee(int id, String name, Address address)
    {
        System.out.println("Employee(int id, String name, Address address) "
                + "constructor is called by the Spring container");
        this.id = id;
        this.name = name;
        this.address = address;
    }

    public void displayEmployeeDetails()
    {
        System.out.println("Employee [id=" + id + ", name=" + name
                + ", address=" + address + "]");
    }

}

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="address" class="com.ram.model.Address">
        <constructor-arg value="Chennai"></constructor-arg>
        <constructor-arg value="Tamil Nadu"></constructor-arg>
        <constructor-arg value="India"></constructor-arg>
    </bean>

    <bean id="employee" class="com.ram.model.Employee">
        <constructor-arg type="int" value="36"></constructor-arg>
        <constructor-arg type="String" value="Peter"></constructor-arg>

        <constructor-arg>
            <ref bean="address" />
        </constructor-arg>
    </bean>

</beans>

App.java

package com.ram.core;

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

import com.ram.model.Employee;

public class App
{
    public static void main(String[] args)
    {
        ApplicationContext context = new ClassPathXmlApplicationContext(
                "applicationContext.xml");

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

        Employee employee = (Employee) context.getBean("employee");
        System.out.println(
                "Got employee object from the ApplicationContext(Spring Container)");
        employee.displayEmployeeDetails();

    }

}

Output

Apr 19, 2018 9:23:07 AM org.springframework.context.support.AbstractApplicationContext prepareRefresh
INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Thu Apr 19 09:23:07 IST 2018]; root of context hierarchy
Apr 19, 2018 9:23:07 AM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [applicationContext.xml]
Employee(int id, String name, Address address) constructor is called by the Spring container
---------------------------------------
Got employee object from the ApplicationContext(Spring Container)
Employee [id=36, name=Peter, address=Address [city=Chennai, state=Tamil Nadu, country=India]]

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

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

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