当前位置：首页 > article >正文

“高效开发之路：用Spring MVC构建健壮的企业级应用”

article 2024/11/7 5:19:20

一、SpringMVC框架概念：

（一）概述

SpringMVC是Spring框架的一个模块，Spring和SpringMVC无需中间整合层整合。该模块是一个基于MVC的web框架。
作用：只要需要前后端通信，就需要springMVC帮我完成，前端：客户端，后端：服务端，通信：数据，总结：springMVC完成了客户端与服务器端的数据传输。
两步：
接收客户端发起请求：
请求所携带的参数
响应给客户端处理结果：结果处理数据返回给前端。

（二）SpringMVC的组成：

1.DispatcherServlet（前端控制器）：用于指定客户端请求的拦截策略。
2.HandlerMapping（控制器映射器）：用于查找并返回请求的控制器映射名。
3.HandlerAdaptor（控制器适配器）：用于查找并返回映射名对应的控制器处理类名。
4.ModelandView（视图对象模型）：用于封装数据
5.ViewReslover（视图解析器）：用于解析数据并渲染视图。

（三）SpringMVC的工作流程：

(1).用户发送请求至前端控制器(DispatcherServlet)；

提示：DispatcherServlet的作用：接收请求，调用其它组件处理请求，响应结果，相当于转发器、中央处理器，是整个流程控制的中心

(2).前端控制器(DispatcherServlet)收到请求后调用处理器映射器(HandlerMapping)

处理器映射器(HandlerMapping)找到具体的Controller(可以根据xml配置、注解进行查找)，并将Controller返回给DispatcherServlet；

(3).前端控制器(DispatcherServlet)调用处理器适配器(HandlerAdapter)。处理器适配器经过适配调用具体的Controller；(Controller--> service --> Dao --> 数据库)

Controller执行完成后返回ModelAndView，

提示：Model(模型数据，即Controller处理的结果，Map) View(逻辑视图名，即负责展示结果的JSP页面的名字)

处理器适配器(HandlerAdapter)将controller执行的结果(ModelAndView)返回给前端控制器(DispatcherServlet)；

(4).前端控制器(DispatcherServlet)将执行的结果(ModelAndView)传给视图解析器(ViewReslover)

视图解析器(ViewReslover)根据View(逻辑视图名)解析后返回具体JSP页面

(5).前端控制器(DispatcherServlet)根据Model对View进行渲染（即将模型数据填充至视图中）；

前端控制器(DispatcherServlet)将填充了数据的网页响应给用户。

二、SpringMVC常规开发方式

（一）项目创建：常规的Maven的web项目。

打包方式必须为war包

（二）添加依赖：

（三）配置web.xml：指定拦截策略

（四）配置SpringMVC核心配置文件

（五）添加servlet

三、SpringMVC框架参数绑定机制

（一）概述

项目中引入SpringMVC框架后，所有请求都是由SpringMVC控制（DispatchServlet控制），当客户端发送的请求中包含数据（即请求参数），后端需要处理此数据时，就需要SpringMVC通过参数绑定机制，接收参数。
SpringMVC参数绑定机制包括：
- 基本类型及对应包装和String类型参数绑定
- 自定义类型的参数绑定
- 日期类型参数绑定

（二）原始servlet参数获取方式同样适用于SpringMVC

（三）基本类型及其对应的包装类型和String类型参数绑定

绑定规则：
- 形参名必须与请求的实参名相同。
- 形参类型必与请求的实参名的类型相同，或者是实参值可以转换成的类型。
使用示例：

常见问题：
- 形参名与请求的实参名不同。

- 实参值不能转换成形参的类型

（四）自定义类型参数的绑定

适用情形：
- 1.适用于客户端传递多个参数时，后端可以使用自定义类型参数的绑定，自定义类型可以是Map或者自定义类。
- 2.绑定规则：
  - 如果前端传参为多个参数，后端使用自定义类接收参数时，自定义类的属性名必须与传递的参数必须一致，属性的类型必须与实参类型相同或实参值能够转换成的类型。
    - 使用示例：

- - 如果前端传参为多个参数，后端使用map接收参数时，形参必须使用@RequestParam注解描述。不需要定义|也无法定义map集合中的key,map中的key是前端的实参名，map中的value是前端的实参值。

常见参数绑定错误：
- 传递实参名与属性名不同时：
  - 属性为基本类型时：客户端报500错误，服务端报无效参数异常。
  - 属性为基本类型的包装类型或String类型时：客户端与服务端都不会报错，但无法获取值。
