SpringBoot内置的五个内置对象很方便

科技   2024-09-29 08:11   河北  


前言

在SpringBoot框架的广阔生态中,精心设计的内置对象如同强大的工具,极大地简化了开发流程。本文将深入剖析SpringBoot中最常使用的五大内置对象:ApplicationContext、BeanFactory、Environment、ResourceLoader以及MessageSource。我们将逐一阐述这些对象的核心作用、它们在实际开发中的使用方法,以及如何通过相应的API来高效利用它们。这样的介绍旨在帮助开发者更好地理解和利用SpringBoot框架的强大功能。

一、ApplicationContext

简介

ApplicationContext(应用上下文)是SpringBoot框架中的一个核心接口,它扩展自BeanFactory接口,提供了更为丰富的功能。ApplicationContext主要负责管理Bean的生命周期,包括Bean的创建、销毁以及它们之间的依赖注入;同时,它还支持事件的发布与监听,以及资源访问等高级功能。在SpringBoot应用中,开发者通常会根据项目的具体需求选择适当的ApplicationContext实现类,如AnnotationConfigApplicationContext(用于基于Java配置的Spring应用)或XmlWebApplicationContext(用于基于XML配置的Web应用)等,来作为应用的上下文环境。

ApplicationContext的使用

在SpringBoot应用中,我们可以灵活地通过以下几种方式获取到ApplicationContext对象:

  1. 通过实现ApplicationContextAware接口:在Spring框架中,任何实现了ApplicationContextAware接口的Bean都会收到Spring容器中的ApplicationContext对象的引用。这允许我们直接访问ApplicationContext,而无需通过其他间接方式。

  2. 通过@Autowired注解:在Spring的依赖注入机制中,我们可以使用@Autowired注解自动装配ApplicationContext对象到需要的字段或方法中。这种方式简单直观,特别适用于需要在组件内部访问ApplicationContext的场景。

  3. 通过SpringApplication.run()方法返回的对象:当我们启动SpringBoot应用时,通常会调用SpringApplication.run(Class<?> primarySource, String... args)方法。这个方法会返回一个ApplicationContext对象,代表整个应用的上下文。因此,我们可以在应用启动后立即获取到这个ApplicationContext对象。

获取到ApplicationContext对象后,我们可以利用它提供的丰富方法来操作和管理Bean,包括但不限于:

  • getBean():该方法允许我们根据Bean的名称或者类型来获取Bean的实例。这是最常用的方法之一,用于在运行时获取特定的Bean。

  • containsBean():该方法用于判断Spring容器中是否包含指定名称的Bean。

  • isSingleton():该方法用于判断指定名称的Bean是否被定义为单例Bean。

  • getBeanDefinitionNames():该方法返回Spring容器中所有Bean的名称列表,允许我们遍历或检查容器中的Bean。

  • getBeanDefinitionCount():该方法返回Spring容器中Bean定义的数量,提供了容器规模的一个大致估计。


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

@Component
public class ApplicationContextUtil {

    @Autowired
    private ApplicationContext applicationContext;

    // 其他方法}
public class UserService {

    public void getUser() {
        // 获取UserDao Bean
        UserDao userDao = applicationContext.getBean(UserDao.class);
        userDao.getUser();
    }}

二、BeanFactory

简介

BeanFactory(Bean工厂)是Spring框架(包括SpringBoot)中的一个核心接口,它扮演着创建和管理Bean的基石角色。BeanFactory通过一种称为延迟加载(或懒加载)的策略来优化资源使用,即它仅在应用实际请求某个Bean时,才会去创建和初始化该Bean的实例。这种策略不仅有助于减少应用启动时的内存消耗,还能通过避免不必要的初始化工作来提升启动速度。因此,BeanFactory是Spring实现IoC(控制反转)容器功能的关键组件之一。

获取和使用BeanFactory对象

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class BeanFactoryUtil {

    @Autowired
    private BeanFactory beanFactory;

    // 其他方法
}
public class UserService {

