当前位置：首页 > article >正文

Spring学习笔记_46——@InitBinder

article 2024/11/24 15:28:38

Spring学习笔记_43——@ExceptionHandler
Spring学习笔记_44——@ModelAttribute
Spring学习笔记_45——@ControllerAdvice

@InitBinder

1. 介绍

@InitBinder 是 Spring MVC 框架中的一个注解，用于在控制器（Controller）中初始化 WebDataBinder 对象。

WebDataBinder 是 Spring MVC 用来绑定请求参数到 JavaBean 对象（即模型对象）的工具，同时也支持数据校验和格式化等功能。通过 @InitBinder 注解的方法，开发者可以在请求处理之前对 WebDataBinder 进行自定义配置，比如添加自定义的编辑器（PropertyEditor）或转换器（Converter），或者注册自定义的验证器（Validator）。

2. 场景

数据格式化：当请求参数需要特定的格式化时，比如将字符串转换为日期对象。
数据校验：在绑定请求参数到模型对象之前，对参数进行校验。
自定义属性编辑器：为特定的属性类型提供自定义的编辑器。
数据返回：将服务返回的对象数据格式化成JSON等字符串数据。
处理文件上传：虽然这不是@InitBinder的主要用途，但是可以通过配置来支持文件上传。

3. 源码

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Reflective
public @interface InitBinder {
    
    // String数组类型的属性，用于指定给哪些参数进行绑定
    String[] value() default {}；
}

4. Demo

import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

import java.text.SimpleDateFormat;
import java.util.Date;

@Controller
public class MyController {

    // 使用 @InitBinder 注解的方法
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 注册自定义的日期格式化器
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        dateFormat.setLenient(false);
        binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));
    }

    // 处理表单提交的请求
    @RequestMapping(value = "/submitForm", method = RequestMethod.POST)
    public String submitForm(@ModelAttribute("myForm") MyFormObject formObject) {
        // 处理表单对象
        System.out.println("Form submitted: " + formObject);
        return "resultPage";
    }

    // MyFormObject 是一个简单的 JavaBean，包含日期属性等
    public static class MyFormObject {
        private String name;
        private Date birthDate;

        // getters and setters
        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        public Date getBirthDate() {
            return birthDate;
        }

        public void setBirthDate(Date birthDate) {
            this.birthDate = birthDate;
        }

        @Override
        public String toString() {
            return "MyFormObject{" +
                    "name='" + name + '\'' +
                    ", birthDate=" + birthDate +
                    '}';
        }
    }
}