Spring集成Web环境
1.1 ApplicationContext应用上下文获取方式
应用上下文对象是通过new ClasspathXmlApplicationContext(spring配置文件)方式获取的,但是每次从容器中获得Bean时都要编写new ClasspathXmlApplicationContext(spring配置文件),这样的弊端是配置文件加载多次,应用上下文对象创建多次。
在Web项目中可以使用ServletContextListener监听Web应用的启动,我们可以在Web应用启动时,就加载Spring的配置文件,创建应用上下文对象ApplicationContext,在将其存储到最大的域servletContext域中,这样就可以在任意位置从域中获得应用上下文ApplicationContext对象了。
1.2 Spring提供获取应用上下文的工具
上面的分析不用手动实现,Spring提供了一个监听器ContextLoaderListener就是对上述功能的封装,该监听器内部加载Spring配置文件,创建应用上下文对象,并存储到ServletContext域中,提供了一个客户端工具WebApplicationContextUtils供使用者获得应用上下文对象。
所以我们需要做的只有两件事:
(1)在web.xml中配置ContextLoaderListener监听器(导入spring-web坐标)
(2)在WebApplicationContextUtils获得应用上下文对象ApplicationContext
1.3 导入Spring集成web的坐标
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>5.2.4.RELEASE</version> </dependency>
1.4 配置ContextLoaderListener监听器
<!--全局初始化参数--> <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:applicationContext.xml</param-value> </context-param> <!--配置监听器--> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener>
1.5 通过工具获得应用上下文对象
package com.spring.web; import com.spring.service.UserService; import org.springframework.context.ApplicationContext; import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.support.WebApplicationContextUtils; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; public class UserServlet extends HttpServlet{ @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { ServletContext servletContext = this.getServletContext(); ApplicationContext webApplicationContext = WebApplicationContextUtils.getWebApplicationContext(servletContext); UserService userService = webApplicationContext.getBean(UserService.class); userService.save(); } }
ContextLoaderListener的作用是什么?
ContextLoaderListener的作用就是启动Web容器时,读取在contextConfigLocation中定义的xml文件,自动装配ApplicationContext的配置信息,并产生WebApplicationContext对象,然后将这个对象放置在ServletContext的属性里,这样我们只要得到Servlet就可以得到WebApplicationContext对象,并利用这个对象访问spring容器管理的bean。
简单来说,就是上面这段配置为项目提供了spring支持,初始化了Ioc容器。
TEST - 可忽略(下面纯粹为了对比 org.springframework.web.context.ContextLoaderListener)
Test - web.xml 配置全局初始化参数
<context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:applicationContext.xml</param-value> </context-param>
TEST - 模拟 ServletContextListener
package com.spring.listener; import org.springframework.context.support.ClassPathXmlApplicationContext; import javax.servlet.ServletContextEvent; import javax.servlet.ServletContext; import javax.servlet.ServletContextListener; public class ContextLoaderListener implements ServletContextListener { @Override public void contextInitialized(ServletContextEvent sce) { //读取web.xml 中的全局参数 ServletContext servletContext = sce.getServletContext(); String contextConfigLocation = servletContext.getInitParameter("contextConfigLocation"); ClassPathXmlApplicationContext app = new ClassPathXmlApplicationContext(contextConfigLocation); //将Spring的应用上下文对象存储到ServletContext域中 servletContext.setAttribute("app", app); System.out.println("设置上下文完成"); } @Override public void contextDestroyed(ServletContextEvent sce) { } }
TEST - web.xml 模拟配置自定义监听器listener
<!--配置自定义监听器--> <listener> <listener-class>com.spring.listener.ContextLoaderListener</listener-class> </listener>
TEST - WebApplicationContextUtils
package com.spring.listener; import org.springframework.context.ApplicationContext; import javax.servlet.ServletContext; public class WebApplicationContextUtils { public static ApplicationContext getWebApplicationContext(ServletContext servletContext) { return (ApplicationContext) servletContext.getAttribute("app"); } }