在spring boot中配置多個DispatcherServlet

spring boot為我們自動配置了一個開箱即用的DispatcherServlet,映射路徑為‘/’,但是如果項目中有多個服務,為了對不同服務進行不同的配置管理,需要對不同服務設置不同的上下文,比如開啟一個DispatcherServlet專門用于rest服務。

傳統springMVC項目

在傳統的springMVC項目中,配置多個DispatcherServlet很輕松,在web.xml中直接配置多個就行:

    <servlet>
        <servlet-name>restServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring2.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>ModelRestServlet</servlet-name>
        <url-pattern>/service/*</url-pattern>
    </servlet-mapping>

通過指定init-param中的contextConfigLocation就能夠為這個DispatcherServlet指定上下文。

spring boot中注冊Servlet的兩種方式

但spring boot把tomcat都給隱藏了,更別說web.xml了。好在提供了另外的方式配置servlet。
1.@WebServlet注解:
這個是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類中找到:

        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,必須指定一個別的名稱。

同時,在自定義的DispathcerServlet綁定的配置類上,要配置報掃描的話,必須要加上@EnableWebMvc注解,不然不會掃描@Contrller注解。

package com.jerryl.rest;

@Configuration
@ComponentScan("org.activiti.rest.service.api")
@EnableWebMvc
public class Cfg_Rest {
···
}

屏蔽rest服務DispatcherServlet對靜態資源的訪問

最后還有一個小問題,因為想讓額外配置的一個DispatcherServlet專門用于提供rest服務,但是這樣配置之后,訪問localhost/rest/時會訪問到頁面等靜態資源,感覺怪怪的。
因為spring boot默認是對靜態資源做了映射的,但如果不想要訪問到任何靜態的資源,可以修改這個映射。
兩種方式:
1.在application.yml中配置:

spring:
  mvc:
    #默認為/**
    static-path-pattern: /**
  resources:
    #默認為classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/ 。配置多個路徑,中間用逗號隔開。
    static-locations:  

如果在這里配置,就會影響整個springboot項目。但默認的DispatcherServlet是需要訪問靜態資源的,所以不能在這里配置。
2.繼承WebMvcConfigurerAdapter的java類中配置:

@Configuration
@EnableWebMvc
public class Cfg_View extends WebMvcConfigurerAdapter{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**");
    }
}

重寫addResourceHandlers方法,只指定resourceHandler,不指定resourceLocation,這樣寫就能夠使其攔截掉所有對靜態資源的訪問,并且不會返回任何靜態資源。這里的配置是可指定的,只需要讓負責rest服務的DispatcherServlet的上下文掃描這個配置類就可以了。不會影響默認的DispatcherServlet。

參考: http://stackoverflow.com/questions/30670327/spring-boot-with-multiple-dispatcherservlet-each-having-their-own-controllers

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容