SpringMVC框架是Java开发中最常用的开发框架了,网上关于其配置讲解也是数不胜数, 这次我也整理出来一个最初级的,引用jar包最少的纯净版SpringMVC框架(注: 无数据库配置,下次再加);
新建 maven-web 项目并引入jar包 pom.xml:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.gy.spring</groupId>
<artifactId>spring-mvc</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>spring-mvc Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
<commons.version>2.6</commons.version>
<spring.version>4.3.13.RELEASE</spring.version>
</properties>
<dependencyManagement>
<dependencies>
<!-- 防止Jar包版本冲突 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-framework-bom</artifactId>
<version>${spring.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
</dependency>
<!-- <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version> <exclusions> <exclusion> <groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId> </exclusion> </exclusions> </dependency> -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!-- <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId>
<version>${commons.version}</version> </dependency> -->
<!-- WEB view -->
<!-- <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId>
<version>2.5</version> <scope>provided</scope> </dependency> <dependency>
<groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.0</version>
<scope>provided</scope> </dependency> <dependency> <groupId>javax.el</groupId>
<artifactId>el-api</artifactId> <version>1.0</version> <scope>provided</scope>
</dependency> -->
<!-- JSTL 标签类库 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- JSON bind -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.4</version>
</dependency>
<!-- Upload -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.3</version>
</dependency>
</dependencies>
<build>
<finalName>spring-mvc</finalName>
<!-- jetty运行环境,CMD 该项目目录下 "mvn jetty:run" 启动 -->
<plugins>
<plugin>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-maven-plugin</artifactId>
<version>9.4.8.v20171121</version>
</plugin>
</plugins>
</build>
</project>
2, web.xml: (DispatcherServlet, HTTP请求入口配置)
<?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"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<!-- 2,以上头部分如果为默认的2.3版本则不支持el表达式(可以正常使用),需替换为当前3.0版 -->
<display-name>Spring MVC WEB</display-name>
<!-- 3,Spring应用上下文,理解层次化的ApplicationContext(service,myBatis等配置) -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mybatis.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- 1,Spring WebServlet 初始化配置 -->
<servlet>
<servlet-name>springMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- DispatcherServlet对应上下文配置, 配置为spring-mvc.xml -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springMVC</servlet-name>
<!-- 拦截所有请求 -->
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
根据web.xml配置可以知道文件 spring-mvc.xml 来管理数据请求及视图输出;
3,配置 spring-mvc.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:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
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">
<!--启用Spring基于annotation的DI-->
<context:annotation-config />
<!-- DispatcherServlet上下文,只扫描该包中@Controller标注的bean -->
<context:component-scan base-package="com.gy.spring.mvc.controller">
<context:include-filter type="annotation"
expression="org.springframework.stereotype.Controller" />
</context:component-scan>
<!--
启用 HandlerMapping, HandlerMapping无需配置,SpringMVC默认启用
DefaultAnnotationHandlerMapping annotation-driven HandlerMapping
-->
<!-- 扩充注解驱动,可以将请求参数绑定到控制器参数 -->
<mvc:annotation-driven />
<!-- 静态资源管理 -->
<mvc:resources location="/static/" mapping="/static/**"/>
<!-- 配置视图解析 ViewResolver,可以配置多个,用order属性排序,InternalResourceViewResolver排到最后 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
<property name="prefix" value="/WEB-INF/view/"/>
<property name="suffix" value=".jsp"/>
</bean>
<!-- Upload 启用resolveLazily是为了推迟文件解析,以便捕获文件大小异常 -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<property name="maxUploadSize" value="1048576"/>
<property name="defaultEncoding" value="UTF-8"/>
<property name="resolveLazily" value="true"/>
</bean>
</beans>
到这视图controller部分已经可以启动使用了,不过继续把下面的写完再一块来看;
4, 根据 web.xml 配置 Spring业务(一般为数据库,其他需要整合的框架等) spring-mybatis.xml (名字随便起,必须与web.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:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
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">
<!--启用Spring基于annotation的DI-->
<context:annotation-config />
<!-- DispatcherServlet上下文,只扫描业务包 -->
<context:component-scan base-package="com.gy.spring.mvc.service"/>
</beans>
5, 先来看看项目结构:
项目结构就是这样,现在再来写个简单的controller :
package com.gy.spring.mvc.controller;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.util.FileCopyUtils;
import org.springframework.web.bind.annotation.PathVariable;
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.ResponseBody;
import org.springframework.web.multipart.MultipartFile;
import com.gy.spring.mvc.service.HelloService;
@Controller
@RequestMapping("/hello")
public class HelloController {
private static Log logger = LogFactory.getLog(HelloController.class);
@Autowired
private HelloService helloService;
@RequestMapping("")
public String index() {
return "index";
}
@ResponseBody
@RequestMapping("hello")
public Object hello() {
return helloService.hello();
}
@ResponseBody
@RequestMapping("hello/{id}")
public Object hello(@PathVariable("id")int id) {
SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
HashMap<Object,Object> map = new HashMap<>();
map.put("id", id);
map.put("author","geYang");
map.put("data",sf.format(new Date()));
logger.info(map);
return map;
}
@RequestMapping(value="upload",method=RequestMethod.POST)
public void upload(@RequestParam("file")MultipartFile file,HttpServletResponse response) throws Exception {
if(!file.isEmpty()) {
logger.info("file [name:"+file.getOriginalFilename()+", size:"+file.getSize()+", fileName:"+file.getName()+", type:"+file.getContentType()+"");
FileCopyUtils.copy(file.getInputStream(),response.getOutputStream());
//上传的两种方法:
// FileUtils.copyInputStreamToFile(file.getInputStream(), new File("E:/notes/IMGS/image/xx.jpg"));
// file.transferTo(new File("E:/notes/IMGS/image/xxx.jpg"));
}
}
}
service 接口:
package com.gy.spring.mvc.service;
public interface HelloService {
String hello();
}
service 实现:
package com.gy.spring.mvc.service.impl;
import org.springframework.stereotype.Service;
import com.gy.spring.mvc.service.HelloService;
@Service
public class HelloServiceImpl implements HelloService {
@Override
public String hello() {
return "Hello World!";
}
}
再来个jsp页面(该jsp再view目录下):
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<h1>MVC的核心思想是业务数据的抽取和业务数据的呈现相分离</h1>
<form action="/hello/upload" enctype="multipart/form-data" method="post">
<input name="file" type="file"/>
<input type="submit"/>
</form>
</body>
</html>
注意,要使用 @ResponseBoday 来返回JSON 一定要引用 pom.xml 中的:
<!-- JSON bind -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.4</version>
</dependency>
否则会报错的; 到这已经可以运行项目啦
现在配置就已经完成一部分啦,下来就看看日志输出: log4j.properties (注意引用上面的Jar包哦)
# set log levels
log4j.rootLogger = debug , stdout , D , E
#输出到控制台
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
#输出INFO级别以上的日志
log4j.appender.stdout.Threshold = INFO
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = %d{ABSOLUTE} %5p %c{1}:%L - %m%n
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E:/logs/log.log
log4j.appender.D.Append = true
#输出DEBUG级别以上的日志
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = E:/logs/debug.log
log4j.appender.E.Append = true
#输出ERROR级别以上的日志
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = E:/logs/debug.log
log4j.appender.E.Append = true
接下来就是最关键最重要的 jUint 与 spring 的整合啦(包不能忘):
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
</dependency>
测试基类:
package com.gy.spring.mvc;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:spring-mvc.xml","classpath:spring-mybatis.xml"})
@WebAppConfiguration
public class SpringTest {
public static SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@Before
public void setUp() throws Exception {
System.out.println("测试时间: " + sf.format(new Date()));
}
}
其他测试类继承该类,进行测试:
package com.gy.spring.mvc.service;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import com.gy.spring.mvc.SpringTest;
public class HelloServiceTest extends SpringTest {
@Autowired
private HelloService helloService;
@Test
public void testHello() {
System.out.println(helloService.hello());
}
}
现在就可以进行开发啦, 简单的SpringMVC框架就已经搭建成功啦;
SSM集成已经完善,项目地址: https://gitee.com/ge.yang/spring-demo/tree/master/spring-mvc
后续还会有更多的框架集成配置;