    public void getUser() {
        // 获取UserDao Bean
        UserDao userDao = beanFactory.getBean(UserDao.class);
        userDao.getUser();
    }
}

三、Environment

简介

Environment(环境)是SpringBoot框架中的一个关键接口,它承担着管理应用配置信息的重任。Environment接口设计了一种标准化的访问机制,使得开发者能够便捷地获取到应用的各类配置信息,这些信息可能来源于系统属性、环境变量、外部配置文件(如application.properties或application.yml)等多种渠道。在SpringBoot应用的实践中,开发者通常会遇到StandardEnvironmentConfigurableEnvironment这两个Environment接口的实现类,它们为应用提供了灵活且强大的配置管理能力。

Environment的使用

在SpringBoot应用中,我们可以通过以下几种方式灵活地获取到Environment对象:

  1. 通过实现EnvironmentAware接口:在Spring框架中,任何实现了EnvironmentAware接口的Bean都会自动被注入一个Environment对象,这使得我们能够在Bean中直接访问到应用的配置环境。

  2. 通过@Autowired注解:利用Spring的依赖注入特性,我们可以在需要访问Environment对象的类、方法或字段上添加@Autowired注解,Spring容器会在运行时自动将Environment对象注入到这些地方。

  3. 通过ApplicationContext对象的getEnvironment()方法:由于ApplicationContext是SpringBoot应用的上下文环境,它提供了丰富的功能,包括获取Environment对象。因此,我们可以通过ApplicationContext的getEnvironment()方法来获取到当前的Environment对象。

获取到Environment对象后,我们可以利用它提供的多种方法来查询和管理应用的配置信息,包括但不限于:

  1. getProperty(String key):根据提供的属性名称(key)来获取对应的属性值。

  2. containsProperty(String key):判断Environment中是否包含指定名称的属性。

  3. getRequiredProperty(String key):根据属性名称获取属性值,如果指定的属性不存在,则抛出IllegalStateException异常。

  4. getPropertySources():返回当前Environment中所有的属性源(PropertySource)对象,这些属性源包含了应用的配置信息。

