Spring MVC学习笔记,讲解了底层实现原理和具体实现步骤。
Spring MVC简介
什么springMVC?
Spring框架的一个子模块,用于实现MVC设计模式。SpringMVC是目前最好的实现MVC设计模式的框架。
什么是Spring MVC数据绑定?
指通过Spring MVC框架,将HTTP请求中的参数,直接绑定到Handler业务方法的形参列表当中。
什么是RESTful?
RESTful(Representational State Transfer,表述性状态转移)是指一组框架约束条件和原则。如果一个架构符合REST的约束条件和原则,就可以成为RESTful架构。
可以这么理解:每个URL都代表一个资源,通过URL定位资源。(例子:http://xxx.com/1/100123/12)
什么是SpringMVC拦截器?
SpringMVC拦截器通常用于对象执行方法时的拦截(做登录验证,或日志记录等)。和SpringIOC一样。
所需要的JAR包
spring-webmvc
所用到的组件
SpringMVC核心组件:
- DispatcherServlet:前置控制器。
- HandlerMapping:将请求映射到Handler。
- Handler:后端控制器,完成具体业务逻辑。
- HandlerInterceptor:处理器拦截器。
- HandlerExecutionChain:处理器执行链。
- HandlerAdapter:处理器适配器。
- ModelAndView:装载模型数据和视图信息。
- ViewResolver:视图解析器。
Spring MVC具体实现
Spring MVC的两种写法
基于XML配置实现流程
-
导入spring-webmvc和servlet的JAR包
-
在web.xml中配置前置控制器
- 配置文件关联有三种写法
- 不写初始化参数,但是需要在WEB-INF下建立和servlet-name相同名字的xml文件(如SpringMVC-servlet.xml)。
- 定义init-param标签,param-name的值为namespace,值为自定义名字。同时需要在WEB-INF下建立相同名字并且.xml结尾的文件。
- 使用contextConfigLocation配置(如下)
<servlet> <servlet-name>SpringMVC</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!--指定springMVC配置文件的位置。classpath指类路径下--> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:springmvc.xml</param-value> </init-param> </servlet> <!--配置映射--> <servlet-mapping> <!--需要和servlet标签中配置的名称一致--> <servlet-name>SpringMVC</servlet-name> <!--拦截所有请求--> <url-pattern>/</url-pattern> </servlet-mapping>
- 配置文件关联有三种写法
-
新建MyHandler.java文件,控制器的作用,用于处理具体业务逻辑。需要实现Controller(org.springframework.web.servlet.mvc包)接口,并实现handleRequest方法。
package com.qqfh.springmvc; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.ModelAndView; import org.springframework.web.servlet.mvc.Controller; public class SpringTest implements Controller { public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception { ModelAndView modelAndView = new ModelAndView(); modelAndView.addObject("name","TOM"); modelAndView.setViewName("index"); return modelAndView; } }
-
创建index.jsp页面,用于接收数据
<%@ page isELIgnored="false"%> <%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <body> ${name } </body> </html>
-
创建springmvc.xml配置文件,配置handlermapping与请求对应
<?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" 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"> <!-- 配置HandlerMapping,将url请求映射到Handler --> <bean id="handlerMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping"> <!-- 配置mapping --> <property name="mappings"> <props> <!-- 配置/test请求对应的handler --> <prop key="/test">testHandler</prop> </props> </property> </bean> <!-- 配置Handler --> <bean id="testHandler" class="com.qqfh.springmvc.SpringTest"></bean> <!-- 配置视图解析器,将ViewName的值加上前缀后缀,用于找到对应的jsp文件 --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <!-- 配置前缀 --> <property name="prefix" value="/"></property> <!-- 配置后缀 --> <property name="suffix" value=".jsp"></property> </bean> </beans>
-
运行项目。访问http://127.0.0.1/test,会显示“TOM”
基于注解配置实现流程(推荐、常用)
注解和XML方式区别在于,注解方式不需要配置请求到java文件的映射和handler的bean。会简单很多。
区别如下:
- springmvc.xml中无需配置handler和请求映射配置。
- java程序无需实现Controller接口。但是需要把类交给spring ioc管理。
- 使用注解(@RequestMapping)的方式设置请求地址。
第一种写法
web.xml文件内容:
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--指定springMVC配置文件的位置。classpath指类路径下-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:zhujie.xml</param-value>
</init-param>
</servlet>
<!--配置映射-->
<servlet-mapping>
<!--需要和servlet标签中配置的名称一致-->
<servlet-name>SpringMVC</servlet-name>
<!--拦截所有请求-->
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
zhujie.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"
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">
<!-- 开启自动扫描 -->
<context:component-scan base-package="com.qqfh.springmvc"></context:component-scan>
<!-- 配置视图解析器,将ViewName的值加上前缀后缀,用于找到对应的jsp文件 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 配置前缀 -->
<property name="prefix" value="/"></property>
<!-- 配置后缀 -->
<property name="suffix" value=".jsp"></property>
</bean>
</beans>
com.qqfh.springmvc.SpringZhujie.java文件内容:
package com.qqfh.springmvc;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
public class SpringZhujie {
@RequestMapping("/test2")
public ModelAndView zhujie() {
ModelAndView modelAndView = new ModelAndView();
modelAndView.addObject("name","TOM2");
modelAndView.setViewName("index");
return modelAndView;
}
}
index.jsp文件内容
<%@ page isELIgnored="false"%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<body>
${name }
</body>
</html>
第二种写法
和第一种写法相似,在java程序中方法的写法有区别
com.qqfh.springmvc.SpringZhujie.java文件的不同写法:
/*
* Model传值,String进行视图解析
*/
@RequestMapping("/test3")
public String ModelTest(Model model) {
//填充模型数据
model.addAttribute("name","TOM3");
//直接指定逻辑视图
return "index";
}
第三种写法
和第一种写法相似,在java程序中方法的写法有区别,使用了map传递数据
com.qqfh.springmvc.SpringZhujie.java文件的不同写法:
/*
* Map传值,String进行视图解析
*/
@RequestMapping("/test4")
public String MapTest(Map<String,String> map) {
map.put("name", "TOM4");
return "index";
}
Spring MVC指定包扫描流程
- 例如让dispatcher-servlet.xml配置文件中,设置只扫描controller类,不扫描其他类
<!--include-filter表示包含@Controller标注的包,use-default-filers="false"表示不开启全部自动扫描-->
<context:component-scan base-package="com.qqfh.controller" annotation-config="true" use-default-filters="false">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
- 例如设置普通的spring.xml配置文件进行全局扫描,但是不扫描controller类
<!--exclude-filter表示排除@Controller标注的包-->
<context:component-scan base-package="com.qqfh" annotation-config="true">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
Spring MVC全局异常配置流程
当用户访问网站时,发生程序运行时异常,通过这个配置可以实现自定义服务器返回给前端的报错内容。避免了暴露程序内的敏感信息(如包名、数据库语句等)。
- 在common包下创建ExceptionResolver.java类,继承HandlerExceptionResolver接口,重写resolveException方法,填充方法:
//类的上一行添加注释@Slf4j,表示需要使用logback日志 //在类的上一行增加@Component注解,代表该类是spring的一个bean log.error("{} Exeption",httpServletRequest.getRequestURI(),e); //当使用是jackson版本为2.x的时候,可以使用MappingJackson2JsonView ModelAndView modelAndView = new ModelAndView(new MappingJacksonJsonView()); modelAndView.addObject("status",0); modelAndView.addObject("msg","接口异常,详情请查看服务端日志异常信息"); modelAndView.addObject("data",e.toString()); return modelAndView;
- 制造一个运行时错误,前端访问,出现预期的结果则表示完成。
Spring MVC相关知识
Spring MVC底层原理
- 客户端请求被DispatcherServlet接收。
- DispatcherServlet将请求映射到Handler。
3.生成Handler以及HandlerInterceptor。
4.返回HandlerExecutionChain(Handler+HandlerInterceptor)。
5.DispatcherServlet通过HandlerAdapter执行Handler。
6.返回一个ModelAndView。
7.DispatcherServlet通过ViewResolver进行解析。
8.返回填充了模型数据的View,响应给客户端。
Spring MVC数据绑定
Spring MVC数据绑定底层实现流程概述
HandlerAdapter调用HttpMessageConverter组件,将请求中的参数取出后进行类型转换或封装,然后把结果直接赋给Handler业务方法的形参。此时就可以通过Handler业务方法的形参对数据进行处理。
HandlerAdapter > HttpMessageConverter > DataBind > Handler
Spring MVC数据绑定注解说明
注解名称 | 说明 | 使用方法 |
---|---|---|
@ResponseBody | 将返回值响应给客户端 | 在方法上一行添加 |
@RequestBody | 将前台json数据传给指定的形参 | 在方法形参中添加 |
@RequestParam | 给方法的形参指定一个名称,指定的名称是前端对应的name值 | @RequestParam(“id”) |
案例
案例1
接收前台数据的控制层,重点部分代码:
/*
* 单个形参接收数据
*/
//指定访问地址
@RequestMapping(value = "/baseType")
//直接把结果发送到客户端
@ResponseBody
//通过@RequestParam(value = "id")把前端name为id标签的值赋给形参id
public String baseType(@RequestParam(value = "id") int id){
return "id:"+id;
}
/*
* 数组形式接收数据
*/
@RequestMapping(value = "/arrayType")
//直接把结果发送到客户端
@ResponseBody
//接收前端数据数据,通过遍历数组拼接字符串,然后把字符串返回给前端
public String arrayType(String[] name){
StringBuffer sbf = new StringBuffer();
for (String item:name){
sbf.append(item).append(" ");
}
return sbf.toString();
}
/*
* 对象形式接收数据
*/
@RequestMapping(value = "/pojoType")
//定义了一个对象来接收前台的参数,前端name属性值需要与对象中的全局变量名一致
public ModelAndView pojoType(Course course){
//持久层操作
courseDAO.add(course);
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("index");
modelAndView.addObject("courses",courseDAO.getAll());
return modelAndView;
}
/*
* List集合形式接收数据
*/
@RequestMapping(value = "/listType")
//List集合接收参数,CourseList对象中只有一个List<Course> courses对象,前端需要使用courses[0].xxx传值
public ModelAndView listType(CourseList courseList){
for(Course course:courseList.getCourses()){
courseDAO.add(course);
}
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("index");
modelAndView.addObject("courses",courseDAO.getAll());
return modelAndView;
}
/*
* Map集合形式接收数据
*/
@RequestMapping(value = "/mapType")
//Map集合接收参数,CourseList对象中只有一个Map<String,Course> courses对象,前端需要使用courses['one'].xxx传值
public ModelAndView mapType(CourseMap courseMap){
for(String key:courseMap.getCourses().keySet()){
Course course = courseMap.getCourses().get(key);
courseDAO.add(course);
}
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("index");
modelAndView.addObject("courses",courseDAO.getAll());
return modelAndView;
}
/*
* Set集合形式接收数据
*/
@RequestMapping(value = "/setType")
//Set集合接收参数,CourseList对象中只有一个Set<Course> courses对象,前端需要使用courses[0].xxx传值
public ModelAndView setType(CourseSet courseSet){
for (Course course:courseSet.getCourses()){
courseDAO.add(course);
}
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("index");
modelAndView.addObject("courses",courseDAO.getAll());
return modelAndView;
}
案例2
传递json格式的数据,需要以下几个步骤
-
导入jackson-databind的JAR包
-
json需要在spring配置文件中配置消息转换器
<mvc:annotation-driven> <mvc:message-converters> <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"></bean> </mvc:message-converters> </mvc:annotation-driven>
-
前端JSP页面编写,传递数据并接受返回数据,把返回结果在消息框中展示
<script type="text/javascript" src="js/jquery-1.8.3.min.js"></script> <script type="text/javascript"> $(function(){ var course = { "id":"8", "name":"SSM框架整合", "price":"200" }; $.ajax({ url:"jsonType", data:JSON.stringify(course), type:"post", contentType:"application/json;charset=UTF-8", dataType:"json", success:function(data){ alert(data.name+"---"+data.price); } }) }) </script>
-
java接收数据页面
@RequestMapping(value = "/jsonType") //把结果直接返回给客户端 @ResponseBody //@RequestBody表示把JSON格式数据绑定到这个形参中 public Course jsonType(@RequestBody Course course){ course.setPrice(course.getPrice()+100); return course; }
RESTful
RESTful注解说明
注解名称 | 说明 | 使用方法 |
---|---|---|
@PostMapping | 只接收POST(新增)方式请求 | @PostMapping(value = “/add”) |
@GetMapping | 只接收GET(获取)方式请求 | @GetMapping(value = “/getById/{id}”) |
@PathVariable | 把URL中的参数赋值给对应的形参 | @PathVariable(value = “id”) |
@PutMapping | 只接收Put(修改)方式请求 | 在方法的上一行添加 |
@DeleteMapping | 只接收delete(删除)方式请求 | @DeleteMapping(value = “/delete/{id}”) |
RESTful案例
下面案例列举出了GET和PUT方式的处理(其余两种与这两种类似)。
-
在web.xml中配置过滤器,该过滤器用于把POST请求转换为PUT或DELETE请求。如果没有PUT或DELETE请求,可以不需要该过滤器。
<filter> <filter-name>hiddenHttpMethodFilter</filter-name> <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class> </filter> <filter-mapping> <filter-name>hiddenHttpMethodFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
-
创建实体类。
-
创建DAO。
-
创建控制器类。部分内容
/** * 通过id查询课程 */ @GetMapping(value = "/getById/{id}") public ModelAndView getById(@PathVariable(value = "id") int id){ ModelAndView modelAndView = new ModelAndView(); modelAndView.setViewName("edit"); modelAndView.addObject("course",courseDAO.getById(id)); return modelAndView; } /**修改课程 * */ @PutMapping(value = "/update") public String update(Course course){ courseDAO.update(course); return "redirect:/getAll"; }
-
创建前端页面,如果是PUT和DELETE请求,需要在表单中增加一个隐藏的input标签,指定请求方式(form表单中的method可以是post,程序执行时会自动转换成隐藏input中的value值)
<input type="hidden" name="_method" value="PUT"/>
Spring MVC拦截器
SpringMVC拦截器通常用于对象执行方法时的拦截(做登录验证,或日志记录等)。和SpringIOC一样。
Spring MVC拦截器执行过程图解
Spring MVC拦截器配置说明
HandlerIntrceptor接口(配置拦截器需要创建一个类实现该接口,用于拦截后具体做哪些增强操作)
重写方法 | 说明 | 返回值 |
---|---|---|
preHandle() | 这个方法在业务处理器处理请求之前被调用。返回值如果是false,则不会执行拦截的方法 | boolean |
postHandle() | 这个方法在业务处理器处理完请求后,但是Servlet向客户端返回响应前被调用,在该方法中对用户请求request进行处理。 | void |
afterCompletion() | 在所有拦截结束之后执行 | void |
spring.xml中拦截器相关配置
配置名称 | 说明 | 使用示例 |
---|---|---|
mvc:mapping | 创建需要拦截的地址名称 | <mvc:mapping path="/user/**"></mvc:mapping> |
mvc:exclude-mapping | 当使用通配符匹配时,这个标签代表排除指定的path不进行拦截 | <mvc:exclude-mapping path="/manage/user/login.do"/> |
Spring MVC拦截器案例
springmvc的拦截器实现步骤。
-
创建一个LoginInterceptor.java类,实现HandlerInterceptor接口,重写preHandle(之前)、postHandle(之后)和afterCompletion(所有动作之后)方法。该类会对所拦截的请求进行业务处理。
-
(如果是配置在spring.xml文件中,则需要这一步)在spring.xml配置文件中配置mvc节点。
xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation=" http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd"
完整版本
<?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/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
-
在dispatcher-servlet.xml或者spring.xml配置文件中注册拦截器。
<mvc:interceptors> <mvc:interceptor> <!--指定哪些方法的访问地址需要进行拦截--> <mvc:mapping path="/user/search"/> <!--指定拦截后使用该类中的方法进行具体增强--> <bean class="com.qqfh.LoginInterceptor"></bean> </mvc:interceptor> </mvc:interceptors>