Spring boot 梳理 - Spring boot自動註冊DispatcherServlet
阿新 • • 發佈：2018-12-27
- spring boot提供的DispatcherServlet的name就是“dispatcherServlet”。
- 原始碼
public ServletRegistrationBean dispatcherServletRegistration(DispatcherServlet dispatcherServlet) { ServletRegistrationBean registration = new ServletRegistrationBean(dispatcherServlet, new String[]{this.serverProperties.getServletMapping()}); registration.setName(
"dispatcherServlet"); registration.setLoadOnStartup(this.webMvcProperties.getServlet().getLoadOnStartup()); if(this.multipartConfig != null) { registration.setMultipartConfig(this.multipartConfig); } return registration; } } -
- 首先,DispatcherServlet被作為一個普通Bean被定義和註冊到容器;
-
- 然後,又定義了另外一個ServletRegistrationBean bean用來新增該DispatcherServlet bean到ServletContext;
- spring boot中註冊Servlet的兩種方式
-
這個是javaee的註解，是servlet3.0以後提供的。spring boot會掃描這個註解，並將這個註解註解的類註冊到web容器中作為一個servlet。
但是DispatcherServlet並不是自定義的servlet，而是框架提供的servlet，所以此方法不行。
2.ServletRegistrationBean：
這個bean是由spring boot提供專門來註冊servlet的，可以象註冊bean一樣去配置servlet。
-
@Bean public ServletRegistrationBean restServlet(){ //註解掃描上下文 AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext(); //base package applicationContext.scan("com.jerryl.rest"); //通過建構函式指定dispatcherServlet的上下文 DispatcherServlet rest_dispatcherServlet = new DispatcherServlet(applicationContext); //用ServletRegistrationBean包裝servlet ServletRegistrationBean registrationBean = new ServletRegistrationBean(rest_dispatcherServlet); registrationBean.setLoadOnStartup(1); //指定urlmapping registrationBean.addUrlMappings("/rest/*"); //指定name，如果不指定預設為dispatcherServlet registrationBean.setName("rest"); return registrationBean; }
-
其中需要注意的是registration.setName("rest")，這個語句很重要，因為name相同的ServletRegistrationBean只有一個會生效，也就是說，後註冊的會覆蓋掉name相同的ServletRegistrationBean。
如果不指定，預設為“dispatcherServlet”而spring boot提供的DispatcherServlet的name就是“dispatcherServlet”。可以在spring boot的DispatcherServletAutoConfiguration類中找到
- 所以為了不覆蓋預設的dispatcherServlet，必須指定一個別的名稱
-