Spring和Spring Mvc 5整合详解

小咪咪 2022-01-25 20:11 399阅读 0赞

## Spring和Spring Mvc 5整合详解 ##

### 一、官方主页 ###

[Spring][]

[Spring Mvc][]

低版本的SpringMvc，可以参考这一篇[《Spring和Spring Mvc整合详解》][Spring_Spring Mvc]

### 二、概述 ###

Spring Mvc的启动方式不同于Spring Boot，Spring Boot内嵌了tomcat容器，可以打包成jar文件快速启动。Spring Mvc仍需要打包成war包。所以，它是离不开web.xml配置。

配置Spring和Spring Mvc，主要有：

*  1.在web.xml中配置好Spring相关Listener/Filter/Servlet，并指明Spring和Spring Mvc的配置文件，当然，也可以不指定，放在classpath下就行，严谨一点还是写出来为好。
 *  2.配置applicationContext.xml，这个是给Spring用的，名字随意，只要在web.xml指定就行。
 *  3.配置 spring-servlet.xml，这个是给Spring Mvc用的，名字随意，只要在web.xml指定就行。

Git地址：  
[Gitee][]

项目地址：  
[品茗IT-同步发布][IT-]

[品茗IT][IT] 提供在线支持：

[一键快速构建Spring项目工具][Spring 1]

[一键快速构建SpringBoot项目工具][SpringBoot]

[一键快速构建SpringCloud项目工具][SpringCloud]

[一站式Springboot项目生成][Springboot]

**如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以[加入我们的java学习圈，点击即可加入][java]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

### 三、开始搭建 ###

#### 3.1 依赖Jar包 ####

<?xml version="1.0"?>
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>cn.pomit</groupId>
    		<artifactId>SpringWork</artifactId>
    		<version>0.0.1-SNAPSHOT</version>
    	</parent>
    	<artifactId>Web</artifactId>
    	<packaging>war</packaging>
    	<name>Web</name>
    	<url>http://maven.apache.org</url>
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-core</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-webmvc</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.apache.logging.log4j</groupId>
    			<artifactId>log4j-api</artifactId>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.apache.logging.log4j</groupId>
    			<artifactId>log4j-core</artifactId>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.apache.logging.log4j</groupId>
    			<artifactId>log4j-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>com.fasterxml.jackson.core</groupId>
    			<artifactId>jackson-annotations</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>com.fasterxml.jackson.core</groupId>
    			<artifactId>jackson-core</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>com.fasterxml.jackson.core</groupId>
    			<artifactId>jackson-databind</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>cn.pomit</groupId>
    			<artifactId>Ehcache</artifactId>
    			<version>${project.version}</version>
    		</dependency>
    	</dependencies>
    	<build>
    		<finalName>Web</finalName>
    	</build>
    </project>

