Skip to content

Yet another programming solutions log

Sample bits from programming for the future generations.

Technologies Technologies
  • Algorithms and Data Structures
  • Java Tutorials
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Spock Framework Tutorial
  • Spring Framework
  • Bash Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Developer’s Tools
  • Productivity
  • About
Expand Search Form

Spring Setter Injection

farenda 2016-06-19 0

Spring Setter Injection

This form of Dependency Injection is used very often, especially for optional dependencies and reconfigurable beans. We’ll show how to use it using Spring annotations.

Spring bean to inject as dependency

Let’s specify an interface for dependency:

package com.farenda.spring.tutorial.injection.setter;

public interface BookRepository {
    String titleById(int id);
}

And the actual Spring Bean implementation that will be injected:

package com.farenda.spring.tutorial.injection.setter;

import org.springframework.stereotype.Repository;

import java.util.HashMap;
import java.util.Map;

@Repository
public class InMemoryBookRepository implements BookRepository {

    // It's our local database ;-)
    private Map<Integer, String> books = new HashMap<>();

    {
        books.put(1, "Effective Java, 2nd edition");
        books.put(2, "Java Concurrency in Practice");
        books.put(3, "Spring in Action");
    }

    @Override
    public String titleById(int id) {
        return books.get(id);
    }
}

Spring component with dependency injected using setter

Here we define another Spring Bean, but this time we are going to inject BookRepository through setter, using @Autowired annotation:

package com.farenda.spring.tutorial.injection.setter;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class Library {

    private BookRepository bookRepository;

    @Autowired
    public void setBookRepository(BookRepository bookRepository) {
        this.bookRepository = bookRepository;
    }

    public String findBook(int id) {
        return bookRepository.titleById(id);
    }
}

Constructor or setter injection

It is a good practice to use constructor injection, because it allows to:

  • create beans as immutable objects,
  • make sure all dependencies were provided,
  • return bean to a client in consistent, fully initialized state.

Use setter injection for optional dependencies and/or to allow run-time reconfiguration of beans (e.g. through JMX or a REPL).

Example App using Spring Boot

Here’s the simplest Spring Boot application to run the above code:

package com.farenda.spring.tutorial.injection.setter;

import org.springframework.boot.SpringApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan
public class SetterInjection {

    public static void main(String[] args) {
        ApplicationContext context = SpringApplication
                .run(SetterInjection.class, args);

        Library library = context.getBean(Library.class);

        System.out.println("Title 1: " + library.findBook(1));
        System.out.println("Title 2: " + library.findBook(2));
    }
}

The above code produces the following output:

Title 1: Effective Java, 2nd edition
Title 2: Java Concurrency in Practice

References:

  • Spring Reference Documentation
  • Spring Constructor Injection
Share with the World!
Categories Spring Framework Tags spring, spring-core
Previous: Java Lang Tutorial
Next: Java Time Clock Tutorial

Recent Posts

  • Java 8 Date Time concepts
  • Maven dependency to local JAR
  • Caesar cipher in Java
  • Java casting trick
  • Java 8 flatMap practical example
  • Linked List – remove element
  • Linked List – insert element at position
  • Linked List add element at the end
  • Create Java Streams
  • Floyd Cycle detection in Java

Pages

  • About Farenda
  • Algorithms and Data Structures
  • Bash Tutorial
  • Bean Validation Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Java 8 Streams and Lambda Expressions Tutorial
  • Java Basics Tutorial
  • Java Collections Tutorial
  • Java Concurrency Tutorial
  • Java IO Tutorial
  • Java Tutorials
  • Java Util Tutorial
  • Java XML Tutorial
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Software Developer’s Tools
  • Spock Framework Tutorial
  • Spring Framework

Tags

algorithms bash bean-validation books clojure design-patterns embedmongo exercises git gof gradle groovy hateoas hsqldb i18n java java-basics java-collections java-concurrency java-io java-lang java-time java-util java-xml java8 java8-files junit linux lists log4j logging maven mongodb performance quartz refactoring regex rest slf4j solid spring spring-boot spring-core sql unit-tests

Yet another programming solutions log © 2021

sponsored