SpringUtils 工具类

原创 已于 2024-08-15 10:47:24 修改 · 1.4k 阅读 · 8 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#RuoYi-Vue-Plus

于 2024-08-11 17:04:09 首次发布

一、概述

主要作用：

  • 获取IOC容器里面BEAN对象
  • 注册和注销BEAN
  • 获取应该上下文

二、代码详解 

hutool 包中的 SpringUtil 实现了2个类：

  • BeanFactoryPostProcessor： Bean工厂的处理器，可配置的Bean列表ConfigurableListableBeanFactory ，设置到 beanFactory 工厂中
  • ApplicationContextAware ：  上下文感知，重写获取上下文方法，setApplicationContext
package cn.hutool.extra.spring;


/**
 * Spring(Spring boot)工具封装，包括：
 *
 * <ol>
 *     <li>Spring IOC容器中的bean对象获取</li>
 *     <li>注册和注销Bean</li>
 * </ol>
 *
 * @author loolly
 * @since 5.1.0
 */
@Component
public class SpringUtil implements BeanFactoryPostProcessor, ApplicationContextAware {

	@Override
	public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
		SpringUtil.beanFactory = beanFactory;
	}

	@SuppressWarnings("NullableProblems")
	@Override
	public void setApplicationContext(ApplicationContext applicationContext) {
		SpringUtil.applicationContext = applicationContext;
	}

 SpringUtils 工具类则继承了hutools方法:

@Component
public final class SpringUtils extends SpringUtil {

    /**
     * 如果BeanFactory包含一个与所给名称匹配的bean定义，则返回true
     *
     * @param name
     * @return boolean
     */
    public static boolean containsBean(String name) {
        return getBeanFactory().containsBean(name);
    }

    /**
     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。
     * 如果与给定名字相应的bean定义没有被找到，将会抛出一个异常（NoSuchBeanDefinitionException）
     *
     * @param name
     * @return boolean
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().isSingleton(name);
    }

    /**
     * @param name
     * @return Class 注册对象的类型
     */
    public static Class<?> getType(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().getType(name);
    }

    /**
     * 如果给定的bean名字在bean定义中有别名，则返回这些别名
     *
     * @param name
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().getAliases(name);
    }

    /**
     * 获取aop代理对象
     *
     * @param invoker
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> T getAopProxy(T invoker) {
        return (T) AopContext.currentProxy();
    }


    /**
     * 获取spring上下文
     */
    public static ApplicationContext context() {
        return getApplicationContext();
    }

}

三、测试常用的方法

1-SpringUtils.getBean
    @GetMapping("test1")
    public void  test(){
        TestSpringUtilsController bean = SpringUtils.getBean(TestSpringUtilsController.class);
        bean.test1();
    }


    public void test1(){
        log.info("test1被调用");
    }

结果：test1被调用


2024-08-11 15:26:19 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - test1被调用

 扩展map类型获取：

@Bean("myMap")
    public Map<String, Object> test8(){
        Map<String, Object> map = new HashMap<>();
        map.put("test8","test8Value");
        return map;
    }

    @GetMapping("test9")
    public void  test9(){
        Map<String, Object> myMap = SpringUtils.getBean("myMap");
        log.info("myMap:{}",myMap);

        //根据bean类型获取
        Map<String, Object> en = SpringUtils.getBean(new TypeReference<Map<String, Object>>() {});
        log.info("bean:{}",myMap);
    }

结果：

2024-08-11 16:59:36 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - myMap:{test8=test8Value}
2024-08-11 16:59:36 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - bean:{test8=test8Value}

2-SpringUtils.getBeansOfType：获取类下注册的BEAN

如代码 TestDemo 类，通过@Bean注解注册2个bean

@GetMapping("test2")
    public void  test2(){
        Map<String, TestDemo> beansOfType = SpringUtils.getBeansOfType(TestDemo.class);

        for (String s :beansOfType.keySet()){
            log.info("key:{}",s);
            log.info("bean:{}",beansOfType.get(s));
        }
    }

    @Bean("diyName")
    public TestDemo testDemoFun(){
        return new TestDemo();
    }

    @Bean("diyName1")
    public TestDemo testDemoFun1(){
        return new TestDemo();
    }

执行结果：


