一、介绍

cn.hutool.extra.spring.SpringUtil 是 Hutool 工具包中用于 Spring 框架的辅助类,它提供了一系列静态方法,方便在非 Spring 管理的类中获取 Spring 容器中的 Bean,或者执行与 Spring 容器相关的操作。

依赖:

   <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.4.6</version>
   </dependency>

二、常用方法介绍

1、获取 Spring 上下文:

  • getApplicationContext():获取当前 Spring 应用的上下文(ApplicationContext)。

2、获取 Bean:

  • getBean(Class requiredType):根据类型获取 Spring 容器中的 Bean。
  • getBean(String name):根据名称获取 Spring 容器中的 Bean。
  • getBean(String name, Class requiredType):根据名称和类型获取 Spring 容器中的 Bean。

3、检查 Bean 是否存在:

  • containsBean(String name):检查 Spring 容器中是否包含指定名称的 Bean。
  • isSingleton(String name):检查指定名称的 Bean 是否为单例。
  • isPrototype(String name):检查指定名称的 Bean 是否为原型。
  • isTypeMatch(String name, Class<?> targetType):检查指定名称的 Bean 的类型是否与给定类型匹配。

4、获取 Bean 的类型:

  • getType(String name):获取指定名称的 Bean 的类型。

5、执行 Spring 表达式:

  • evaluateExpression(String expression, Class expectedType):执行 Spring 的 SpEL(Spring Expression Language)表达式,并返回指定类型的结果。

6、注册 Bean:

  • registerBean(Object bean):向 Spring 容器中注册一个 Bean。

7、获取 Spring 容器属性:

  • getEnvironment():获取 Spring 环境的 Environment 对象。
  • getProperty(String key):获取 Spring 容器中的属性值。

8、其他方法:

  • isApplicationContextLoaded():检查 Spring 上下文是否已经加载。

请注意,直接使用 SpringUtil 来获取 Spring 容器中的 Bean 通常不是最佳实践,因为它破坏了 Spring 的依赖注入原则。在大多数情况下,应该通过构造器、字段或方法注入来获取所需的依赖项。然而,在某些特殊情况下,例如在某些静态工具类或初始化代码中,可能需要使用 SpringUtil 来获取 Bean。

另外,为了确保 SpringUtil 能够正常工作,你需要在 Spring 配置中注册 SpringContextHolder Bean,这个 Bean 负责在 Spring 容器启动时保存 ApplicationContext 的引用。

三、参考文档

https://www.hutool.cn/docs/#/extra/Spring/Spring%E5%B7%A5%E5%85%B7-SpringUtil?id=%e4%bd%bf%e7%94%a8

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