- 传递实参类型无法转换成属性类型时：
  - 客户端报400错误
  - 服务端报如上错误
- 使用map接收参数时为null
  - 前端无报错，后端无异
  - 原因：map参数没有使用@ResquestParam描述。

（五）日期类型参数的绑定

适用情形：当客户端传递实参为Date类型的数据时。
绑定注意事项：
- 1.实参名必须与服务端形参名相同。
- 2.实参日期格式必须服务端日期格式相同。
服务端日期默认格式：
- yyyy/MM/dd hh:mm:ss
常见问题：
- 前端实参名与后端形参名不同时：
  - 无法获取实参值。
- 前后端日期格式不匹配时：
  - 前端：报400错误
  - 后端：org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
  - 解决方式：
    - 方式一：修改前端日期格式为后端默认格式。
    - 方式二：修改后端日期格式：
    - 修改位置：该上述方法必须添加在包含日期形参的controller中。

（六）参数的绑定时常用注解

1.简介：handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类：（主要讲解常用类型）

A、处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable;
B、处理request header部分的注解： @RequestHeader, @CookieValue;
C、处理request body部分的注解：@RequestParam, @RequestBody;
D、处理attribute类型是注解： @SessionAttributes, @ModelAttribute;

2. @PathVariable

当使用@RequestMapping URI template 样式映射时，即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
示例：

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {
    @RequestMapping("/pets/{petId}")
    public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
        // implementation omitted
    }
}

3. @RequestHeader、@CookieValue

@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。
- 示例
  - 这是一个Request 的header部分：
  - Host                    localhost:8080
    Accept                  text/html,application/xhtml+xml,application/xml;q=0.9
    Accept-Language         fr,en-gb;q=0.7,en;q=0.3
    Accept-Encoding         gzip,deflate
    Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7
    Keep-Alive              300

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive) {
//...
}

@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
- 例如有如下Cookie值：
  - JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
- 参数绑定的代码：

    @RequestMapping("/displayHeaderInfo.do")
    public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) {
        //...
    }
}

4. @RequestParam, @RequestBody

@RequestParam
- 用法：
  - A）常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；
  - B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；
  - C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；
- 示例：

@Controller
@RequestMapping("/pets")
@SessionAttributes("pet")
public class EditPetForm {

    // ...
    @RequestMapping(method = RequestMethod.GET)
    public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
        Pet pet = this.clinic.loadPet(petId);
        model.addAttribute("pet", pet);
        return "petForm";
    }

// ...

@RequestBody
- 用法：
  - 该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；
  - 它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。
  - 因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;
- 示例代码：

@RequestMapping(value = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException
{
writer.write(body);
}

5. @SessionAttributes， @ModelAttribute

@SessionAttributes:
- 用途：
  - 该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。
  - 该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；
- 示例：

@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("pet")
public class EditPetForm {
// ...
}

@ModelAttribute
- 该注解有两个用法，一个是用于方法上，一个是用于参数上；
  - 用于方法上时：通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
  - 用于参数上时：用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：
    - A） @SessionAttributes 启用的attribute 对象上；
    - B） @ModelAttribute 用于方法上时指定的model对象；
    - C）上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

示例：

用到方法上@ModelAttribute的示例代码：

// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")

@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}

这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

用在参数上的@ModelAttribute示例代码：

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {

}
首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

6.补充讲解：

问题：在不给定注解的情况下，参数是怎样绑定的？
- 通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现，方法的参数在不给定参数的情况下：
- 若要绑定的对象时简单类型：调用@RequestParam来处理的。
- 若要绑定的对象时复杂类型：调用@ModelAttribute来处理的。
- 这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；

四、SpringMVC实现转发、重定向及响应数据

（一）实现转发

实现步骤：
- 创建Controller并交给Spring管理
  - 注意事项：该类需要使用@Controller注解描述，不能使用@RestController注解描述。
- 创建Servlet使用@RequestMapping注解指定访问路径。
- 通过return 语句指定返回转发页面
  - 指定转发页面格式："forward:requestMappingValue";
    - 其中：requestMappingValue：指的是访问目标页面的Servlet的@RequestMapping的实参。
- 示例：

（二）实现重向

实现步骤：
- 在Spring管理的Controller中，创建Servlet使用@RequestMapping注解指定访问路径。
- 通过return 语句指定返回重定向页面
  - 指定转发页面格式："redirect:requestMappingValue";
    - 其中：requestMappingValue：指的是访问目标页面的Servlet的@RequestMapping的实参。
- 示例：