2024-08-11 15:49:14 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - key:diyName
2024-08-11 15:49:14 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - bean:TestDemo(id=null, deptId=null, userId=null, orderNum=null, testKey=null, value=null, version=null, delFlag=null)
3-注册、注销bean
@GetMapping("test3")
    public void  test3(){
        TestDemo testDemo = new TestDemo();
        testDemo.setId(1L);
        //注册
        SpringUtils.registerBean("testDemo", testDemo);
        Object bean1 = SpringUtils.getBean("testDemo");
        log.info("testDemo:{}",bean1);
        //注销
        SpringUtils.unregisterBean("testDemo");
        try {
            Object bean2 = SpringUtils.getBean("testDemo");
            log.info("testDemo:{}",bean2);
        }catch (Exception e){
            log.error("未获取到bean");
        }
    }

执行结果：

注册bean后，打印成功。注销之后打印未获取到bean


2024-08-11 16:06:05 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - testDemo:TestDemo(id=1, deptId=null, userId=null, orderNum=null, testKey=null, value=null, version=null, delFlag=null)
2024-08-11 16:06:05 [XNIO-1 task-2] ERROR c.r.d.c.TestSpringUtilsController
 - 未获取到bean
4-其他常用方法：获取类注册bean名称、是否单例等
 @Bean("diyName")
    public TestDemo testDemoFun(){
        return new TestDemo();
    }

    @Bean("diyName1")
    public TestDemo testDemoFun1(){
        return new TestDemo();
    }

    @GetMapping("test4")
    public void  test4(){
        try {

        String[] beanNamesForType = SpringUtils.getBeanNamesForType(TestDemo.class);
        log.info("beanNamesForType:{}",beanNamesForType);

        //是否包含bean
        boolean testDemo = SpringUtils.containsBean("diyName");
        log.info("containsBean:{}",testDemo);

        //是否单例
        boolean isSingleton = SpringUtils.isSingleton("diyName1");
        log.info("isSingleton:{}",testDemo);

        //获取应用名称
        String applicationName = SpringUtils.getApplicationName();
        log.info("applicationName:{}",applicationName);
        }catch (Exception e){
            log.error("未获取到bean");
        }
    }

打印结果：


2024-08-11 16:21:59 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - beanNamesForType:diyName
2024-08-11 16:21:59 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - containsBean:true
2024-08-11 16:21:59 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - isSingleton:true
2024-08-11 16:21:59 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - applicationName:RuoYi-Vue-Plus
5-SpringUtils.getProperty：获取yml配置项

比如我们打印配置文件中的端口号

 @GetMapping("test5")
    public void  test5(){
        try {
            String property = SpringUtils.getProperty("server.port");
            log.info("property:{}",property);
        }catch (Exception e){
            log.error("未获取到bean");
        }
    }

2024-08-11 16:30:45 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - property:8080
6-获取代理对象

比如这种写法每次都会直接进入test7方法，而不会去命中缓存

   @GetMapping("test6")
    public void  test6(){
        String s = test7();
        log.info("test7:{}",s);
    }


    @Cacheable(value = "testCache",key = "key")
    public String test7(){
        log.info("直接进入test7方法");
        return "ss";
    }

 每次请求都不会走上面缓存注解，直接进入test7方法。说明代理对象切面未生效


2024-08-11 16:40:14 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - 直接进入test7方法
2024-08-11 16:40:14 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - test7:ss


2024-08-11 16:40:16 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - 直接进入test7方法
2024-08-11 16:40:16 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - test7:ss


2024-08-11 16:40:17 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - 直接进入test7方法
2024-08-11 16:40:17 [XNIO-1 task-1] INFO  c.r.d.c.TestSpringUtilsController
 - test7:ss

解决办法：

  @GetMapping("test6")
    public void  test6(){
        //String s = test7();
        String s = SpringUtils.getAopProxy(this).test7();
        log.info("test7:{}",s);
    }


    @Cacheable(value = "testCache",key = "key")
    public String test7(){
        log.info("直接进入test7方法");
        return "ss";
    }

 这样第一次请求直接调用test7，后面请求就会走缓存不会调用test7。 @Cacheable注解生效


2024-08-11 16:48:24 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - 直接进入test7方法
2024-08-11 16:48:24 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - test7:ss


