配置DispatcherServlet
DispatcherServlet是Spring MVC的核心。它負(fù)責(zé)將請(qǐng)求路由到其他的組件中。
按照傳統(tǒng)的方式,像DispatcherServlet這樣的Servlet會(huì)配置在web.xml文件中,這個(gè)文件會(huì)放到應(yīng)用的WAR包里面,當(dāng)然,這是配置DispatcherServlet的方法之一。但是,借助于Servlet3和Spring3.0功能的增強(qiáng),這種方式已經(jīng)不是唯一的方案了。
我們會(huì)使用Java將DispatcherServlet配置在Servlet容器中,而不會(huì)再使用web.xml文件。如下的程序展示了所需的Java類。
public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
//Spring上下文
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[]{RootConfig.class};
}
//servlet上下文
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{WebConfig.class};
}
//DispatcherServlet映射路徑
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
@Configuration
@EnableWebMvc
@ComponentScan("com.ming.web")
public class WebConfig extends WebMvcConfigurerAdapter {
}
@Configuration
@ComponentScan(basePackages = {"com.ming"},
excludeFilters = {
@ComponentScan.Filter(type = FilterType.ANNOTATION, value = EnableWebMvc.class)})
public class RootConfig {
}
要理解上面代碼是如何工作的,我們可能只需知道擴(kuò)展AbstractAnnotationConfigDispatcherServletInitializer的任意類都會(huì)自動(dòng)地配置DispatcherServlet和Spring應(yīng)用上下文,Spring的應(yīng)用上下文會(huì)位于應(yīng)用程序的Servlet上下文中。
AbstractAnnotationConfigDispatcherServletInitializer剖析
在Servlet3.0環(huán)境中,容器會(huì)在類路徑中查找實(shí)現(xiàn)javax.servlet.ServletContainerInitializer接口的類,如果能發(fā)現(xiàn)的話,就會(huì)用它來(lái)配置Servlet容器。
Spring提供了這個(gè)接口的實(shí)現(xiàn),名為SpringServletContainerInitializer,這個(gè)類反過(guò)來(lái)又會(huì)查找實(shí)現(xiàn)WebApplicationInitializer的類并將配置任務(wù)交給他們來(lái)完成。
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
@Override
public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
throws ServletException {
List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();
if (webAppInitializerClasses != null) {
for (Class<?> waiClass : webAppInitializerClasses) {
// Be defensive: Some servlet containers provide us with invalid classes,
// no matter what @HandlesTypes says...
if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
try {
initializers.add((WebApplicationInitializer) waiClass.newInstance());
}
catch (Throwable ex) {
throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
}
}
}
}
if (initializers.isEmpty()) {
servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
return;
}
servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
AnnotationAwareOrderComparator.sort(initializers);
for (WebApplicationInitializer initializer : initializers) {
initializer.onStartup(servletContext);
}
}
}
Spring提供引入了一個(gè)便利的WebApplicationInitializer基礎(chǔ)實(shí)現(xiàn),也就是AbstractAnnotationConfigDispatcherServletInitializer,使用者只需要繼承這個(gè)類,并重寫(xiě)其中需要的方法。當(dāng)應(yīng)用部署到servlet3.0容器中的時(shí)候,容器會(huì)自動(dòng)發(fā)現(xiàn)它,并用它來(lái)配置Servlet上下文。具體如何配置下節(jié)分析。
參考資料
- 《Spring4實(shí)戰(zhàn)》