SpringBoot2.x系列教程29--整合SpringMVC之@InitBinder处理请求参数的绑定(一)

本文主要是介绍SpringBoot2.x系列教程29--整合SpringMVC之@InitBinder处理请求参数的绑定(一)，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

SpringBoot2.x系列教程29--整合SpringMVC之@InitBinder处理请求参数的绑定(一)

作者：一一哥

一.Spring请求参数绑定流程

1.请求参数绑定流程

我们在开发的时候，经常会从html，jsp中将请求参数通过request对象传递到后台。可是经常会遇到这么一种情况，那就是传过来的数据到后台后，还要再组装成一种对象的格式。这时候Spring提供的@InitBinder注解就发挥了很大的作用。

2.Spring中请求参数绑定

Spring可以自动将request中的请求参数数据绑定到对象的每个property上，但是只会绑定一些简单数据类型(比如Strings, int, float等)到对应的对象中。可是如果面对复杂的对象，那就要借助PropertyEditor
来帮助我们完成复杂对象的绑定。

PropertyEditor这个接口提供了两个方法，一个是方法是将String类型的值转成property对应的数据类型，另一个方法是将一个property转成String。

3.CustomDateEditor继承关系

4.示例代码

@InitBinder
public void InitBinder(WebDataBinder binder) {//前端传入的时间格式必须是"yyyy-MM-dd"效果!DateFormat df = new SimpleDateFormat("yyyy-MM-dd");CustomDateEditor dateEditor = new CustomDateEditor(df, true);binder.registerCustomEditor(Date.class, dateEditor);
}

二.@InitBinder详解

1.@InitBinder注解简介

@InitBinder作用于@Controller中的方法，表示为当前控制器注册一个属性编辑器，对WebDataBinder进行初始化,且只对当前的Controller有效。

2. @InitBinder执行时机

@InitBinder注解被解析的时机，是其所标注的方法，在该方法被请求执行之前。同时@InitBinder标注的方法是可以多次执行的，也就是说来一次请求就执行一次@InitBinder解析。

3. @InitBinder执行原理

当某个Controller上的第一次请求，由SpringMVC前端控制器匹配到该Controller之后，根据Controller的 class 类型来查找所有标注了@InitBinder注解的方法，并且存入RequestMappingHandlerAdapter里的 initBinderCache 缓存中。等下一次请求执行对应业务方法之前,会先走initBinderCache缓存,而不用再去解析@InitBinder。

三. @InitBinder实现过程

我们先创建一个web程序，过程请参考之前的案例，过程略！

项目结构图:

1. 创建Controller测试接口

package com.yyg.boot.web;import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.bind.support.WebBindingInitializer;
import org.springframework.web.context.request.WebRequest;import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;/*** @Description Description* @Author 一一哥Sun* @Date Created in 2020/3/23*/
@Slf4j
@RestController
public class BindController {@GetMapping(value = "/bind")public Map<String, Object> getFormatData(Date date) throws ParseException {log.warn("date={}", date);Map<String, Object> map = new HashMap<>();map.put("name", "一一哥");map.put("age", 30);map.put("date", date);return map;}}

2. 启动程序进行测试

此时我们在postman中输入地址：
http://localhost:8080/bind?date=2020-09-09

经过测试，发现此时产生400状态码，具体原因是无法将前端传递过来的String类型的时间字符串转换为Date类型！

3. 添加@InitBinder代码，重新测试

我们在上面创建的Controller里面，添加一段新的代码，如下：

/*** @InitBinder标注的方法,只针对当前Controller有效!* 如果没有该方法,则会产生400状态码!* MethodArgumentTypeMismatchException: Failed to convert value of type 'java.lang.String' to required type 'java.util.Date!*/@InitBinderpublic void InitBinder(WebDataBinder binder) {//前端传入的时间格式必须是"yyyy-MM-dd"效果!DateFormat df = new SimpleDateFormat("yyyy-MM-dd");CustomDateEditor dateEditor = new CustomDateEditor(df, true);binder.registerCustomEditor(Date.class, dateEditor);}