title: SpringMVC 总结
date: 2022-06-11 02:22:45
tags:
- Spring
categories: - Spring
cover: https://cover.png
feature: false
文章目录
- 1. 配置
- 1.1 MVC 概念
- 1.2 SpringMVC 概念
- 1.3 SpringMVC的特点
- 1.4 配置 web.xml
- 1.5 配置 springmvc-config.xml
- 1.6 控制器
- 1.7 Thymeleaf 页面
- 1.8 工作流程小结
- 2. 视图解析器 ViewResolver
- 2.1 URLBasedViewResolver
- 2.2 InternalResourceViewResolver
- 2.3 FreeMarkerViewResolver
- 3.Spring MVC 执行流程
- 3.1 Spring MVC 常用组件
- 3.1.1 前端控制器 DispatcherServlet
- 3.1.2 处理器映射器 HandlerMapping
- 3.1.3 处理器适配器 HandlerAdapter
- 3.1.4 处理器 Handler
- 3.1.5 视图解析器 View Resolver
- 3.1.6 视图 View
- 3.2 DispatcherServlet 初始化过程
- 3.3 SpringMVC 的执行流程
- 4. RequestMapping 注解
- 4.1 @RequestMapping 注解的功能
- 4.2 @RequestMapping 注解的位置
- 4.3 value 属性
- 4.4 path 属性
- 4.5 name 属性
- 4.6 method 属性
- 4.7 params 属性
- 4.8 headers 属性
- 4.9 consumers 属性
- 4.10 produces 属性
- 4.11 SpringMVC支持ant风格的路径
- 4.12 SpringMVC 支持路径中的占位符
- 5. SpringMVC 获取请求参数
- 5.1 原生 ServletAPI 获取
- 5.2 通过控制器方法的形参获取请求参数
- 5.3 @RequestParam
- 5.4 @RequestHeader
- 5.5 @CookieValue
- 5.6 通过 POJO 获取请求参数
- 5.7 @ModelAttribute
- 5.8 获取请求参数乱码问题
- 6. 域共享数据
- 6.1 使用 ServletAPI 向 request 域对象共享数据
- 6.2 使用 ModelAndView 向 request 域对象共享数据
- 6.3 使用 Model 向 request 域对象共享数据
- 6.4 使用 map 向 request 域对象共享数据
- 6.5 使用 ModelMap 向 request 域对象共享数据
- 6.6 Model、ModelMap、Map 的关系
- 6.7 向 session 域共享数据
- 6.8 向 application(应用)域共享数据
- 7. 视图(转发与重定向)
- 7.1 ThymeleafView
- 7.2 转发视图
- 7.3 重定向视图
- 7.4 视图控制器
- 8. RESTful
- 8.1 RESTful 简介
- 8.2 RESTful 的实现
- 8.3 HiddenHttpMethodFilter
- 9. HttpMessageConverter
- 9.1 @RequestBody
- 9.2 RequestEntity
- 9.3 @ResponseBody
- 9.4 SpringMVC 处理 JSON
- 9.4.1 JSON 概述
- 9.4.2 @ResponseBody 处理 JSON 的步骤
- 9.5 SpringMVC 处理 ajax
- 9.6 @RestController 注解
- 9.7 ResponseEntity
- 9.8 ResponseEntity 和 ResponseBody 的区别
- 10. 文件上传和下载
- 10.1 文件下载
- 10.2 文件上传
- 11. 拦截器、异常处理器
- 11.1 拦截器的配置
- 11.2 拦截器的三个抽象方法
- 11.3 多个拦截器的执行顺序
- 11.4 基于配置的异常处理
- 11.5 基于注解的异常处理
- 12. 注解配置 SpringMVC
- 12.1 创建初始化类,代替 web.xml
- 10.2 创建 SpringConfig 配置类,代替 Spring 的配置文件
- 10.3 创建 WebConfig 配置类,代替 SpringMVC 的配置文件
MVC是一种软件架构的思想,将软件按照模型、视图、控制器来划分
- M:Model,模型层,指工程中的 JavaBean,它负责数据逻辑(业务规则)的处理和实现数据操作(即在数据库中存取数据)
JavaBean 分为两类:- 一类称为实体类 Bean:专门存储业务数据的,如 Student、User 等
- 一类称为业务处理 Bean:指 Service 或 Dao 对象,专门用于处理业务逻辑和数据访问
- V:View,视图层,指工程中的 HTML 或 JSP 等页面,负责格式化数据并把它们呈现给用户,包括数据展示、用户交互、数据验证、界面设计等功能
- C:Controller,控制层,指工程中的 Servlet,负责接收并转发请求,对请求进行处理后,指定视图并将响应结果发送给客户端
MVC 的工作流程:
- 用户通过视图层发送请求到服务器,在服务器中请求被 Controller 接收
- Controller 调用相应的 Model 层处理请求,处理完毕将结果返回到 Controller
- Controller 再根据请求处理的结果找到相应的 View 视图,渲染数据后最终响应给浏览器
- SpringMVC是Spring的一个后续产品,是 Spring 的一个子项目
- SpringMVC 是 Spring 为表述层开发提供的一整套完备的解决方案。在表述层框架历经 Strust、WebWork、Strust2 等诸多产品的历代更迭之后,目前业界普遍选择了SpringMVC 作为 Java EE 项目表述层开发的首选方案
注:三层架构分为表述层(或表示层)、业务逻辑层、数据访问层,表述层表示前台页面和后台 Servlet
1.3 SpringMVC的特点- Spring 家族原生产品,与 IOC 容器等基础设施无缝对接
- 基于原生的Servlet,通过了功能强大的前端控制器DispatcherServlet,对请求和响应进行统一处理
- 表述层各细分领域需要解决的问题全方位覆盖,提供全面解决方案
- 代码清新简洁,大幅度提升开发效率
- 内部组件化程度高,可插拔式组件即插即用,想要什么功能配置相应组件即可
- 性能卓著,尤其适合现代大型、超大型互联网项目要求
- 默认配置方式
此配置作用下,SpringMVC 的配置文件默认位于 WEB-INF 下,默认名称为-servlet.xml,例如,以下配置所对应 SpringMVC 的配置文件位于 WEB-INF 下,文件名为 springMVC-servlet.xml Archetype Created Web Application springMVC org.springframework.web.servlet.DispatcherServlet springMVC / - 扩展配置方式
可通过 init-param 标签设置 SpringMVC 配置文件的位置和名称,通过 load-on-startup 标签设置 SpringMVC 前端控制器 DispatcherServlet 的初始化时间springMVC org.springframework.web.servlet.DispatcherServlet contextConfigLocation classpath:springMVC.xml 1 springMVC / 标签中使用 / 和 xxx 的方式 @RequestMapping("/a?a/target") // @RequestMapping("target") public String toTarget(){ return "target"; }4.12 SpringMVC 支持路径中的占位符- 原始方式:/deleteUser?id=1
- REST 方式:/deleteUser/1
SpringMVC 路径中的占位符常用于 RESTful 风格中,当请求路径中将某些数据通过路径的方式传输到服务器中,就可以在相应的 @RequestMapping 注解的 value 属性中通过占位符 {xxx} 表示传输的数据,再通过 @PathVariable 注解,将占位符所表示的数据赋值给控制器方法的形参
测试路径中的占位符-->/testRest
@RequestMapping("/testRest/{id}/{username}") public String testRest(@PathVariable("id") String id, @PathVariable("username") String username){ System.out.println("id:"+id+",username:"+username); return "success"; } // 最终输出的内容为-->id:1,username:adm5. SpringMVC 获取请求参数 5.1 原生 ServletAPI 获取将 HttpServletRequest 作为控制器方法的形参,此时 HttpServletRequest 类型的参数表示封装了当前请求的请求报文的对象
111
@RequestMapping("/param") public String param(HttpServletRequest request){ String username = request.getParameter("username"); String password = request.getParameter("password"); System.out.println("username:" + username + "password:" + password); return "param"; }5.2 通过控制器方法的形参获取请求参数在控制器方法的形参位置,设置和请求参数同名的形参,当浏览器发送请求,匹配到请求映射时,在 DispatcherServlet 中就会将请求参数赋值给相应的形参
测试获取请求参数-->/testParam
@RequestMapping("/testParam") public String param(String username, String password, String[] hobby){ System.out.println("username:" + username + ",password:" + password + ",hobby" + Arrays.toString(hobby)); return "success"; }- 若请求所传输的请求参数中有多个同名的请求参数,此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数
- 若使用字符串数组类型的形参,此参数的数组中包含了每一个数据
- 若使用字符串类型的形参,此参数的值为每个数据中间使用逗号拼接的结果
@RequestParam 是将请求参数和控制器方法的形参创建映射关系,一共有三个属性:
- value:指定为形参赋值的请求参数的参数名
- required:设置是否必须传输此请求参数,默认值为 true
若设置为 true 时,则当前请求必须传 value 所指定的请求参数,若没有传输该请求参数,且没有设置 defaultValue 属性,则页面报错400:Required String parameter 'xxx' is not present
若设置为 false,则当前请求不是必须传 value 所指定的请求参数,若没有传输,则注解所标识的形参的值为 null - defaultValue:不管 required 属性值为 true 或 false,当 value 所指定的请求参数没有传输或传输的值为 “” 时,则使用默认值为形参赋值
@RequestMapping("/testParam") public String param(@RequestParam(value = "username", required = false, defaultValue = "hehe") String username, @RequestParam("password") String password, @RequestParam("hobby") String[] hobby){ System.out.println("username:" + username + ",password:" + password + ",hobby" + Arrays.toString(hobby)); return "success"; }5.4 @RequestHeader@RequestHeader 是将请求头信息和控制器方法的形参创建映射关系
5.5 @CookieValue
@RequestHeader 注解一共有三个属性:value、required、defaultValue,用法同@RequestParam@CookieValue 是将 Cookie 数据和控制器方法的形参创建映射关系
5.6 通过 POJO 获取请求参数
@CookieValue注解一共有三个属性:value、required、defaultValue,用法同@RequestParam可以在控制器方法的形参位置设置一个实体类类型的形参,此时若浏览器传输的请求参数的参数名和实体类中的属性名一致,那么请求参数就会为此属性赋值
@RequestMapping("/testParam") public String testParam(User user){ System.out.println(user); return "success"; }5.7 @ModelAttribute- @ModelAttribute 注解用于将多个请求参数封装到一个实体对象中,从而简化数据绑定流程,而且自动暴露为模型数据,在视图页面展示时使用
- 而 “通过实体 Bean 接收请求参数” 中只是将多个请求参数封装到一个实体对象,并不能暴露为模型数据(需要使用 model.addAttribute 语句才能暴露为模型数据)
通过 @ModelAttribute 注解接收请求参数适用于 GET 和 POST 提交请求方式,示例代码如下:
@RequestMapping("/login") public String login(@ModelAttribute("user") User user, Model model) { if ("bianchengbang".equals(name) && "123456".equals(pwd)) { model.addAttribute("message", "登录成功"); return "main"; // 登录成功,跳转到 main.jsp } else { model.addAttribute("message", "用户名或密码错误"); return "login"; } }因为模型对象要先于 Controller 方法之前创建,所以被 @ModelAttribute 注解的方法会在 Controller 每个方法执行之前都执行。因此一个 Controller 映射多个 URL 时,要谨慎使用。
5.8 获取请求参数乱码问题解决获取请求参数的乱码问题,可以使用 SpringMVC 提供的编码过滤器CharacterEncodingFilter,但是必须在 web.xml 中进行注册
6.3 使用 Model 向 request 域对象共享数据CharacterEncoding org.springframework.web.filter.CharacterEncodingFilter encoding // 设置请求编码UTF-8 forceResponseEncoding // 设置响应编码true CharacterEncoding ModelAndView mav = new ModelAndView(); //向请求域共享数据 mav.addObject("testScope", "hello,ModelAndView"); //设置视图,实现页面跳转 mav.setViewName("success"); return mav; } @RequestMapping("/testModel") public String testModel(Model model){ model.addAttribute("testScope", "hello,Model"); return "success"; }6.4 使用 map 向 request 域对象共享数据@RequestMapping("/testMap") public String testMap(Map6.5 使用 ModelMap 向 request 域对象共享数据map){ map.put("testScope", "hello,Map"); return "success"; } @RequestMapping("/testModelMap") public String testModelMap(ModelMap modelMap){ modelMap.addAttribute("testScope", "hello,ModelMap"); return "success"; }6.6 Model、ModelMap、Map 的关系Model、ModelMap、Map 类型的参数其实本质上都是 BindingAwareModelMap 类型的
public interface Model{} public class ModelMap extends LinkedHashMap6.7 向 session 域共享数据{} public class ExtendedModelMap extends ModelMap implements Model {} public class BindingAwareModelMap extends ExtendedModelMapP {} 会话域(session scope),限于当前会话,即当前服务器与客户端连接期间,当关闭浏览器或者退出浏览器时,当前会话则失效
@RequestMapping("/testSession") public String testSession(HttpSession session){ session.setAttribute("testSessionScope", "hello,session"); return "success"; }6.8 向 application(应用)域共享数据应用域(application scope),有效于整个服务器启动期间,关闭浏览器或退出都不会失效,在服务器关闭时失效
@RequestMapping("/testApplication") public String testApplication(HttpSession session){ ServletContext application = session.getServletContext(); application.setAttribute("testApplicationScope", "hello,application"); return "success"; }7. 视图(转发与重定向)- SpringMVC 中的视图是 View 接口,视图的作用渲染数据,将模型 Model 中的数据展示给用户
- SpringMVC 视图的种类很多,默认有转发视图(forward:)和重定向视图(redirect:)
- 当工程引入 jstl 的依赖,转发视图会自动转换为 JstlView
- 若使用的视图技术为 Thymeleaf,在 SpringMVC 的配置文件中配置了 Thymeleaf 的视图解析器,由此视图解析器解析之后所得到的是 ThymeleafView
当控制器方法中所设置的视图名称没有任何前缀时,此时的视图名称会被SpringMVC 配置文件中所配置的视图解析器解析,视图名称拼接视图前缀和视图后缀所得到的最终路径,会通过转发的方式实现跳转。控制器类中处理方法的 return 语句默认就是转发实现,只不过实现的是转发到视图。
@RequestMapping("/testHello") public String testHello(){ return "hello"; }处理当前结果:
7.2 转发视图
渲染视图:
获取当前视图:
SpringMVC中默认的转发视图是InternalResourceView
- 转发过程:
客户浏览器发送 HTTP 请求,Web 服务器接受此请求,调用内部的一个方法在容器内部完成请求处理和转发动作,将目标资源发送给客户。在这里转发的路径必须是同一个 Web 容器下的 URL,其不能转向到其他的 Web 路径上,中间传递的是自己的容器内的 request - SpringMVC 中创建转发视图的情况:
当控制器方法中所设置的视图名称以 "forward:" 为前缀时,创建InternalResourceView 视图,此时的视图名称不会被 SpringMVC 配置文件中所配置的视图解析器解析,而是会将前缀 "forward:" 去掉,剩余部分作为最终路径通过转发的方式实现跳转 - 浏览器发送一次请求,地址不变,发生在服务器内部,不能跨域
例如:"forward:/","forward:/employe
@RequestMapping("test") public String test(){ return "forward:toSuccess"; } @RequestMapping("toSuccess") public String toSuccess(Model model){ model.addAttribute("test","testModel"); return "success"; }7.3 重定向视图SpringMVC中默认的重定向视图是RedirectView
- 重定向过程:
客户浏览器发送 HTTP 请求,Web 服务器接受后发送 302 状态码响应及对应新的 location 给客户浏览器,客户浏览器发现是 302 响应,则自动再发送一个新的 HTTP 请求,请求 URL 是新的 location 地址,服务器根据此请求寻找资源并发送给客户 - SpringMVC 中创建重定向视图的情况:
当控制器方法中所设置的视图名称以 "redirect:" 为前缀时,创建 RedirectView 视图,此时的视图名称不会被 SpringMVC 配置文件中所配置的视图解析器解析,而是会将前缀 "redirect:" 去掉,剩余部分作为最终路径通过重定向的方式实现跳转 - 浏览器发送两次请求,地址改变,WEB-INF目录下内容不能被重定向,具有安全性,可以跨域
例如:"redirect:/","redirect:/employee"
@RequestMapping("test") public String test(){ return "redirect:toSuccess"; } @RequestMapping("toSuccess") public String toSuccess(Model model){ model.addAttribute("test","testModel"); return "success"; }7.4 视图控制器当控制器方法中,仅仅用来实现页面跳转,即只需要设置视图名称时,可以将处理器方法使用 view-controller 标签进行表示。
当 SpringMVC 中设置任何一个 view-controller 时,其他控制器中的请求映射将全部失效,此时需要在 SpringMVC 的核心配置文件中设置开启 MVC 注解驱动的标签:
在 Spring MVC 框架中,不管是重定向或转发,都需要符合视图解析器的配置,如果直接转发到一个不需要 DispatcherServlet 的资源,则需要配置静态资源路径
8. RESTful 8.1 RESTful 简介REST:Representational State Transfer,表现层资源状态转移
- 资源
资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念
因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解
与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词
一个资源可以由一个或多个 URI 来标识。URI 既是资源的名称,也是资源在 Web 上的地址。对某个资源感兴趣的客户端应用,可以通过资源的 URI 与其进行交互 - 资源的表述
资源的表述是一段对于资源在某个特定时刻的状态的描述,可以在客户端-服务器端之间转移(交换)
资源的表述可以有多种格式,例如 HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式 - 状态转移
状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的
具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE用来删除资源
REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性
8.3 HiddenHttpMethodFilter
由于浏览器只支持发送 GET 和 POST 方式的请求,SpringMVC 提供了 HiddenHttpMethodFilter 将 POST 请求转换为 DELETE 或 PUT 请求
HiddenHttpMethodFilter 处理 PUT 和 DELETE 请求的条件:
- 当前请求的请求方式必须为 POST
- 当前请求必须传输请求参数 _method
满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数 _method 的值,因此请求参数 _method 的值才是最终的请求方式
在 web.xml 中注册 HiddenHttpMethodFilte
10.2 创建 SpringConfig 配置类,代替 Spring 的配置文件HiddenHttpMethodFilter org.springframework.web.filter.HiddenHttpMethodFilter HiddenHttpMethodFilter @Override protected Class>[] getRootConfigClasses() { return new Class[]{SpringConfig.class}; } @Override protected Class>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; } @Override protected String[] getServletMappings() { return new String[]{"/"}; } @Override protected Filter[] getServletFilters() { CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter(); encodingFilter.setEncoding("UTF-8"); encodingFilter.setForceRequestEncoding(true); HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter(); return new Filter[]{encodingFilter, hiddenHttpMethodFilter}; } } @Configuration public class SpringConfig { // ssm整合之后,Spring 的配置信息写在此类中 }10.3 创建 WebConfig 配置类,代替 SpringMVC 的配置文件@Configuration //扫描组件 @ComponentScan("fan.com.controller") //开启MVC注解驱动 @EnableWebMvc public class WebConfig implements WebMvcConfigurer { //使用默认的servlet处理静态资源 @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { configurer.enable(); } //配置文件上传解析器 @Bean public CommonsMultipartResolver multipartResolver(){ return new CommonsMultipartResolver(); } //配置拦截器 @Override public void addInterceptors(InterceptorRegistry registry) { FirstInterceptor firstInterceptor = new FirstInterceptor(); registry.addInterceptor(firstInterceptor).addPathPatterns(" //配置异常映射 //配置生成模板解析器 @Bean public ITemplateResolver templateResolver() { WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext(); // ServletContextTemplateResolver需要一个ServletContext作为构造参数,可通过WebApplicationContext 的方法获得 ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(webApplicationContext.getServletContext()); templateResolver.setPrefix("/WEB-INF/templates/"); templateResolver.setSuffix(".html"); templateResolver.setCharacterEncoding("UTF-8"); templateResolver.setTemplateMode(TemplateMode.HTML); return templateResolver; } //生成模板引擎并为模板引擎注入模板解析器 @Bean public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) { SpringTemplateEngine templateEngine = new SpringTemplateEngine(); templateEngine.setTemplateResolver(templateResolver); return templateEngine; } //生成视图解析器并未解析器注入模板引擎 @Bean public ViewResolver viewResolver(SpringTemplateEngine templateEngine) { ThymeleafViewResolver viewResolver = new ThymeleafViewResolver(); viewResolver.setCharacterEncoding("UTF-8"); viewResolver.setTemplateEngine(templateEngine); return viewResolver; } }



