SpringMVC——请求参数绑定

1. 支持的类型

1. 基础类型参数
   包括基本类型和String类型
   要求：要求我们的参数名称必须和控制器中的方法的形参保持一致。（区分大小写）。换句话说就是我们传递过来的参数名必须和我们Cortroller的参数名一致。

2. POJO类型参数
   包括实体类
   要求：表单中的名称必须和POJO的属性名保持一致。且Controller的参数必须是一个POJO

3. 数组和集合类型参数
   包括数组，List结构以及Map结构
   要求：第一种：要求集合类型的请求参数必须在POJO中。在表单中请求参数名称要和POJO中集合属性名称相同。给List集合中的元素赋值，使用下标。
   给Map集合中的元素赋值，使用键值对。
   第二种：接收的参数如果是一个json字符串，那么需要使用注解

image.png

2. 使用自定义转换类

上述我们提到一些没法使用内置参数绑定的方式。这里我们就实践一下使用自定义转换类的方式完成参数绑定。

Step1: 定义一个转换类

/**
 * 自定义字符串toDate转换器
 */
public class StringToDateConverter implements Converter {
    @Override
    public Date convert(String s) {
        DateFormat format = new SimpleDateFormat("yyyy-MM-dd");
        try {
            Date date = format.parse(s);
            return date;
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }
}

Step2：配置转换器

@Configuration
public class ConverterConfig {
    @Autowired
    private RequestMappingHandlerAdapter requestMappingHandlerAdapter;

    @PostConstruct
    public void getconversionService() {
        ConfigurableWebBindingInitializer initializer = (ConfigurableWebBindingInitializer) requestMappingHandlerAdapter.getWebBindingInitializer();
        if (initializer.getConversionService() != null) {
            GenericConversionService genericConversionService = (GenericConversionService) initializer.getConversionService();
            //添加字符串转换为日期类型的字符串
            genericConversionService.addConverter(new StringToDateConverter());
        }
    }
}

3. 介绍一个更常用的修改转换的方式——@InitBinder注解

3.1 简介

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

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

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

3.2 使用

@Controller
public class DemoController{
    /**
     * 将所有日期格式转换为Date对象
     * @param binder
     */
    @InitBinder
    public void initBinder(WebDataBinder binder){
        binder.registerCustomEditor(Date.class, new PropertyEditorSupport(){
            /**
             * 将字符串内容转化为我们提供的类型
             * @param text
             * @throws IllegalArgumentException
             */
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                setValue(DateUtils.praseDate(text));
            }
        });
    }
}

解释一下代码的过程，binder是我们下面会介绍的内容，通过该绑定器（binder），我们这里会注册一个属性编辑器，下图为该属性编辑器的接口结构，这个PropertyEditorSupport为生产该结构的工厂，并且通过设置内部的setAsText（）方法来将文本变成我们需要的内容，这里就是通过将String设置成Date类型。

image.png

3.3 WebDateBinder介绍

这个使用是非常简单的，但是我们应该很好奇这个突然出现在方法中的东西到底是个什么东西对吧？

在servlet中，有一个方法：request.getParameter("paramName"),它会根据key返回一个String类型的数据。

但是如果我们这样一个一个地去取出web中的请求参数，那就会很麻烦。我们知道Java中有对象的概念，那有没有办法将request中的请求参数自动封装到一个Java对象中呢？为了解决这个问题，Spring中引入了WebDataBinder。

3.3.1 WebDateBinder的工作机制

WebDataBinder是用来绑定请求参数到指定的属性编辑器里的。由于前台传到Controller里的值是String类型，当往Java Bean里设置这个值的时候，如果设置的这个属性是个对象，Spring就会去找到对应的编辑器editor进行转换，然后再设置进去！Spring自己提供了大量的实现类，诸如CustomDateEditor,CustomBooleanEditor,CustomNumberEditor等，基本上够我们开始使用。

image.png

点进这些Editor以后，也可以看到他们实现了setAsText方法，和我们的使用很类似。

至于它具体的细节部分，我们这里并不会阐述，有时间的话再看源码理解其中的实现细节吧