  5. getActiveProfiles():返回当前激活的Profile名称列表,Profile是SpringBoot中用于不同环境下应用配置的一种机制。

获取和使用Environment

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class EnvironmentUtil {

    @Autowired
    private Environment environment;

    // 其他方法}
public class UserService {

    public void getUser() {
        // 获取配置文件中的属性值
        String userName = environment.getProperty("user.name");
        System.out.println("User name: " + userName);
    }
}

四、ResourceLoader

简介

ResourceLoader(资源加载器)是Spring框架(包括SpringBoot)中的一个重要接口,它专注于提供加载外部资源的能力。ResourceLoader定义了一种统一的接口,使得加载来自不同来源的资源(如文件、URL、类路径等)变得简单而一致。在SpringBoot应用的开发过程中,开发者通常会遇到DefaultResourceLoaderFileSystemResourceLoader等作为ResourceLoader接口的实现类,它们各自提供了不同的资源加载策略和灵活性,以满足不同的应用场景需求。

ResourceLoader的使用

在SpringBoot应用中,我们可以通过以下几种方式灵活地获取到ResourceLoader对象:

  1. 通过实现ResourceLoaderAware接口:Spring框架允许任何实现了ResourceLoaderAware接口的Bean在初始化时自动注入一个ResourceLoader对象。这使得Bean能够直接访问到用于加载外部资源的ResourceLoader实例。

  2. 通过@Autowired注解:利用Spring的依赖注入功能,我们可以在需要访问ResourceLoader对象的类、方法或字段上使用@Autowired注解。Spring容器在运行时会自动识别这些注解,并将相应的ResourceLoader实例注入到指定的位置。

  3. (注意:通过ApplicationContext对象的getResource()方法并不直接获取ResourceLoader对象):虽然ApplicationContext提供了getResource()方法来加载资源,但它本身并不直接返回ResourceLoader对象。不过,我们可以通过ApplicationContext的某些方法(如getEnvironment()后再通过环境获取ResourceLoader,或者直接利用ApplicationContext的一些高级特性)间接地访问到ResourceLoader的功能。但直接通过ApplicationContext获取ResourceLoader对象更常见的做法是使用上述的第一种或第二种方式。

获取到ResourceLoader对象后,我们可以利用它提供的以下方法来进行资源的加载和访问:

  • getResource(String path):根据提供的资源路径(可以是文件路径、URL、类路径资源等)来加载并返回一个Resource对象,该对象封装了对资源的访问能力。

  • getClassLoader():获取ResourceLoader在加载资源时所使用的类加载器(ClassLoader)。这可以用于需要显式使用类加载器来加载类或其他资源的场景。但请注意,并非所有ResourceLoader实现都会返回有效的类加载器;这取决于具体的实现和资源类型。

 获取和使用ResourceLoader

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.ResourceLoader;
import org.springframework.stereotype.Component;

@Component
public class ResourceLoaderUtil {

    @Autowired
    private ResourceLoader resourceLoader;

    // 其他方法
}


import org.springframework.core.io.Resource;

public class UserService {

    public void getUser() {
        // 加载资源文件
        Resource resource = resourceLoader.getResource("classpath:application.properties");
        System.out.println("Resource: " + resource);
    }
}

五、MessageSource

简介

MessageSource(消息源)是Spring框架(包括SpringBoot)中的一个核心接口,它专注于管理应用的国际化消息。MessageSource接口定义了一套机制,使得开发者能够以统一的方式管理、存储、检索以及格式化国际化消息。在SpringBoot应用中,为了支持消息的国际化,开发者通常会选择ResourceBundleMessageSource或者ReloadableResourceBundleMessageSource作为MessageSource接口的实现类。这两个类分别提供了不同的特性和灵活性,以满足不同应用场景下的国际化需求。ResourceBundleMessageSource基于Java的标准ResourceBundle机制,而ReloadableResourceBundleMessageSource则在此基础上增加了对资源文件热重载的支持,使得在开发过程中可以无需重启应用即可更新国际化消息。

 MessageSource的使用

在SpringBoot应用中,获取MessageSource对象以管理国际化消息,可以采用以下几种优雅且高效的方式:

  1. 通过实现MessageSourceAware接口:允许任何Bean在初始化时自动感知并注入MessageSource对象,这种方式使得国际化消息的访问变得无缝集成。

  2. 利用@Autowired注解:借助Spring的依赖注入特性,通过@Autowired注解可以便捷地在需要的类、字段或方法上注入MessageSource对象,实现国际化消息的灵活访问。

  3. 通过ApplicationContext的getMessageSource()方法:ApplicationContext作为Spring的核心容器,提供了多种实用方法,其中getMessageSource()便允许我们直接获取到MessageSource对象,进而操作国际化消息。

一旦成功获取到MessageSource对象,您便可以利用其强大的功能,通过以下几种getMessage()方法按需检索消息:

  • getMessage(String code):根据提供的消息代码直接检索并返回对应的消息内容。

  • getMessage(String code, Object[] args, String defaultMessage):结合消息代码、参数数组以及默认消息,灵活构建并返回最终的消息内容。这种方式特别适用于需要参数替换的场景。

  • getMessage(String code, Object[] args, Locale locale):在指定Locale(区域设置)的上下文中,根据消息代码和参数数组检索并返回相应的本地化消息内容,是实现国际化消息的核心方法。

获取和使用MessageSource

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.stereotype.Component;

@Component
public class MessageSourceUtil {

    @Autowired
    private MessageSource messageSource;

    // 其他方法
}


import java.util.Locale;

public class UserService {

    public void getUser() {
        // 获取国际化消息
        String message = messageSource.getMessage("user.name", null, Locale.getDefault());
        System.out.println("Message: " + message);
    }
}

Java技术前沿
专注分享Java技术,包括但不限于 SpringBoot,SpringCloud,Docker,消息中间件等。
 最新文章