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

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

# spring  # boot配置DispatcherServlet  # boot  # 配置  # SpringBoot配置嵌入式Servlet容器和使用外置Servlet容器的教程图解  # Spring Boot 中的Servlet简单使用  # spring boot 实现配置多个DispatcherServlet最简单方式  # 多个  # 默认为  # 在这里  # 两种  # 自定义  # 类中  # 的是  # 就会  # 是由  # 中有  # 只需  # 就行  # 并将  # 很重要  # 还有一个  # 只有一个  # 使其  # 作为一个  # 重写  # 要让 

相关文章： 公司门户网站制作公司有哪些,怎样使用wordpress制作一个企业网站？  利用JavaScript实现拖拽改变元素大小  英语简历制作免费网站推荐,如何将简历翻译成英文？  如何在云主机上快速搭建多站点网站？  建站之星安装模板失败：服务器环境不兼容？  相亲简历制作网站推荐大全,新相亲大会主持人小萍萍资料？  如何通过虚拟主机快速搭建个人网站？  Swift开发中switch语句值绑定模式  如何快速上传自定义模板至建站之星？  5种Android数据存储方式汇总  表情包在线制作网站免费,表情包怎么弄？  如何通过万网虚拟主机快速搭建网站？  高防服务器：AI智能防御DDoS攻击与数据安全保障  音响网站制作视频教程,隆霸音响官方网站？  html制作网站的步骤有哪些,iapp如何添加网页？  香港服务器网站测试全流程：性能评估、SEO加载与移动适配优化  成都网站制作报价公司,成都工业用气开户费用？  如何选择靠谱的建站公司加盟品牌？  建站主机选购指南：核心配置优化与品牌推荐方案  seo网站制作优化,网站SEO优化步骤有哪些？  如何快速搭建个人网站并优化SEO？  兔展官网 在线制作,怎样制作微信请帖？  C#怎么创建控制台应用 C# Console App项目创建方法  义乌企业网站制作公司,请问义乌比较好的批发小商品的网站是什么？  建站OpenVZ教程与优化策略：配置指南与性能提升  大学网站设计制作软件有哪些,如何将网站制作成自己app？  制作门户网站的参考文献在哪,小说网站怎么建立？  电影网站制作价格表,那些提供免费电影的网站，他们是怎么盈利的？  制作ppt免费网站有哪些,有哪些比较好的ppt模板下载网站？  如何高效利用200m空间完成建站？  php8.4新语法match怎么用_php8.4match表达式替代switch【方法】  南京网站制作费用,南京远驱官方网站？  网站制作公司广州有几家,广州尚艺美发学校网站是多少？  焦点电影公司作品,电影焦点结局是什么？  高端智能建站公司优选：品牌定制与SEO优化一站式服务  如何在Windows服务器上快速搭建网站？  ,怎么用自己头像做动态表情包？  如何通过VPS建站实现广告与增值服务盈利？  广德云建站网站建设方案与建站流程优化指南  矢量图网站制作软件,用千图网的一张矢量图做公司app首页，该网站并未说明版权等问题，这样做算不算侵权？应该如何解决？  如何选择适配移动端的WAP自助建站平台？  如何在七牛云存储上搭建网站并设置自定义域名？  建站DNS解析失败？如何正确配置域名服务器？  如何在建站之星网店版论坛获取技术支持？  如何选择长沙网站建站模板？H5响应式与品牌定制哪个更优？  哈尔滨网站建设策划,哈尔滨电工证查询网站？  建站之星如何快速生成多端适配网站？  如何在阿里云购买域名并搭建网站？  江苏网站制作公司有哪些,江苏书法考级官方网站？  建站主机功能解析：服务器选择与快速搭建指南