一.ConfigurableWebBindingInitializer简介

1.概述

在Spring MVC中使用WebBindingInitializer,为每个特殊的请求初始化相应的WebDataBinder。

而在SpringBoot中,则可以通过配置ConfigurableWebBindingInitializer这样的Bean来进行WebDataBinder的设置。

ConfigurableWebBindingInitializer的主要作用就是 初始化WebDataBinder,将请求的参数转化为对应的JavaBean,并且会结合类型、格式转换等API一起使用。

2. 示例代码

查看WebMvcAutoConfiguration.class中的方法源码:

protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer() {
    try {
        //从容器中获取
        return (ConfigurableWebBindingInitializer)this.beanFactory.getBean(ConfigurableWebBindingInitializer.class);
    } catch (NoSuchBeanDefinitionException ex) {
      return super.getConfigurableWebBindingInitializer();
    }
}

可以发现ConfigurableWebBindingInitializer是从容器(beanFactory)中获取到的,所以我们可以配置一个ConfigurableWebBindingInitializer来替换默认的,只需要在容器中添加一个我们自定义的转换器即可。当我们创建了自己的ConfigurableWebBindingInitializer这个Bean,Spring boot就会自动使用它来配置Spring MVC实现参数的类型转换。

二.ConfigurableWebBindingInitializer教程

1. 需求分析

在本案例中,我们还是以时间转换字符串为例,解决web数据绑定问题,把http客户端所传入的字符串类型参数,转换成对象类型。

本案例继续沿用上一章节的案例。我们可以把上一章节中“CustomDateEditorConfiguration”类上面的@Configuration注解注释掉。

springboot 接口请求参数加_springboot 接口请求参数加

这样,原有的全局级别的绑定配置就不生效了。

2. 创建ConfigurableWebBindingInitializer配置bean

其实在Spring Boot中,ConfigurableWebBindingInitializer的使用非常的简单,我们只需要在配置类中,创建一个ConfigurableWebBindingInitializer的bean,就可以自动实现String类型与Date类型之间的转换了。

springboot 接口请求参数加_springboot 接口请求参数加_02

示例代码

package com.yyg.boot.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.support.ConfigurableWebBindingInitializer;

/**
 * @Description ConfigurableWebBindingInitializer的用法,只需要配置这个bean,就可以自动失效Date与String
 * 之间的类型转换了,非常简单.
 * @Author 一一哥Sun
 * @Date Created in 2020/3/24
 */
@Configuration
public class WebDataBindConfig {

    @Bean
    ConfigurableWebBindingInitializer configurableWebBindingInitializer(){
        return new ConfigurableWebBindingInitializer();
    }

}

3. 编写OrderForm实体类

package com.yyg.boot.domain;

import lombok.Data;
import lombok.ToString;

import java.util.Date;

/**
 * @Description Description
 * @Author 一一哥Sun
 * @Date Created in 2020/3/24
 */
@Data
@ToString
public class OrderForm {

    private String id;

    private String userName;

    private Date addTime;

}

4.编写Controller测试接口

我们继续严重之前案例中的Controller接口方法就可以了。

@PostMapping(value = "/order")
public String order(@Valid @RequestBody OrderForm form,BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
        return bindingResult.getFieldError().getDefaultMessage();
    }

    log.warn("order={}",form.toString());
    return "success";
}

5.启动项目测试

在postman中,输入地址:http://localhost:8080/order

传入参数:

{
    "id":1,
    "userName":"一一哥",
    "addTime":1488264066
}

springboot 接口请求参数加_spring_03

springboot 接口请求参数加_类型转换_04

可以看到,实现了前端传递过来的String时间字符串参数,被成功的转换成了Date时间类型。