SpringBoot - @InitBinder注解详解

原创

已于 2022-08-18 16:43:32 修改 · 6.5k 阅读

34 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot

于 2022-08-18 16:37:35 首次发布

本文介绍Spring MVC中@InitBinder注解的作用，如何在控制器方法中进行数据类型转换，特别是日期字符串转Date实例，并探讨其在处理前端传入数据时的局限性。通过示例代码和常见错误，理解如何合理配置基础控制器以实现属性编辑器的复用。

写在前面

@InitBinder注解可以作用在被@Controller注解的类的方法上，表示为当前控制器注册一个属性编辑器，用于对WebDataBinder进行初始化，且只对当前的Controller有效。@InitBinder标注的方法会被多次执行的，也就是说来一次请求就会执行一次@InitBinder注解方法的内容。
A. @InitBinder注解是在其所标注的方法执行之前被解析和执行；
B. @InitBinder的value属性，控制的是模型Model里的KEY，而不是方法名；
C. @InitBinder标注的方法也不能有返回值；
D. @InitBinder对@RequestBody这种基于消息转换器的请求参数是失效的。

应用场景

用于将前端传递过来的数据进行类型转换或者叫属性编辑，如：将前端传递过来的字符串格式的日期数据，转化为DATE类型。

作用范围

@InitBinder是属于Controller级别的属性编辑器，并非全局级别(针对所有Controller)的属性编辑器，也就是一个@InitBinder只对当前所在的Controller有效，对其他Controller无效的，如果项目中有多个Controller中都要进属性编辑怎么办呢？一般我们将@InitBinder标注的方法定义在基础的控制器上，所有具体的Controller继承这个基础的Controller即可。

示例代码

/**
 * WEB层通用数据处理
 * @author ROCKY
 */
public class BaseController {
   
   

    /**
     * 将前端传递过来的日期格式的字符串转化为Date类型，否则无法将数据绑定到实体中。
     * 自定义类型转换器有两种方式：A. implements Converter<String, Date> 或者 B. extends PropertyEditorSupport;
     * 在WebDataBinder对象中，可以设置前缀，可以设置允许、禁止的字段、必填字段以及验证器，可以自定义类型转换器。
     */
    @InitBinder
    public void initBinder(WebDataBinder binder) {
   
   
        // Date 类型转换
        binder.registerCustomEditor