Spring MVC通過注解完成運行配置，原理你都會嗎？
環境：Spring5.3.26
SpringMVC使用相信大家都會使用，別人項目工程搭建后，你只需負責寫Controller即可，那你是否想過自己能否把環境搭建出來呢？而且還不借助網絡；本篇教大家如何通過注解快速搭建SpringMVC運行環境。
傳統SpringMVC配置
本節：回顧傳統SpringMVC的基本配置原理。
DispatcherServlet需要一個WebApplicationContext(一個普通ApplicationContext的擴展)用于它自己的配置。WebApplicationContext有一個鏈接到ServletContext和它所關聯的Servlet。它還綁定到ServletContext，這樣應用程序就可以在需要訪問WebApplicationContext時使用RequestContextUtils上的靜態方法來查找它。
對于許多應用程序來說，只有一個WebApplicationContext就足夠簡單了。也可以有一個上下文層次結構，其中一個根WebApplicationContext在多個DispatcherServlet(或其他Servlet)實例之間共享，每個實例都有自己的子WebApplicationContext配置。有關上下文層次結構特性的更多信息，請參閱ApplicationContext的附加功能。
根WebApplicationContext通常包含基礎設施bean，例如需要跨多個Servlet實例共享的數據存儲庫和業務服務。這些bean被有效地繼承，并且可以在特定于Servlet的子WebApplicationContext中被重寫(即重新聲明)，該子WebApplicationContext通常包含給定Servlet的本地bean。下圖顯示了這種關系：
web.xml中配置：
<web-app>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/root-context.xml</param-value>
</context-param>
<servlet>
<servlet-name>app1</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/app1-context.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>app1</servlet-name>
<url-pattern>/app1/*</url-pattern>
</servlet-mapping>
</web-app>ContextLoaderListener：該監聽器用來創建Root 容器，該容器就是用來配置基礎的Bean，如DAO，Service等。
DispatcherServlet：對應一個web 容器，也就是子容器。該容器用來配置Controller。在Controller中會應用到Service，那么該子容器就會從父容器中查找相應的Bean。如下父子關系配置：
public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {
protected WebApplicationContext initWebApplicationContext() {
// 獲取父容器，該父容器是在ContextLoaderListener監聽器中創建并保存到ServletContext中
WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(getServletContext());
WebApplicationContext wac = null;
if (this.webApplicationContext != null) {
wac = this.webApplicationContext;
if (wac instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
if (!cwac.isActive()) {
if (cwac.getParent() == null) {
cwac.setParent(rootContext);
}
configureAndRefreshWebApplicationContext(cwac);
}
}
}
if (wac == null) {
// 創建子容器并設置父容器
wac = createWebApplicationContext(rootContext);
}
return wac;
}
}以上就是SpringMVC的基本配置。
Servlet注冊
既然是基于注解的方式配置SpringMVC，那么我們需要先了解Servlet的注冊方式有哪些。
方式1：
web.xml中注冊
<servlet>
<servlet-name>DemoServlet</servlet-name>
<servlet-class>com.pack.servlet.DemoServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>DemoServlet</servlet-name>
<url-pattern>/demo</url-pattern>
</servlet-mapping>方式2：
基于注解方式
@WebServlet(name = "demoServlet", urlPatterns = "/demo")
@WebServlet(value = {"/demo","/demo1"})
@WebServlet(value = "/demo")
@WebServlet("/demo")
public class DemoServlet extends HttpServlet {
// ...
}方式3：
通過SPI技術，這也是今天要使用的方式
Servlet3.0以上的版本開始，可以通過SPI方式注冊Servlet，Filter，Listener三大組件。
第一步：在項目中建立如下文件
META-INF/service/javax.servlet.ServletContainerInitializer文件名：javax.servlet.ServletContainerInitializer
第二步：自定義類實現ServletContainerInitializer
@HandlesTypes({CustomHandler.class})
public class CustomContainerInitializer implements ServletContainerInitializer {
// 這里的set集合就是當前環境中所有CustomHandler的子類
@Override
public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
if (set!=null&&set.size()>0){
set.stream().forEach(cls->{
try {
CustomHandler o = (CustomHandler)cls.newInstance();
o.onStartup();
} catch (Exception e) {
e.printStackTrace();
}
});
}
//注入Servlet
ServletRegistration.Dynamic userServlet = servletContext.addServlet("DemoServlet", DemoServlet.class);
userServlet.addMapping("/demo");
}
}SpringMVC注解配置
接下來就是要使用上面介紹的Servlet注冊方式的第三種方式來實現SpringMVC的注冊。
在Spring中已經提供了相應的實現：
在spring-web包中：
內容：
org.springframework.web.SpringServletContainerInitializer@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
}這里我們只需要實現WebApplicationInitializer接口即可，不過Spring已經為我們定義好了該接口的抽象模版，我們只需繼承該抽象類即可：
public class SpringMVCConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class<?>[] {RootConfig.class} ;
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class<?>[] {WebConfig.class} ;
}
@Override
protected String[] getServletMappings() {
return new String[] {"/"} ;
}
}RootConfig.java
@Configuration
public class RootConfig {
}WebConfig.java
@Configuration
@ComponentScan(basePackages = {"com.pack.controller"})
public class WebConfig {
}測試controller
@RestController
@RequestMapping("/demo")
public class DemoController {
@GetMapping("")
public Object index() {
Map<String, Object> result = new HashMap<>() ;
result.put("code", 0) ;
result.put("data", "你好") ;
return result ;
}
}測試：
只是通過如上配置，SpringMVC環境基本上是可以使用了，但是我們看上面Controller接口，是基于REST full，所以當你訪問該接口時會出現如下錯誤：
這是因為默認情況下RequestMappingHandlerAdapter無法處理，服務器端無法提供與 Accept-Charset 以及 Accept-Language 消息頭指定的值相匹配的響應。
這時候就需要為其配置相應的消息轉換器：
@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
RequestMappingHandlerAdapter adapter = new RequestMappingHandlerAdapter() ;
adapter.getMessageConverters().add(new MappingJackson2HttpMessageConverter()) ;
return adapter ;
}再次方法正常：
完畢！！！
