Spring boot 梳理 - Spring boot自動注冊DispatcherServlet

1. spring boot提供的DispatcherServlet的name就是“dispatcherServlet”。
1. 源碼

     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;
     }
   }

    

2. • 首先,DispatcherServlet被作為一個普通Bean被定義和注冊到容器;
3. • 然后,又定義了另外一個ServletRegistrationBean bean用來添加該DispatcherServlet bean到ServletContext;
4. spring boot中注冊Servlet的兩種方式

   1. 1.@WebServlet注解：

      這個是javaee的注解，是servlet3.0以后提供的。spring boot會掃描這個注解，並將這個注解注解的類注冊到web容器中作為一個servlet。

      但是DispatcherServlet並不是自定義的servlet，而是框架提供的servlet，所以此方法不行。

      2.ServletRegistrationBean：

      這個bean是由spring boot提供專門來注冊servlet的，可以象注冊bean一樣去配置servlet。

   2. @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;
      }

       

   3. 其中需要注意的是registration.setName("rest")，這個語句很重要，因為name相同的ServletRegistrationBean只有一個會生效，也就是說，后注冊的會覆蓋掉name相同的ServletRegistrationBean。

      如果不指定，默認為“dispatcherServlet”而spring boot提供的DispatcherServlet的name就是“dispatcherServlet”。可以在spring boot的DispatcherServletAutoConfiguration類中找到

   4. 所以為了不覆蓋默認的dispatcherServlet，必須指定一個別的名稱