SpringBoot使用工具类实现获取容器中的Bean

 更新时间:2024年03月07日 17:04:33   作者:一线大码  
这篇文章主要为大家详细介绍了SpringBoot如何使用工具类实现获取容器中的Bean,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

1. 简要说明

实现了ApplicationContextAware接口的Bean,当Spring容器初始化的时候,会自动的将ApplicationContext注入进来,所以当一个类实现了ApplicationContextAware接口之后,这个类就可以方便地获得ApplicationContext中的所有Bean

ApplicationContextAware获取ApplicationContext上下文的情况,仅仅适用于当前运行的代码和已启动的Spring代码处于同一个Spring上下文,否则获取到的ApplicationContext是空的。

Spring项目中,只有两个类都是Spring容器中的Bean才可以互相进行依赖注入。但是在一些特殊场景下,当前类自己不是容器中的Bean,但是却需要通过注入一个容器中的Bean来实现调用这个Bean中的方法。此时就可通过本文中的工具类来实现。

2. 相关源码

ApplicationContextAware 接口的源码:

package org.springframework.context;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.Aware;

/**
 * 由任何希望被通知运行它的ApplicationContext的对象实现的接口。
 * 
 * 实现这个接口是有意义的,例如当一个对象需要访问一组协作bean时。
 * 请注意,通过bean引用进行配置比仅出于bean查找目的而实现此接口更可取。
 *
 * 如果一个对象需要访问文件资源,比如想要调用getResource,想要发布一个应用程序事件,
 * 或者需要访问 MessageSource,这个接口也可以实现。然而,在这样一个特定的场景中,
 * 最好实现更具体的ResourceLoaderAware、ApplicationEventPublisherAware或MessageSourceAware接口。
 *
 * 请注意,文件资源依赖关系也可以公开类型为org.springframework.core.io.Resource的bean属性,
 * 由bean工厂通过String自动类型转换来填充。这样就不需要仅仅为了访问特定的文件资源而实现任何回调接口。
 * 
 * link org.springframework.context.support.ApplicationObjectSupport
 * 是一个实现这个接口的应用程序对象的方便的基类。
 * 
 * 获取所有bean生命周期方法的列表查看org.springframework.beans.factory.BeanFactory。
 *
 * @author Rod Johnson
 * @author Juergen Hoeller
 * @author Chris Beams
 * @see ResourceLoaderAware
 * @see ApplicationEventPublisherAware
 * @see MessageSourceAware
 * @see org.springframework.context.support.ApplicationObjectSupport
 * @see org.springframework.beans.factory.BeanFactoryAware
 */
public interface ApplicationContextAware extends Aware {

	/**
	 * 设置运行此对象的ApplicationContext。
	 * 通常这个调用将用于初始化对象。
	 * 在填充普通bean属性之后,但在初始化回调
	 * 比如org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
	 * 或自定义初始化方法之前调用。如果适用的话,在ResourceLoaderAware#setResourceLoader、
	 * ApplicationEventPublisherAware#setApplicationEventPublisher和MessageSourceAware
	 * 之后调用。
	 * 
	 * @param 该对象使用的applicationContext对象
	 * @throws 在上下文初始化错误的情况下抛出的ApplicationContextException异常
	 * @throws 如果应用程序上下文方法引发BeansException
	 * @see org.springframework.beans.factory.BeanInitializationException
	 */
	void setApplicationContext(ApplicationContext applicationContext) throws BeansException;

}

Aware 接口的源码:

package org.springframework.beans.factory;

/**
 * 一个标记超接口,指示一个bean有资格通过一个回调样式的方法由Spring容器通知一个特定的框架对象。
 * 实际的方法签名由各个子接口确定,但通常应该只包含一个接受单个参数的返回void的方法。
 *
 * 注意,仅仅实现Aware并没有提供默认的功能。
 * 相反,处理必须显式地进行,例如在
 * org.springframework.beans.factory.config.BeanPostProcessor。
 * 参考org.springframework.context.support.ApplicationContextAwareProcessor
 * 是一个处理特定Aware接口回调的例子。
 *
 * @author Chris Beams
 * @author Juergen Hoeller
 * @since 3.1
 */
