spring boot為我們自動(dòng)配置了一個(gè)開箱即用的DispatcherServlet,映射路徑為‘/’章咧,但是如果項(xiàng)目中有多個(gè)服務(wù)怕磨,為了對(duì)不同服務(wù)進(jìn)行不同的配置管理,需要對(duì)不同服務(wù)設(shè)置不同的上下文亲轨,比如開啟一個(gè)DispatcherServlet專門用于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>
通過指定init-param中的contextConfigLocation就能夠?yàn)檫@個(gè)DispatcherServlet指定上下文。
spring boot中注冊(cè)Servlet的兩種方式
但spring boot把tomcat都給隱藏了诊沪,更別說web.xml了养筒。好在提供了另外的方式配置servlet。
1.@WebServlet注解:
這個(gè)是javaee的注解端姚,是servlet3.0以后提供的晕粪。spring boot會(huì)掃描這個(gè)注解,并將這個(gè)注解注解的類注冊(cè)到web容器中作為一個(gè)servlet渐裸。
但是DispatcherServlet并不是自定義的servlet巫湘,而是框架提供的servlet,所以此方法不行昏鹃。
2.ServletRegistrationBean:
這個(gè)bean是由spring boot提供專門來注冊(cè)servlet的尚氛,可以象注冊(cè)bean一樣去配置servlet。
@Bean
public ServletRegistrationBean restServlet(){
//注解掃描上下文
AnnotationConfigWebApplicationContext applicationContext
= new AnnotationConfigWebApplicationContext();
//base package
applicationContext.scan("com.jerryl.rest");
//通過構(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àn)閚ame相同的ServletRegistrationBean只有一個(gè)會(huì)生效载迄,也就是說讯柔,后注冊(cè)的會(huì)覆蓋掉name相同的ServletRegistrationBean。
如果不指定护昧,默認(rèn)為“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;
}
}
所以為了不覆蓋默認(rèn)的dispatcherServlet惋耙,必須指定一個(gè)別的名稱捣炬。
同時(shí)熊昌,在自定義的DispathcerServlet綁定的配置類上,要配置報(bào)掃描的話湿酸,必須要加上@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)資源的訪問
最后還有一個(gè)小問題稿械,因?yàn)橄胱岊~外配置的一個(gè)DispatcherServlet專門用于提供rest服務(wù),但是這樣配置之后冲粤,訪問localhost/rest/時(shí)會(huì)訪問到頁面等靜態(tài)資源美莫,感覺怪怪的。
因?yàn)閟pring boot默認(rèn)是對(duì)靜態(tài)資源做了映射的梯捕,但如果不想要訪問到任何靜態(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)隔開。
static-locations:
如果在這里配置短曾,就會(huì)影響整個(gè)springboot項(xiàng)目寒砖。但默認(rèn)的DispatcherServlet是需要訪問靜態(tài)資源的,所以不能在這里配置嫉拐。
2.繼承WebMvcConfigurerAdapter的java類中配置:
@Configuration
@EnableWebMvc
public class Cfg_View extends WebMvcConfigurerAdapter{
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**");
}
}
重寫addResourceHandlers方法哩都,只指定resourceHandler,不指定resourceLocation婉徘,這樣寫就能夠使其攔截掉所有對(duì)靜態(tài)資源的訪問漠嵌,并且不會(huì)返回任何靜態(tài)資源。這里的配置是可指定的盖呼,只需要讓負(fù)責(zé)rest服務(wù)的DispatcherServlet的上下文掃描這個(gè)配置類就可以了儒鹿。不會(huì)影響默認(rèn)的DispatcherServlet。