How to resolve 'org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type ...' - using stereotype Annotations and using @Configuration, @Bean Annotation

"At the end of the day, it doesn't really matter whether you use XML, annotation or Java configuration. It's important that beans are known to application context." - Tomasz Nurkiewicz

Hello everyone, in this article, we will learn how to resolve
org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.knf.dev.demo.account.HelloManager' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations:

Using:

1. Stereotype Annotations.
2. @Configuration, @Bean Annotation.




Before going to the example just a quick overview of NoSuchBeanDefinitionException, @Configuration annotation, @Bean annotation, and @Component annotation(Stereotype annotation).


NoSuchBeanDefinitionException:

The 'org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.knf.dev.demo.account.HelloManager' available: expected at least 1 bean which qualifies as autowire candidate....' will be thrown when the bean is not available or defined while auto-wired in another class. If the bean is not available when the spring boot bean is annotated by @Autowired from the spring boot ApplicationContext, this exception will be thrown from the application.


@Configuration:

The @Configuration annotation is a part of the spring core framework. The @Configuration is a marker annotation which denotes that a class declares one or more @Bean methods and may be processed by the Spring container to engender bean definitions and service requests for those beans at runtime.


@Bean:

The @Bean annotation is a part of the spring core framework. The  @Bean annotation tells that a method produces a bean to be managed by the Spring container. 


@Component:

The @Component annotation is utilized to denote a class as a Component. It signifies that Spring will autodetect these classes for dependency injection when annotation-predicated configuration and classpath scanning is utilized.

@ComponentScan:

The @ComponentScan annotation provides a mechanism to identify Spring bean candidates explicitly. If the application is a Spring Boot application, then all the packages under the package containing the Spring Boot application class will be covered by an implicit component scan.

**Important Notes**

  • The @ComponentScan annotation provides a mechanism to identify Spring bean candidates explicitly. If the application is a Spring Boot application, then all the packages under the package containing the Spring Boot application class will be covered by an implicit component scan.
  • Spring Boot’s @SpringBootApplication annotation implies the @Configuration, @ComponentScan, and @EnableAutoConfiguration annotations.
  • The process of searching the classpath for classes that should contribute to the application context is called component scanning. 
  • The  @SpringBootApplication annotation implies the @Configuration, @ComponentScan, and @EnableAutoConfiguration annotations. 
  • By default, the @ComponentScan annotation will scan for components in the current package and all its sub-packages. So if your application doesn’t have a varying package structure then there is no need for explicit component scanning.


Spring Boot Example 1: Reproduce the issue,

Hello.java:

public class Hello {

    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Hello(String message) {
        super();
        this.message = message;
    }

    public Hello() {
        super();
    }
}


HelloManager.java:

public interface HelloManager {

    public Hello hello();
}


HelloManagerImpl.java:

public class HelloManagerImpl implements HelloManager {

    @Override
    public Hello hello() {
        
        Hello hello = new Hello("Hello Spring!");
        return hello;
    }
}

HelloConfig.java:

public class HelloConfig {

      public HelloManager helloWorld() {
        return new HelloManagerImpl();
    }
}


Spring Boot Main Driver:

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    private static final Logger LOG = 
         LoggerFactory.getLogger(DemoApplication.class);

    @Autowired
    private HelloManager HelloManager;

    public static void main(String[] args) throws Exception {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        String hello = HelloManager.hello().getMessage();
        LOG.info(hello);

    }
}
Spring Boot’s @SpringBootApplication annotation implies the @Configuration, @ComponentScan, and @EnableAutoConfiguration annotations.

Exception:

Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'demoApplication': Unsatisfied dependency expressed through field 'HelloManager'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.knf.dev.demo.account.HelloManager' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
2022-05-01 01:11:38.364  INFO 23309 --- [           main] ConditionEvaluationReportLoggingListener : 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2022-05-01 01:11:39.078 ERROR 23309 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   : 

***************************
APPLICATION FAILED TO START
***************************

Description:

Field HelloManager in com.knf.dev.demo.account.DemoApplication required a bean of type 'com.knf.dev.demo.account.HelloManager' that could not be found.

The injection point has the following annotations:
        - @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'com.knf.dev.demo.account.HelloManager' in your configuration.


Solution: Using @Configuration and @Bean

@Configuration
public class HelloConfig {

    @Bean
    public HelloManager helloWorld() {
        return new HelloManagerImpl();
    }
}
Here we have a @Configuration class that we can use to create and use beans within the application context. @Bean is used to mark a method as one that creates a bean and Spring will then add it to the context for us.


Console Output:

Hello Spring!




Spring Boot Example 2: Reproduce the issue,

Hello.java:

public class Hello {

    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Hello(String message) {
        super();
        this.message = message;
    }

    public Hello() {
        super();
    }
}


HelloManager.java:

public interface HelloManager {

    public Hello hello();
}


HelloManagerImpl.java:

public class HelloManagerImpl implements HelloManager {

    @Override
    public Hello hello() {
        
        Hello hello = new Hello("Hello Spring!");
        return hello;
    }
}


Spring Boot Main Driver:

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    private static final Logger LOG = 
         LoggerFactory.getLogger(DemoApplication.class);

    @Autowired
    private HelloManager HelloManager;

    public static void main(String[] args) throws Exception {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        String hello = HelloManager.hello().getMessage();
        LOG.info(hello);

    }
}


Exception:

Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'demoApplication': Unsatisfied dependency expressed through field 'HelloManager'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.knf.dev.demo.account.HelloManager' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
2022-05-01 01:32:57.447  INFO 6535 --- [           main] ConditionEvaluationReportLoggingListener : 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2022-05-01 01:32:57.571 ERROR 6535 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   : 

***************************
APPLICATION FAILED TO START
***************************

Description:

Field HelloManager in com.knf.dev.demo.account.DemoApplication required a bean of type 'com.knf.dev.demo.account.HelloManager' that could not be found.

The injection point has the following annotations:
        - @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'com.knf.dev.demo.account.HelloManager' in your configuration.


Solution: Using stereotype annotation

@Component //or other stereotype annotations
public class HelloManagerImpl implements HelloManager {

    @Override
    public Hello hello() {

        Hello hello = new Hello("Hello Spring!");
        return hello;
    }
}
Mark HelloManagerImpl with @Component annotation.


Console Output:

 Hello Spring!

When to use What?

@Component Preferable for component scanning and automatic wiring.
Sometimes @Component is not an option. 
For example, You want to wire components from 3rd-party libraries but you don't have the source code so you can't annotate its classes with @Component, so automatic configuration is not possible.
The @Bean annotation returns an object that spring should register as a bean in the application context. The body of the method bears the logic responsible for engendering the instance.

Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter() method allow
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Stream<obj2>
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < 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 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSizeExc
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucket Fr
Read more