详解在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。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。