爆破专栏丨SpringBoot2.x系列教程之利用InitBinder处理请求参数的绑定(一)_springboot initibinder

前言

我们在开发项目时，前后端之间需要密切配合，才能确保项目的稳定高效。前端通过URL接口给后端传递请求参数，后端根据这些不同的请求参数返回对应的响应信息。那么在这个传参和返回响应信息的过程中，会发生什么事情呢？我们能不能在这个过程中做一些干预操作呢？比如我们要添加一个学生的年龄信息，前端传递过来一个负数作为年龄参数，这个明显不合法，那么后端能不能对这个非法的参数做出一些处理呢？

所以今天 壹哥 就带大家在SpringBoot中，学习一些可以处理请求参数的技巧，确保我们的后端接口更加的安全健壮。

一. SpringMVC请求参数绑定流程

1. 请求参数绑定流程

我们在开发的时候，经常会从html，jsp等页面中将请求参数通过request对象传递到后端。可是经常会遇到这么一种情况，那就是从前端传递过来的数据参数到达后端后，还需要再把该数据参数进行适当的抽取、转换、校验等操作，进而组装成另一种格式的对象。这个转换的工作，可以由SpringMVC提供的@InitBinder注解来完成。

2. SpringMVC中请求参数的绑定

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

PropertyEditor这个接口提供了两个方法，一个方法是将String类型的值转成property对应的数据类型，另一个方法是将一个property属性转成String，如下图所示：

3. CustomDateEditor继承关系

接下来我会结合CustomDateEditor与InitBinder，给大家讲解如何对前端传递过来的日期类型参数进行格式化校验。我们先来看看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详解

在开始今天的内容之前，我先给大家介绍一个@InitBinder注解。

1. @InitBinder注解简介

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

2. @InitBinder执行时机

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

3. @InitBinder执行原理

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

三. @InitBinder实现过程

接下来我们编写一个案例，实现对前端传递过来的日期参数进行格式化校验。

首先我们来创建一个Web程序，创建过程请参考之前的案例，此处略！

1. 创建Controller测试接口

在创建的Web项目中，我创建一个Controller接口，接口方法中可以接受Date类型的参数。

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

Postman中的效果如下所示：

经过测试，发现此时产生400状态码，我们知道产生400状态码的原因是前后端参数不一致，具体就是无法将前端传递过来的String类型的时间字符串转换为Date类型！因为前端是没有Date类型的，前端传递的日期参数只能被理解为String类型，默认情况下是不能把这个String类型的日期数据直接转换为Date类型的。

那怎么解决这个问题呢？

3. 添加@InitBinder代码

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

/**
     * @InitBinder标注的方法,只针对当前Controller有效!
     * 如果没有该方法,则会产生400状态码!
     * MethodArgumentTypeMismatchException: Failed to convert value of type 'java.lang.String' to required type 'java.util.Date!
     */
    @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);
    }

此时完整的Controller类如下图所示：

4. 重启项目进行测试

添加完代码之后，我们把项目重启，然后我们在Postman中重新输入如下地址：http://localhost:8080/bind?date=2020-09-09

Postman的测试效果如下：

可以发现此时前端传递的时间字符串被成功的传递到后端，并且被成功的转换成了Date类型！以上就是@InitBinder的原理及用法！

注意：@InitBinder属于Controller级别的属性编辑器，并不是全局级别(针对所有@Controller)的属性编辑器，也就是一个@InitBinder只对当前所在的Controller有效，对其他Controller是无效的！那如果我们的项目中，有多个Controller中都要进行日期格式转换怎么办呢？请先思考一下。

5. 项目结构图

最终代码结构如下图所示，各位可以参考创建。

需要更多教程，微信扫码即可