Spring 中AbstractRefreshableWebApplicationContext

  AbstractRefreshableWebApplicationContext 是 Spring Framework 中用于 Web 应用程序的一个抽象类，位于 org.springframework.web.context.support 包中。它继承自 AbstractRefreshableApplicationContext，主要用于支持 Web 应用程序的上下文管理。

主要功能

1. 刷新上下文: 提供了刷新（refresh）Web 应用上下文的机制。这包括重新加载 bean 定义，重建 bean 实例，并重新初始化 beans。

2. Web 环境支持: 作为抽象类，它为 Web 应用程序提供了特定于 Servlet 的上下文功能，如获取 ServletContext 和相关的 Web 资源。

3. Lifecycle Management: 负责管理 Web 应用程序的生命周期，包括初始化和关闭。

4. 资源解析: 支持从 Web 应用中的资源文件（如 XML 配置文件）加载 bean 定义。

关键方法

以下是 AbstractRefreshableWebApplicationContext 的一些重要方法：

• getServletContext(): 返回关联的 ServletContext，可以用来访问 Servlet 环境中的资源。

• refresh(): 刷新 Web 应用程序上下文，以重新加载所有的 bean 和相关配置。

• getConfigLocations(): 获取上下文配置的位置，用于从特定位置加载配置文件。

• onRefresh(): 框架在刷新时调用的方法，你可以在子类中重写此方法以执行特定的逻辑。

使用示例

  以下是一个简单的示例，展示如何使用 AbstractRefreshableWebApplicationContext 的一个具体实现。

1. 引入 Spring 依赖

  在 Maven 项目的 pom.xml 中添加 Spring 的依赖：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>5.3.20</version>
</dependency>

2. 创建 Bean 类

public class MyService {
    public void serve() {
        System.out.println("Service is running...");
    }
}

3. 创建 XML 配置文件

  在 src/main/webapp/WEB-INF 目录下创建一个 beans.xml 文件，内容如下：

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="myService" class="MyService" />
</beans>

4. 创建 Web 应用上下文

通常，Web 应用的上下文会在 web.xml 中配置，下面是一个基于 Spring 的配置示例，使用 ContextLoaderListener。

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/beans.xml</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>myServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>myServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

5. 在 Servlet 中获取 Bean

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

@WebServlet("/myServlet")
public class MyServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        
        // 获取 WebApplicationContext
        WebApplicationContext context = WebApplicationContextUtils
                .getWebApplicationContext(getServletContext());

        MyService myService = (MyService) context.getBean("myService");
        myService.serve(); // 输出 "Service is running..."
    }
}

结果

当你访问你的 Servlet（例如，/myServlet）时，你将收到以下输出：

Service is running...

注意事项

• Web 环境壳: AbstractRefreshableWebApplicationContext 的具体实现通常应由 Web 容器提供，如 Tomcat、Jetty 等，因此在实际应用中会涵盖容器的生命周期管理。

• 部署: 确保 XML 配置文件正确部署到 WAR 文件的相应路径。

• 现代替代: 尽管 Web 应用中常常使用 XML 配置，但现代 Spring 开发推荐使用基于注解的配置或者 Java 配置类，以便于更好的维护和灵活性。

结论

• AbstractRefreshableWebApplicationContext: 是 Spring 的一个抽象类，专为 Web 应用提供支持，包括 bean 的管理和上下文的刷新。

• 功能全面: 提供了丰富的功能，以支持 Web 环境的开发和管理。

• 事件驱动和资源管理: 结合事件发布与资源访问功能，为开发复杂的 Web 应用程序提供助力。