您的位置:

SpringBoot获取Bean的方法

SpringBoot作为经典的Java开发框架,其注重的Bean对象占据了其编程思想的核心部分。对于初学者和开发者而言,正确快速地获取Bean对象是关键步骤之一。本文将从多个方面来详细介绍SpringBoot获取Bean对象的方法及注意事项。

一、SpringBoot获取Bean对象

在SpringBoot中,Bean对象是一个普通的Java对象,通过Bean对象我们可以访问一个应用程序中的所有对象。Spring Boot将这些Bean对象注册到ApplicationContext对象中。可以通过以下两种方法获取Bean对象:

  1. 使用注解来自动装配Bean
  2. 使用ApplicationContext获取Bean

下面我们分别介绍这两种方法:

1.使用注解来自动装配Bean

使用注解配置Bean对象是SpringBoot开发中非常常见的做法。

// 定义一个Bean对象
@Service
public class UserService {
    public void add(String username, String password) {
        System.out.println("添加用户:" + username);
    }
}

使用注解来获取Bean对象也是非常简单的,只需要在需要获取对象的位置使用@Autowired注解即可:

// 获取UserService Bean
@Autowired
private UserService userService;

注意事项:

  • 使用注解获取Bean对象必须在SpringBoot启动类上添加@ComponentScan注解。
  • 使用注解获取Bean对象时,Bean的作用域必须为单例(Singleton),否则会出现Bean创建多份的情况。

2.使用ApplicationContext获取Bean

使用ApplicationContext也是SpringBoot获取Bean对象的常用方法之一。ApplicationContext是Spring Framework中的核心接口,其提供了访问Bean工厂的方法。

首先,我们需要在SpringBoot启动类中创建一个ApplicationContext对象:

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(Application.class, args);
    }
}

在代码中通过ApplicationContext.getBean方法获取Bean对象:

ApplicationContext context = SpringApplication.run(Application.class, args);
UserService userService= context.getBean(UserService.class);

注意事项:

  • 使用ApplicationContext获取Bean对象必须在SpringBoot启动类上添加@ComponentScan注解。
  • 使用ApplicationContext获取Bean对象时,Bean的作用域必须为单例(Singleton),否则会出现Bean创建多份的情况。

二、SpringBoot获取Bean的Method

SpringBoot提供了很多用于获取Bean对象的方法。下面我们分别介绍常用的几种方法:

1.使用getBean方法获取Bean对象

我们可以使用ApplicationContext的getBean方法获取Bean对象。

ApplicationContext context = SpringApplication.run(Application.class, args);
UserService userService = context.getBean(UserService.class);

注意事项:

  • 使用getBean方法必须知道需要获取Bean对象的类型,也就是必须使用Class对象来指定。
  • 若容器中存在多个该类型的Bean对象,则需要使用@Bean注解来指定需要获取的Bean。

2.使用autowireCapableBeanFactory对象获取Bean对象

我们可以通过autowireCapableBeanFactory对象获取Bean对象,该对象是ApplicationContext对象的一部分。

ApplicationContext context = SpringApplication.run(Application.class, args);
UserService userService = context.getAutowireCapableBeanFactory().createBean(UserService.class);

注意事项:

  • 使用autowireCapableBeanFactory对象可以直接通过类对象创建Bean对象,但要注意该对象只能获取Prototype类型的Bean对象,Singleton类型的Bean对象需要使用其他方法获取。

三、SpringBoot获取Bean工具类

SpringBoot为我们提供了很多方便的工具类来获取Bean对象。下面我们来分别介绍几个常用的工具类:

1.BeanFactoryUtils

BeanFactoryUtils是获取Bean的工具类,其提供了多种获取Bean对象的方法。

 
// 根据名称获取Bean对象
UserService userService = BeanFactoryUtils.beanOfType(context, UserService.class);

注意事项:

  • 使用BeanFactoryUtils对象必须知道需要获取Bean对象的类型,在根据名称获取时也需要知道Bean的名称。

2.ApplicationContextProvider

ApplicationContextProvider是获取ApplicationContext的工具类,其提供了获取ApplicationContext对象的方法。

 
// 获取ApplicationContext对象
ApplicationContext context = ApplicationContextProvider.getApplicationContext();
UserService userService = context.getBean(UserService.class);

使用ApplicationContextProvider对象获取ApplicationContext对象时,需要注意其在应用程序启动时才能获取到,否则将返回null对象。

四、SpringBoot获取BeanFactory

在SpringBoot中,我们可以通过ApplicationContext对象获取BeanFactory对象。BeanFactory是SpringFramework中的核心接口,其管理着Bean对象的生命周期。

 
ApplicationContext context = SpringApplication.run(Application.class, args);
BeanFactory factory = context.getAutowireCapableBeanFactory();
UserService userService = factory.createBean(UserService.class);

注意事项:

  • 使用BeanFactory后,需要使用factory.destroyBean方法进行Bean对象的销毁。

五、SpringBoot获取位置

在SpringBoot中,我们可以通过ResourceLoader获取应用程序上下文的位置。

 
ResourceLoader resourceLoader = new DefaultResourceLoader();
Resource resource = resourceLoader.getResource("classpath:application.properties");

注意事项:

  • 使用ResourceLoader时,使用的路径不同会导致获取位置的方式也不同。

六、SpringBoot获取URL

在SpringBoot中,我们可以使用ServletUriComponentsBuilder获取当前URL对象,并且可以添加参数、路径等参数。

 
URI uri = ServletUriComponentsBuilder.fromCurrentRequest().build().toUri();

注意事项:

  • 使用ServletUriComponentsBuilder获取当前URL的方法需要在HTTP请求时使用。

七、SpringBoot获取被注解的类

使用SpringBoot获取被注解的类是非常常见的需求,SpringBoot通过ClassPathScanningCandidateComponentProvider提供了获取指定注解类的方法。

 
// 获取被注解的类
ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);
scanner.addIncludeFilter(new AnnotationTypeFilter(Service.class));
Set beanDefinitionSet = scanner.findCandidateComponents("com.example.service");

  

注意事项:

  • 使用ClassPathScanningCandidateComponentProvider获取被注解类时必须知道被注解的类类型。
  • 使用时需要按照包名路径进行填写,不要填写完整路径。

八、SpringBoot获取本机IP

在SpringBoot中,我们可以使用InetAddress.getLocalHost()获取本机IP对象。

 
// 获取本机IP
InetAddress address = InetAddress.getLocalHost(); 

九、SpringBoot获取本机IP和端口

在SpringBoot中,我们可以使用ServerProperties来获取本机的IP地址和端口号。

 
// 获取本机IP和端口
@Autowired
private ServerProperties serverProperties;
public void get() {
  String ip = serverProperties.getAddress().getHostAddress();
  int port = serverProperties.getPort();
}

总结

本文分别从SpringBoot获取Bean对象、获取Bean方法、获取Bean工具类、获取BeanFactory、获取位置、获取URL、获取被注解的类、获取本机IP和端口等方面详细介绍了SpringBoot获取Bean对象的方法及注意事项。希望本文能为广大读者提供实用的技术支持,帮助初学者和开发者更好地理解和使用SpringBoot框架。