用了N久的Spring MVC,却从未自己整理过。最近公司换了新架构,使用了Spring boot。于是利用这次更换开发架构的机会,一并将Spring MVC和Spring boot的知识点统一整理一下。有不对的地方,还请各位大神多多指教。
闲话少说,开干!
首先,一个完整的spring MVC的运行过程是这样的:
首先请求到达dispatcherServlet(可以理解为一个控制器);控制器会找handlerMapping(位于配置文件之中),然后handlerMapping会找到当前的url请求应该交由那个具体的controller处理(即他负责url和controller的一种映射关系);找到映射关系以后就交由响应的Controller(处理器)处理;然后controller就和我的service,dao,model层完成交互,处理得到某个值,然后返回某个视图;然后返回的这个视图,它通过viewResolver来确定,它究竟对应于哪一个视图,是用那种形式返回的;再找到一个视图(View)返回给它。
了解了运行原理,我们知道,配置Spring MVC需要先从dispatchServlet开始。于是,我们先在web.xml文件中配置项目的控制器:
<!-- Spring和mybatis的配置文件 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring.xml</param-value>
</context-param>
<context-param>
<param-name>webAppRootKey</param-name>
<param-value>dzcx_management.root</param-value>
</context-param>
<!-- Spring MVC 核心配置开始 -->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 可以通过contextConfigLocation来自定义SpringMVC配置文件的位置,如不指定,则默认在WEB-INF目录下,名称为[<servlet-name>]-servlet.xml,
此时文件名必须为[<servlet-name>]-servlet.xml,否则会出错-->
<!--以下init-param是自定义SpringMVC的配置文件的位置 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml,classpath:spring-rabbitMq.xml</param-value>
<!--<param-value>classpath:spring-mvc.xml</param-value>-->
</init-param>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
<!-- 拦截设置 -->
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<!-- 此处也可以配置成 *.action 形式 -->
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- Spring MVC 核心配置结束 -->
<welcome-file-list>
<!-- 我的项目是vue做前后端分离的,故而目录显得特别,初始可为【<welcome-file>index.jsp</welcome-file>】 -->
<welcome-file>http://localhost:12016/management-web/index.html</welcome-file>
</welcome-file-list>
【题外话一】关于web.xml文件中的各种标签含义、以及该文件的加载过程,见链接:
https://blog.csdn.net/wangl157/article/details/84635497
配置好web.xml后,我们需要创建一个xml文件,来负责springmvc的配置。因为在web.xml中定义了contextConfigLocation的值为classpath:spring.xml,故而在对应目录下创建一个名为【spring.xml】的Spring配置文件,内容如下:
<!-- 引入属性文件(注入全局properties,jdbc配置解码) -->
<bean class="com.dzcx.commom.EncryptPropertyPlaceHolder">
<property name="location" value="classpath:config.properties"/>
<property name="fileEncoding" value="utf-8"/>
</bean>
<!-- 自动扫描包(不扫描@RestController和@Controller,避免注入两次,在mvc中扫描注入)-->
<context:component-scan base-package="com.dzcx.*">
<context:exclude-filter type="annotation" expression="org.springframework.web.bind.annotation.RestController"/>
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
<import resource="spring-mybatis.xml"/>
【选择性配置】同理,因为配置了初始化用到的contextConfigLocation为classpath:spring-mvc.xml,classpath:spring-rabbitMq.xml,则分别创建spring-mvc.xml文件,内容如下:
<!-- Validation参数验证(必须在mvc中注入才生效!!!) -->
<bean id="methodValidationPostProcessor" class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"></bean>
<!-- 自动扫描包-->
<context:component-scan base-package="com.dzcx.controller" />
<context:component-scan base-package="com.dzcx.ws" />
<aop:aspectj-autoproxy proxy-target-class="true"/>
<!-- 引入属性文件(重新注入全局properties到Controller,否则Controller中使用注解@Value无法获取到配置的值,因为SpringMVC使用的DispatcherServlet,跟Spring ContextLoaderListener是两个不同的容器!) -->
<bean id="configProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<property name="locations">
<list>
<value>classpath:config.properties</value>
</list>
</property>
<property name="fileEncoding" value="UTF-8"/>
</bean>
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer">
<property name="properties" ref="configProperties"/>
</bean>
<!--自动注册DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter 两个bean,是spring MVC为@Controllers分发请求所必须的-->
<mvc:annotation-driven >
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<!-- 配置 objectMapper 为我们自定义扩展后的 CustomMapper -->
<property name="objectMapper">
<bean class="com.dzcx.commom.JacksonConvert">
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>
<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
<!-- 拦截器 -->
<mvc:interceptors>
<!-- 多个拦截器,顺序执行 -->
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="com.dzcx.handler.FileTypeInterceptor" />
</mvc:interceptor>
</mvc:interceptors>
<!-- 静态资源映射 -->
<mvc:resources mapping="/resources/**" location="/resources/" />
<!-- 配置文件上传,如果没有使用文件上传可以不用配置,当然如果不配,那么配置文件中也不必引入上传组件包 -->
<bean id="multipartResolver"
class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 默认编码 -->
<property name="defaultEncoding" value="utf-8" />
<!-- 文件大小最大值 -->
<property name="maxUploadSize" value="10485760000" />
<!-- 内存中的最大值 -->
<property name="maxInMemorySize" value="40960" />
</bean>
【PS:】为了尽可能的通用化,我将一些初期不会用到的标签配置、功能,都一股脑写上了。需要根据具体的业务作甄别,不是一定要配置全。例如下面的消息队列配置:
创建【spring-rabbitMq.xml】,内容如下:
<bean id="propertyConfigurer"
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<list>
<value>classpath:config.properties</value>
</list>
</property>
</bean>
<!--配置connection-factory,指定连接rabbit server参数 -->
<rabbit:connection-factory id="connectionFactory"
host="${rabbitmq.host}" username="${rabbitmq.username}" password="${rabbitmq.password}"
port="${rabbitmq.port}" channel-cache-size="25" />
<bean id="messageConverter" class="com.dzcx.core.support.FastJsonMessageConverter"></bean>
<!--定义rabbit template用于数据的接收和发送 -->
<rabbit:template id="stateGuestCarAmqpTemplate" connection-factory="connectionFactory" exchange="stateGuestCarQueueExchange" message-converter="messageConverter" />
<!--通过指定下面的admin信息,当前producer中的exchange和queue会在rabbitmq服务器上自动生成 -->
<rabbit:admin connection-factory="connectionFactory" />
<!--定义queue -->
<rabbit:queue name="stateGuestCarQueue" />
<bean id="orderStatusChangeMessageListener" class="com.dzcx.listener.OrderStatusChangeMessageListener" />
<bean id="orderStatusChangeMessageListenerContainer" class="org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer">
<property name="queueNames" value="stateGuestCarQueue" />
<property name="connectionFactory" ref="connectionFactory" />
<property name="messageListener" ref="orderStatusChangeMessageListener" />
</bean>