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

Tuesday, 26 June 2018

How to Inject dependent Object using Spring dependency injection by Setter method?

Enjoying This Tutorial?

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

SUBSCRIBE NOW

Introduction

In Spring Framework applications, assembling collaborating objects is at the heart of Inversion of Control (IoC). When an object depends on another custom object—such as an Employee possessing an Address—Spring allows you to wire this dependency cleanly using the <property> element along with the ref attribute via setter-based dependency injection.

Why Inject Dependent Objects via Setter Method?

  • Loose Coupling: Eliminates direct instantiation (e.g., calling new Address()) within the dependent class, making classes modular and easily swappable.
  • Declarative Wiring with ref: The ref attribute points to the ID of another bean defined in the container, wiring complex graphs of objects effortlessly.
  • Flexibility: Setter injection makes dependencies optional and allows them to be reconfigured or mocked easily during unit testing.

Step-by-Step Code Example

Here is an example demonstrating an Employee class receiving a dependent Address object via setter injection:

1. The Dependent and Target Model Classes

package com.ram.model;

// Dependent Object
public class Address {
    private String city;
    private String state;

    public void setCity(String city) {
        this.city = city;
    }

    public void setState(String state) {
        this.state = state;
    }

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

// Target Class holding the Dependent Object
public class Employee {
    private String name;
    private Address address;

    public void setName(String name) {
        this.name = name;
    }

    // Setter method for dependent object injection
    public void setAddress(Address address) {
        this.address = address;
    }

    public void display() {
        System.out.println("Employee Name: " + name);
        System.out.println("Address: " + address);
    }
}

2. Configuring applicationContext.xml

Define the collaborator bean first, then reference it using the ref attribute inside the target bean's <property> tag:

<!-- Dependent Address Bean -->
<bean id="addressBean" class="com.ram.model.Address">
    <property name="city" value="Bangalore" />
    <property name="state" value="Karnataka" />
</bean>

<!-- Employee Bean with Dependent Object Setter Injection -->
<bean id="employee" class="com.ram.model.Employee">
    <property name="name" value="Ram" />
    <property name="address" ref="addressBean" />
</bean>

3. Loading and Executing with ApplicationContext

ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");

Employee emp = (Employee) context.getBean("employee");
emp.display();

Key Takeaway

Using the ref attribute inside a <property> element allows Spring's IoC container to resolve and wire dependent collaborator objects into beans via their setter methods, maintaining a cleanly decoupled architecture.

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

Click the below Image to Enlarge:
How to Inject dependent Object using Spring dependency injection by Setter method?

How to Inject dependent Object using Spring dependency injection by Setter method?

How to Inject dependent Object using Spring dependency injection by Setter method?

How to Inject dependent Object using Spring dependency injection by Setter method?

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;

    public String getCity()
    {
        return city;
    }

    public void setCity(String city)
    {
        this.city = city;
    }

    public String getState()
    {
        return state;
    }

    public void setState(String state)
    {
        this.state = state;
    }

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

}

Employee.java

package com.ram.model;

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

    public int getId()
    {
        return id;
    }

    public void setId(int id)
    {
        this.id = id;
    }

    public String getName()
    {
        return name;
    }

    public void setName(String name)
    {
        this.name = name;
    }

    public Address getAddress()
    {
        return address;
    }

    public void setAddress(Address address)
    {
        this.address = address;
    }

    @Override
    public String toString()
    {
        return "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">
        <property name="city" value="Chennai"></property>
        <property name="state" value="TamilNadu"></property>
    </bean>


    <bean id="employee" class="com.ram.model.Employee">
        <property name="id" value="100"></property>
        <property name="name" value="Peter"></property>
        <property name="address" ref="address"></property>
    </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)");

        System.out.println(employee);

    }

}

Output

May 10, 2018 9:59:37 AM org.springframework.context.support.AbstractApplicationContext prepareRefresh
INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@5b37e0d2: startup date [Thu May 10 09:59:37 IST 2018]; root of context hierarchy
May 10, 2018 9:59:37 AM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from class path resource [applicationContext.xml]
---------------------------------------
Got employee object from the ApplicationContext(Spring Container)
Employee [id=100, name=Peter, address=Address [city=Chennai, state=TamilNadu]]

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

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

Bitbucket Link:
https://bitbucket.org/ramram43210/spring/src/e3083a26f8b5dc28ef01dcb434963fb880058c7b/Spring_2018/SpringDemo_Setter_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