public interface Aware {

}

3. 代码示例

工具类:

package com.example.demo.util;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
public class SpringContextUtils implements ApplicationContextAware {

    /**
     * 上下文对象实例
     */
    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtils.applicationContext = applicationContext;
    }

    /**
     * 获取applicationContext
     */
    public static ApplicationContext getApplicationContext() {
        //判断是否为null
        if (applicationContext == null) {
            throw new IllegalStateException("applicaitonContext未注入,请在applicationContext.xml中定义SpringContextHolder.");
        }
        return applicationContext;
    }

    /**
     * 通过name获取Bean
     */
    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    /**
     * 通过class获取Bean
     */
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通过name和class获取Bean
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }

}

使用方法:

// 获取 Service
MyTestService myTestService = (MyTestService)SpringContextUtils.getBean("myTestServiceImpl");

到此这篇关于SpringBoot使用工具类实现获取容器中的Bean的文章就介绍到这了,更多相关SpringBoot获取容器中的Bean内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 一篇超详细的Spring Boot整合Mybatis文章

    一篇超详细的Spring Boot整合Mybatis文章

    大家都知道springboot搭建一个spring框架只需要秒秒钟。下面通过实例代码给大家介绍一下springboot与mybatis的完美融合,非常不错,具有参考借鉴价值,感兴趣的朋友一起看看吧
    2021-07-07
  • SpringBoot中配置nacos的方法实现

    SpringBoot中配置nacos的方法实现

    本文主要介绍了SpringBoot中配置nacos的方法实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-08-08
  • Java数据结构及算法实例:选择排序 Selection Sort

    Java数据结构及算法实例:选择排序 Selection Sort

    这篇文章主要介绍了Java数据结构及算法实例:选择排序 Selection Sort,本文直接给出实现代码,代码中包含详细注释,需要的朋友可以参考下
    2015-06-06
  • Mybatis-Plus处理Mysql Json类型字段的详细教程

    Mybatis-Plus处理Mysql Json类型字段的详细教程

    这篇文章主要给大家介绍了关于Mybatis-Plus处理Mysql Json类型字段的详细教程,Mybatis-Plus可以很方便地处理JSON字段,在实体类中可以使用@JSONField注解来标记JSON字段,同时在mapper.xml中使用json函数来操作JSON字段,需要的朋友可以参考下
    2024-01-01
  • springboot aop里的@Pointcut()的配置方式

    springboot aop里的@Pointcut()的配置方式

    这篇文章主要介绍了springboot aop里的@Pointcut()的配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Servlet+JDBC实现登陆功能的小例子(带验证码)

    Servlet+JDBC实现登陆功能的小例子(带验证码)

    这篇文章主要介绍了Servlet+JDBC实现登陆功能的小例子(带验证码),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 基于IDEA建立module操作步骤解析

    基于IDEA建立module操作步骤解析

    这篇文章主要介绍了基于IDEA建立module操作步骤解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • Maven根据不同环境打包不同配置文件的方法

    Maven根据不同环境打包不同配置文件的方法

    这篇文章主要介绍了Maven根据不同环境打包不同配置文件的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • 详解JAVA中获取文件MD5值的四种方法

    详解JAVA中获取文件MD5值的四种方法

    这篇文章主要介绍了JAVA中获取文件MD5值的四种方法,获取文件MD5值主要分为三个步骤,第一步获取文件的byte信息,第二步通过MessageDigest类进行MD5加密,第三步转换成16进制的MD5码值,需要的朋友可以参考下
    2022-08-08
  • springcloud 服务降级的实现方法

    springcloud 服务降级的实现方法

    这篇文章主要介绍了springcloud 服务降级的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12

最新评论