父pom管理了所有依赖jar包的版本，地址：  
[https://www.pomit.cn/spring/SpringWork/pom.xml][https_www.pomit.cn_spring_SpringWork_pom.xml]

#### 3.2 web.xml ####

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
    	<display-name>springwork-main</display-name>
    	<listener>
    		<listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
    	</listener>
    
    	<filter>
    		<filter-name>log4jServletFilter</filter-name>
    		<filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
    	</filter>
    	<filter-mapping>
    		<filter-name>log4jServletFilter</filter-name>
    		<url-pattern>/*</url-pattern>
    		<dispatcher>REQUEST</dispatcher>
    		<dispatcher>FORWARD</dispatcher>
    		<dispatcher>INCLUDE</dispatcher>
    		<dispatcher>ERROR</dispatcher>
    	</filter-mapping>
    	<listener>
    		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    	</listener>
    	<context-param>
    		<param-name>contextConfigLocation</param-name>
    		<param-value>classpath:applicationContext.xml</param-value>
    	</context-param>
    	<filter>
    		<filter-name>characterEncodingFilter</filter-name>
    		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    		<init-param>
    			<param-name>encoding</param-name>
    			<param-value>UTF-8</param-value>
    		</init-param>
    		<init-param>
    			<param-name>forceEncoding</param-name>
    			<param-value>true</param-value>
    		</init-param>
    	</filter>
    	<filter-mapping>
    		<filter-name>characterEncodingFilter</filter-name>
    		<url-pattern>/*</url-pattern>
    	</filter-mapping>
    
    	
    
    
    
    
    
    
    
    
    
    	<servlet>
    		<servlet-name>springDispatcherServlet</servlet-name>
    		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    		<init-param>
    			<param-name>contextConfigLocation</param-name>
    			<param-value>classpath:spring-servlet.xml</param-value>
    		</init-param>
    		<load-on-startup>1</load-on-startup>
    	</servlet>
    	<servlet-mapping>
    		<servlet-name>springDispatcherServlet</servlet-name>
    		<url-pattern>/</url-pattern>
    	</servlet-mapping>
    	<welcome-file-list>
    		<welcome-file>index.html</welcome-file>
    	</welcome-file-list>
    </web-app>

#### 3.3 Spring配置 ####

applicationContext.xml是Spring的配置文件。

applicationContext.xml:

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    
    	<context:annotation-config />
    	<context:component-scan base-package="cn.pomit.springwork">
    	</context:component-scan>
    	
    	<import resource="classpath*:spring-mybatis.xml"/>
    	<import resource="classpath*:spring-ehcache.xml"/>
    </beans>

这个配置文件里可以写入一些bean的配置。

Spring是一个大的父容器，Spring Mvc是其中的一个子容器。父容器不能访问子容器对象，但是子容器可以访问父容器对象。 因此，bean的配置要写到这个文件中，而不是Spring Mvc的配置文件中。

#### 3.4 Spring Mvc配置 ####

spring-servlet.xml是Springmvc的配置文件

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    
    	<context:annotation-config />
    	<context:component-scan base-package="cn.pomit.springwork" use-default-filters="false">
    		<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" />
    		<context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.RestController" />
    	</context:component-scan>
    	<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    		<property name="prefix" value="" />
    	</bean>
    
    
    	<mvc:annotation-driven>
    		<mvc:message-converters>
    			<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    				<property name="supportedMediaTypes">
    					<list>
    						<value>application/json;charset=UTF-8</value>
    					</list>
    				</property>
    			</bean>
    		</mvc:message-converters>
    	</mvc:annotation-driven>
    
    	<mvc:resources location="/img/" mapping="/img/**" />
    	<mvc:resources location="/css/" mapping="/css/**" />
    	<mvc:resources location="/js/" mapping="/js/**" />
    	<mvc:default-servlet-handler/>
    </beans>

**<context:include-filter>**:

*  这里是配置Spingmvc只扫描Controller和RestController注解，避免和Spring扫描过程冲突。
 *  惨痛教训：不隔离开两个包扫描的过程，会导致@Scheduled注解执行两次，而且注解使用的缓存会失效。

#### 3.5 log4j配置 ####

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="OFF" monitorInterval="1800">
        <properties>
            <property name="LOG_HOME">D:/log/SpringWorkLog</property>
            <property name="FILE_NAME">SpringWorkLog</property>
        </properties>
     
     
        <Appenders>
            <Console name="Console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            </Console>
     
            <RollingFile name="running-log" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz" immediateFlush="true">
                <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
                <Policies>
                    <TimeBasedTriggeringPolicy />
                    <SizeBasedTriggeringPolicy size="10 MB" />
                </Policies>
                <DefaultRolloverStrategy max="20" />
            </RollingFile>
        </Appenders>
        <Loggers>
     
    
    
    
     
            <Root level="debug">
                   
                <AppenderRef ref="running-log" />
                
                <AppenderRef ref="Console" />
            </Root>
        </Loggers>
    </Configuration>

### 四、测试代码 ###

#### 4.1 简单的Controller ####

WebController:

package cn.pomit.springwork.web.endpoint;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    
    @Controller
    @RequestMapping("/web")
    public class WebController { 
    
    	@RequestMapping(value = "/json", method = {  RequestMethod.GET })
    	public String welCome() { 
    
    		return "redirect:/json.html";
    	}
    }

#### 4.2 简单的RestController ####

RestController提供rest服务，一般都是提供json数据的。

WebRest：

package cn.pomit.springwork.web.endpoint;
    
    import java.util.UUID;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    import cn.pomit.springwork.web.entity.WelEntity;
    
    
    @RestController
    @RequestMapping("/pub")
    public class WebRest { 
    	
    	@RequestMapping(value = "/welCome", method = {  RequestMethod.GET })
    	public WelEntity welCome(@RequestParam(value = "reqType", required = false) String reqType) { 
    		String uuid = UUID.randomUUID().toString();
    		String welMsg = "welcome 程序猿";
    		if(reqType != null && "1000".equals(reqType)){ 
    			welMsg = "welcome 程序媛";
    		}
    		WelEntity welEntity = new WelEntity();
    		welEntity.setUuid(uuid);
    		welEntity.setWelMsg(welMsg);
    		return welEntity;
    	}
    }

详细完整代码，可以访问[品茗IT-博客《Spring和Spring Mvc 5整合详解》][IT-]，也可以在[Spring组件化构建][Spring 1]中选择查看，并下载。

### 快速构建项目 ###

[Spring组件化构建][Spring 1]

喜欢这篇文章么，喜欢就加入我们一起讨论Spring技术吧！  
![品茗IT交流群][IT 1]

[Spring]: https://docs.spring.io/spring/docs/5.0.12.RELEASE/spring-framework-reference/core.html#spring-core
[Spring Mvc]: https://docs.spring.io/spring/docs/5.0.12.RELEASE/spring-framework-reference/web.html#spring-web
[Spring_Spring Mvc]: https://www.pomit.cn/p/168709397528832
[Gitee]: https://gitee.com/ffch/SpringMvcWork/tree/master/Web
[IT-]: https://www.pomit.cn/p/181499739820288
[IT]: https://www.pomit.cn
[Spring 1]: https://www.pomit.cn/java/spring/spring.html
[SpringBoot]: https://www.pomit.cn/java/spring/springboot.html
[SpringCloud]: https://www.pomit.cn/java/spring/springcloud.html
[Springboot]: https://www.pomit.cn/java/java/sqlToSpringboot.html
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[https_www.pomit.cn_spring_SpringWork_pom.xml]: https://www.pomit.cn/spring/SpringWork/pom.xml
[IT 1]: /images/20220126/27b30a2233e54d9fa8962ad29fe8ac2c.png