2024-08-11 16:48:27 [XNIO-1 task-2] INFO  c.r.d.c.TestSpringUtilsController
 - test7:ss

Spring-SpringUtils工具类
兴趣是最好的老师
08-23 381
对于事件发布，确保 ApplicationEventPublisher 已经被正确配置并注入到 Spring 容器中。对于事件发布，确保 ApplicationEventPublisher 已经被正确配置并注入到 Spring 容器中。对于定时任务，确保 ThreadPoolTaskExecutor 已经被正确配置并注入到 Spring 容器中。它包含了多种方法，以方便。对于缓存操作，确保缓存管理器 (CacheManager) 已经被正确配置并注入到 Spring 容器中。
pandas插入mysql库_使用pandas将DataFrame数据直接写入MySQL数据库
weixin_39983554的博客
12-19 1355
先看下需要存入的df数据：安装并导入需要的库：先创建数据库：开始直接一条pandas入库：入库后查看数据：注意：(1)再进行入库的时候，他会根据列自动选择类型，可能为double、float等，后面如果出现类型不匹配，就会报错，这种情况一定要进入数据库后去改下数据类型，不然会一直报错(2)pymysq：此处用的是pymsql，不要再用mysqldb，这是个坑，很麻烦，安装也很麻烦，还是用这个吧，网...
SpringUtils工具类(getBean())
qq_31856061的博客
08-17 9549
代码】SpringUtils工具类(getBean())
springboot项目中常用的工具类和api
最新发布
huing的博客
04-07 1791
如果是Spring Boot项目，优先使用Spring生态提供的工具类（如。来简化开发、提高效率。以下是一些常用的工具类及其典型应用场景，涵盖。在Spring Boot项目中，开发者通常会依赖一些。），复杂场景再引入第三方库（如Hutool）。合理使用这些工具类可以。
Spring Utils工具类常用方法实例
08-19
主要介绍了Spring Utils工具类常用方法实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
spring内置工具类
weixin_42189550的博客
12-31 1474
断言 1、断言是一个逻辑判断，用于检查不应该发生的情况 2、Assert 关键字在 JDK1.4 中引入，可通过 JVM 参数-enableassertions开启 3、SpringBoot 中提供了 Assert 断言工具类，通常用于数据合法性检查 // 要求参数 object 必须为非空（Not Null），否则抛出异常，不予放行 // 参数 message 参数用于定制异常信息。 void notNull(Object object, String message) // 要求参数必须空（Null），
Spring 普通类中调用dao,service层，获得bean
m0_38068812的博客
03-30 1156
如下为网上大神的代码，很好用，就copy过来了 import org.springframework.beans.BeansException; import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.beans.factory.config.BeanF...
ApplicationContextAware简单的封装使用
奋斗吧010
09-05 432
@Order(1) @Component public class SpringContextUtils implements ApplicationContextAware { private ApplicationContext context; @Override public void setApplicationContext(ApplicationContext context) throws BeansException { this.context
ruoyi-vue版本（二十五）SpringUtils 工具类详解
一天不写代码难受的博客
06-23 599
【代码】ruoyi-vue版本（二十五）SpringUtils 工具类详解。
Springboot实现多线程注入bean的工具类操作
09-07
使用`SpringUtils`的方式和`ApplicationContextProvider`类似，都是先在工具类中获取ApplicationContext，然后通过工具类提供的方法来获取bean。在多线程类中，可以直接调用`SpringUtils.getBean()`来获取bean。 ...
SpringUtils.java
06-27
这就是`SpringUtils.java`这个工具类的作用，它提供了一种便捷的方式，使得在非Spring环境下也能方便地获取和使用Spring Bean。 首先，`SpringUtils.java`的核心功能在于实现对Spring Bean的懒加载和单例模式。它...
自定义依赖注入工具类SpringUtil.java
05-25
自定义依赖注入工具类SpringUtil.java
SpringUtil工具类
weixin_42502300的博客
08-24 340
【代码】SpringUtil工具类。
Spring3中好用的工具类收集
热门推荐
xinguojava的专栏
05-01 1万+
1) 请求工具类 org.springframework.web.bind.ServletRequestUtils//取请求参数的整数值：public static Integer getIntParameter(ServletRequest request, String name)public static int getIntParameter(ServletRequest request, String name, int defaultVal) -->单个值public static int[]
SpringUtils 工具类，方便在非spring管理环境中获取bean
小哇
02-16 1192
3 其中的一个方法getAopProxy可获得代理对象，需要将 @EnableAspectJAutoProxy(2 spring【Controller,service】环境中，= true) 允许获取代理对象。
Spring工具类--StringUtils的使用
IT利刃出鞘的博客
06-09 4722
本文介绍Spring自带的字符串工具类：SpringUtils。 SpringUtils所在包：org.springframework.util
SpringUtil 工具类
_夜渐凉
04-12 6157
当需要直接调用类中的静态方法：类名.方法名() 直接调用时 而一些SpringBoot非静态变量，或者注入的bean 在静态方法中是无法获取到的，需要改动也比较麻烦 @Value("${company.file.upload}") private String upload; @Resource private AttachmentService attachmentService; 那...
带你了解Spring中的各种Utils
zzc19981221的博客
01-17 595
在Spring中，有非常多Utils工具类，这些工具类有的是为了开发者使用的，有的只是提供给Spring框架使用的。了解这些工具类，在适当的时候使用这些工具类，对我们平时的开发还是很有帮助的，能极大方便我们的开发。 前言 Spring的工具类都是以Utils结尾，所以要查看这些工具类，只需要在API文档中查询所有*Utils即可，可以看到有多达几十个。 其中有我们非常熟悉的 org.springf...
SpringUtils
03-17
SpringUtils 可以理解为一种通用工具类的概念，它通常是开发者基于 Spring 框架提供的功能特性所封装的一系列便捷方法集合。这类工具类主要用于简化日常开发中的常见需求，比如获取 Spring 容器中的 Bean、管理上下文环境变量等。 --- ### 常见的功能实现 #### 1. 获取 Spring 容器中的 Bean 在某些情况下，我们需要动态地从 Spring 容器中获取某个 Bean 实例。尽管推荐使用依赖注入的方式，但在一些静态环境下（例如工具类），这种方式就显得尤为重要了。 ```java import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.stereotype.Component; @Component public class SpringUtils implements ApplicationContextAware { private static ApplicationContext applicationContext; @Override public void setApplicationContext(ApplicationContext context) throws BeansException { applicationContext = context; } /** * 根据名称和类型获取Bean实例 */ public static <T> T getBean(Class<T> clazz) { return applicationContext.getBean(clazz); } /** * 根据beanName获取对应的Bean实例 */ public static Object getBean(String beanName) { return applicationContext.getBean(beanName); } } ``` 上述代码片段展示了如何通过 `ApplicationListener` 接口设置静态引用至 Spring 的容器 (`ApplicationContext`) ，之后便可方便快捷地检索出任何已声明并注册好的组件对象啦！ --- #### 2. 环境属性读取 另一个常用的场景是从 application.properties 文件或其他资源配置文件里拉取关键性的参数值，同样也可以借助于类似这样的辅助函数完成任务: ```java public static String getProperty(String key){ return applicationContext.getEnvironment().getProperty(key); } ``` 此段落里的示例说明如果想要快速取得配置档内的某项设定可以直接呼叫此类别的对应method即可达成目的。 --- ### 使用注意事项 虽然这种做法能够带来不少便利之处，但也需注意以下几点事项： - **单例模式保证唯一性**: 因为我们这里采用的是静态成员变量存储applicationContext对象，请务必确认在整个应用生命周期期间只有一个唯一的instance存在； - **过度依赖可能导致耦合增加** : 如果项目中有过多地方都频繁调用了springutils的话，则可能会使得整体架构变得较为紧密连接难以维护重构等问题发生；因此建议合理权衡利弊后再决定是否引入此类设计思路吧! --- ### 示例应用场景 假定我们现在有一个发送邮件的服务 MailService，并且已经将其定义成了 spring-managed component 。那么当我们需要随时触发一封通知信件的时候就可以如此操作了： ```java MailService mailService = SpringUtils.getBean(MailService.class); mailService.sendEmail("example@example.com", "Hello World!"); ``` ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

syfjava

请博主喝杯蜜雪冰城

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值