Spring工具 - SpringUtil

---

介绍

在 Spring Boot 中，依赖注入（Dependency Injection）可以很方便地获取 Bean。但是在一些工具化场景中，尤其是静态方法或独立工具类中，我们通常无法直接使用 Spring 的依赖注入。这时，Hutool 提供的 SpringUtil 工具类，可以帮助我们动态获取 Spring 容器中的 Bean，极大地方便了开发。

---

依赖引入

SpringUtil 属于 Hutool 的 extra 模块，因此在使用时需要引入 Hutool 的依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-extra</artifactId>
    <version>${hutool.version}</version>
</dependency>

---

1. 注册 SpringUtil

在 Spring Boot 项目中，我们需要将 SpringUtil 注册到 Spring 容器中，以便在全局范围内使用。通常有两种方式可以进行注册：

方法一：使用 @ComponentScan 扫描

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan(basePackages = {"cn.hutool.extra.spring"})
public class AppConfig {
    // 通过扫描 Hutool 包，将 SpringUtil 自动注册到 Spring 容器中
}

方法二：使用 @Import 导入

import cn.hutool.extra.spring.SpringUtil;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import(SpringUtil.class)
public class AppConfig {
    // 直接导入 SpringUtil 类，将其注册到 Spring 容器中
}

实际开发场景：

• 在独立工具类、静态方法或需要手动获取 Spring 容器中的 Bean 时，可以通过 SpringUtil 动态获取。

---

2. 获取指定 Bean

使用 SpringUtil 可以通过 Bean 名称、类型或两者结合的方式获取 Spring 容器中的 Bean。

示例：定义一个 Bean 并获取

首先定义一个 Bean：

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

@Component
public class DemoConfig {
    
    @Bean(name = "testDemo")
    public Demo generateDemo() {
        Demo demo = new Demo();
        demo.setId(12345);
        demo.setName("test");
        return demo;
    }
}

class Demo {
    private long id;
    private String name;

    // Getters and Setters
    public long getId() { return id; }
    public void setId(long id) { this.id = id; }

    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
}

使用 SpringUtil 获取 Bean：

import cn.hutool.extra.spring.SpringUtil;

public class SpringUtilExample {
    public static void main(String[] args) {
        // 通过名称获取 Bean
        Demo demo = SpringUtil.getBean("testDemo");

        System.out.println("Bean ID: " + demo.getId()); // 输出：Bean ID: 12345
        System.out.println("Bean Name: " + demo.getName()); // 输出：Bean Name: test
    }
}

代码解析：

• SpringUtil.getBean(String beanName)：根据 Bean 名称获取 Bean 实例。

  • beanName：Spring 容器中定义的 Bean 名称。

• SpringUtil.getBean(Class<T> beanClass)：根据 Bean 类型获取 Bean 实例。

  • beanClass：Bean 的 Class 类型。

• SpringUtil.getBean(String beanName, Class<T> beanClass)：根据名称和类型组合获取 Bean 实例，适用于同类型 Bean 多实例的情况。

实际应用场景：

• 在工具类或非 Spring 托管的类中，需要动态获取 Bean 时使用。
• 在静态方法中需要访问 Spring 容器时，可以通过 SpringUtil 获取依赖。

---

3. 动态获取所有 Bean

除了获取单个 Bean 外，还可以获取 Spring 容器中所有指定类型的 Bean。

示例：获取所有指定类型的 Bean

import cn.hutool.extra.spring.SpringUtil;
import org.springframework.context.ApplicationContext;

import java.util.Map;

public class SpringUtilExample {
    public static void main(String[] args) {
        // 获取所有 Demo 类型的 Bean
        Map<String, Demo> demoBeans = SpringUtil.getBeansOfType(Demo.class);

        // 输出所有 Demo Bean
        demoBeans.forEach((name, bean) -> {
            System.out.println("Bean Name: " + name + ", Bean Value: " + bean.getName());
        });
    }
}

代码解析：

• SpringUtil.getBeansOfType(Class<T> type)：获取所有指定类型的 Bean 实例，并返回一个包含名称和实例的 Map。
  • type：指定要获取的 Bean 类型。

实际应用场景：

• 在需要批量处理某类 Bean 时，如对某个接口的所有实现类进行统一操作。
• 动态获取并遍历所有符合条件的 Bean 实例。

---

4. 实际场景示例

假设我们有一个工具类需要发送邮件，但在工具类中我们无法直接使用依赖注入。我们可以通过 SpringUtil 获取邮件服务 Bean：

public class EmailSenderUtil {

    public static void sendEmail(String recipient, String subject, String content) {
        MailService mailService = SpringUtil.getBean(MailService.class);
        mailService.send(recipient, subject, content);
    }
}

在调用时，无需担心依赖注入问题，SpringUtil 自动从 Spring 容器中获取 MailService。

---

总结

SpringUtil 是一个简化 Spring Bean 动态获取的工具，特别适合在工具类、静态方法和非 Spring 托管的类中使用。它通过简单的 API，使得在任何地方都能轻松获取到 Spring 容器中的 Bean，从而极大提高了开发效率。