詳解在spring boot中配置多個(gè)DispatcherServlet

發(fā)布時(shí)間：2020-09-27 08:29:17 來(lái)源：腳本之家閱讀：290 作者：JerryL_ 欄目：編程語(yǔ)言

spring boot為我們自動(dòng)配置了一個(gè)開(kāi)箱即用的DispatcherServlet，映射路徑為‘/'，但是如果項(xiàng)目中有多個(gè)服務(wù)，為了對(duì)不同服務(wù)進(jìn)行不同的配置管理，需要對(duì)不同服務(wù)設(shè)置不同的上下文，比如開(kāi)啟一個(gè)DispatcherServlet專(zhuān)門(mén)用于rest服務(wù)。

傳統(tǒng)springMVC項(xiàng)目

在傳統(tǒng)的springMVC項(xiàng)目中，配置多個(gè)DispatcherServlet很輕松，在web.xml中直接配置多個(gè)就行：

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

通過(guò)指定init-param中的contextConfigLocation就能夠?yàn)檫@個(gè)DispatcherServlet指定上下文。

spring boot中注冊(cè)Servlet的兩種方式

但spring boot把tomcat都給隱藏了，更別說(shuō)web.xml了。好在提供了另外的方式配置servlet。

1.@WebServlet注解：

這個(gè)是javaee的注解，是servlet3.0以后提供的。spring boot會(huì)掃描這個(gè)注解，并將這個(gè)注解注解的類(lèi)注冊(cè)到web容器中作為一個(gè)servlet。

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

2.ServletRegistrationBean：

這個(gè)bean是由spring boot提供專(zhuān)門(mén)來(lái)注冊(cè)servlet的，可以象注冊(cè)bean一樣去配置servlet。

  @Bean
  public ServletRegistrationBean restServlet(){
    //注解掃描上下文
    AnnotationConfigWebApplicationContext applicationContext
        = new AnnotationConfigWebApplicationContext();
    //base package
    applicationContext.scan("com.jerryl.rest");
    //通過(guò)構(gòu)造函數(shù)指定dispatcherServlet的上下文
    DispatcherServlet rest_dispatcherServlet
        = new DispatcherServlet(applicationContext);

    //用ServletRegistrationBean包裝servlet
    ServletRegistrationBean registrationBean
        = new ServletRegistrationBean(rest_dispatcherServlet);
    registrationBean.setLoadOnStartup(1);
    //指定urlmapping
    registrationBean.addUrlMappings("/rest/*");
    //指定name，如果不指定默認(rèn)為dispatcherServlet
    registrationBean.setName("rest");
    return registrationBean;
  }

其中需要注意的是registration.setName("rest")，這個(gè)語(yǔ)句很重要，因?yàn)閚ame相同的ServletRegistrationBean只有一個(gè)會(huì)生效，也就是說(shuō)，后注冊(cè)的會(huì)覆蓋掉name相同的ServletRegistrationBean。

如果不指定，默認(rèn)為“dispatcherServlet”而spring boot提供的DispatcherServlet的name就是“dispatcherServlet”。可以在spring boot的DispatcherServletAutoConfiguration類(lèi)中找到：

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

所以為了不覆蓋默認(rèn)的dispatcherServlet，必須指定一個(gè)別的名稱(chēng)。

同時(shí)，在自定義的DispathcerServlet綁定的配置類(lèi)上，要配置報(bào)掃描的話(huà)，必須要加上@EnableWebMvc注解，不然不會(huì)掃描@Contrller注解。

package com.jerryl.rest;

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

屏蔽rest服務(wù)DispatcherServlet對(duì)靜態(tài)資源的訪問(wèn)

最后還有一個(gè)小問(wèn)題，因?yàn)橄胱岊~外配置的一個(gè)DispatcherServlet專(zhuān)門(mén)用于提供rest服務(wù)，但是這樣配置之后，訪問(wèn)localhost/rest/時(shí)會(huì)訪問(wèn)到頁(yè)面等靜態(tài)資源，感覺(jué)怪怪的。
因?yàn)閟pring boot默認(rèn)是對(duì)靜態(tài)資源做了映射的，但如果不想要訪問(wèn)到任何靜態(tài)的資源，可以修改這個(gè)映射。

兩種方式：

1.在application.yml中配置：

spring:

 mvc:
  #默認(rèn)為/**
  static-path-pattern: /**
 resources:
  #默認(rèn)為classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/ 。配置多個(gè)路徑，中間用逗號(hào)隔開(kāi)。
  static-locations:

如果在這里配置，就會(huì)影響整個(gè)springboot項(xiàng)目。但默認(rèn)的DispatcherServlet是需要訪問(wèn)靜態(tài)資源的，所以不能在這里配置。

2.繼承WebMvcConfigurerAdapter的java類(lèi)中配置：

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

重寫(xiě)addResourceHandlers方法，只指定resourceHandler，不指定resourceLocation，這樣寫(xiě)就能夠使其攔截掉所有對(duì)靜態(tài)資源的訪問(wèn)，并且不會(huì)返回任何靜態(tài)資源。這里的配置是可指定的，只需要讓負(fù)責(zé)rest服務(wù)的DispatcherServlet的上下文掃描這個(gè)配置類(lèi)就可以了。不會(huì)影響默認(rèn)的DispatcherServlet。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。

向AI問(wèn)一下細(xì)節(jié)

詳解在spring boot中配置多個(gè)DispatcherServlet

猜你喜歡

最新資訊

相關(guān)推薦

相關(guān)標(biāo)簽