springMVC之@InitBinder的用法

一、@InitBinder的作用

@InitBinder从字面意思可以看出这个的作用是给Binder做初始化的，@InitBinder主要用在@Controller中标注于方法上（@RestController也算），表示初始化当前控制器的数据绑定器（或者属性绑定器），只对当前的Controller有效。@InitBinder标注的方法必须有一个参数WebDataBinder。所谓的属性编辑器可以理解就是帮助我们完成参数绑定，然后是在请求到达controller要执行方法前执行！

用法如下：

@InitBinder
private void initBinder(WebDataBinder binder) {
	// 可用于自定义参数校验，然后通过addValidators来进行绑定controller
    binder.addValidators(userValidator);
    // 可用于注册 属性编译器
    binder.registerCustomEditor(String.class,new StringTrimmerEditor(true));
}
1
2
3
4
5
6
7

WebDataBinder到底是干嘛的？

在Servlet中，有一个方法：request.getParameter("paramName")，它会根据key返回一个String类型的数据，从而获取到前端传递过来的请求参数。但是如果我们这样一个一个地去取出Web请求中的所有参数，就会很麻烦。我们知道Java中有对象的概念，那有没有办法将request中的请求参数都自动封装到一个Java对象中呢？为了解决这个问题，SpringMVC中就引入了WebDataBinder的概念。

WebDataBinder的作用是从Web 请求中，把请求里的参数都绑定到对应的JavaBean上！在Controller方法中的参数类型可以是基本类型，也可以是封装后的普通Java类型。若这个普通的Java类型没有声明任何注解，则意味着它的每一个属性都需要到Request中去查找对应的请求参数，而WebDataBinder则可以帮助我们实现从Request中取出请求参数并绑定到JavaBean中。

什么时候用WebDataBinder？

现在我们基本上了解了WebDataBinder的作用，那我们知道通过@InitBinder修饰的可以拿到WebDataBinder，WebDataBinder 其实已经帮我们完成了基本的参数映射，日期类型就是个特殊的。

使用get请求params传date类型，SpringMVC在默认时，是不支持这种类型转换的。此时我们就需要自定义编译器，然后通过binder.registerCustomEditor注册进去。post请求json传参默认是支持yyyy-MM-dd其他格式也会报错的！
当然除此外在日期类型字段上添加@DateTimeFormat(pattern = “yyyy-MM-dd HH:mm:ss”) 也是可以的。

@RestController
public class RequestParamController {

    @GetMapping("/requestParm7")
    public Params requestParm7(Params params) {
        System.out.println(params);
        return params;
    }
}
1
2
3
4
5
6
7
8
9

spring为我们提供了一些默认的属性编辑器，如org.springframework.beans.propertyeditors.CustomDateEditor就是其中一个，我们也可以通过继承java.beans.PropertyEditorSuppotr来根据具体的业务来定义自己的属性编辑器。

除了自定义属性编译器，还可以自定义属性校验器，就是在参数绑定到JavaBean时，做一下校验，看看参数是否符合我们的预期，如果不符合可以抛异常，然后通过binder.addValidators可以添加自定义的属性校验器！

二、数据绑定器

关于Date属性绑定器有两种方案：使用spring提供的CustomDateEditor，另外一种就是自定义PropertyEditorSuppotr。

（1）定义controller并使用@InitBinder注册属性编辑器这里注册的属性编辑器为CustomDateEditor，作用是根据提供的SimpleDateFormat，将输入的字符串数据格式化为Date类型的指定格式数据。

（2）还有一种就是通过实现PropertyEditorSuppotr接口自定义的。

（3）其中StringTrimmerEditor也是PropertyEditorSuppotr的一个子类！作用是去除字符串的前后空格。

@RequestMapping("body")
@RestController
public class RequestBodyController {

    @GetMapping("/test")
    public Params request(Params params) {
        System.out.println(params);
        return params;
    }

    @RequestMapping("/test1")
    public Params test1(@RequestBody Params params) {
        System.out.println(params);
        return params;
    }

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 格式化date方式一：get请求params传参必须传yyyy-MM-dd HH:mm:ss，否则400错误
        // post请求json传参只能传yyyy-MM-dd，如果传其他格式，连这个方法都进不来就400异常了
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        CustomDateEditor dateEditor = new CustomDateEditor(df, true);
        binder.registerCustomEditor(Date.class, dateEditor);

//        // 格式化date方式二，自定义PropertyEditorSupport，然后利用hutool的格式化，DateUtil.parse支持的格式有很多种,这里支持很多种是可以传入任何格式，他都会给你格式化成yyyy-MM-dd HH:mm:ss
		// 日期没有时分秒的时候格式化出来的是2022-10-11 00:00:00
        // 自定义的这种方式对于json传参方式没有效果，压根连方法都不会进入
//        binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {
//            @Override
//            public void setAsText(String text) {
//                System.out.println("1111");
//                // DateUtil.parse是hutool当中的方法，hutool是一个Java工具包
//                setValue(DateUtil.parse(text));
//            }
//        });

		// 格式化string：如果是字符串类型，就去除字符串的前后空格
        binder.registerCustomEditor(String.class,
                new StringTrimmerEditor(true));
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

测试访问：http://localhost:8080/body/test?userName=123&startDate=2022/10/11%2011:11:11&age=1

没有格式化打印出来的日期格式：

post请求json传参测试：

实际开发当中，我们可以采用上面的方式二来格式化params日期传参。针对于json传参我们可以在接参的实体日期字段上添加@JsonFormat(pattern = “yyyy-MM-dd HH:mm:ss”, timezone = “GMT+8”)

三、全局数据绑定器

3.1. 方式一：@ControllerAdvice

上面的的@InitBinder方法只对当前Controller生效，要想全局生效，可以使用@ControllerAdvice。通过@ControllerAdvice可以将对于控制器的全局配置放置在同一个位置，注解了@ControllerAdvice的类的方法可以使用@ExceptionHandler，@InitBinder，@ModelAttribute注解到方法上，这对所有注解了@RequestMapping的控制器内的方法有效。

import cn.hutool.core.date.DateUtil;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.InitBinder;

import java.beans.PropertyEditorSupport;
import java.util.Date;

@ControllerAdvice
public class GlobalControllerAdvice {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.registerCustomEditor(String.class,
                new StringTrimmerEditor(true));

        binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) {
                // DateUtil.parse是hutool当中的方法
                setValue(DateUtil.parse(text));
            }
        });
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

3.2. 方式二：RequestMappingHandlerAdapter

除了使用@ControllerAdvice来配置全局的WebDataBinder，还可以使用RequestMappingHandlerAdapter：

import cn.hutool.core.date.DateUtil;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.support.WebBindingInitializer;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;

import java.beans.PropertyEditorSupport;
import java.util.Date;

@Configuration
public class Config {

    @Bean
    public RequestMappingHandlerAdapter webBindingInitializer(RequestMappingHandlerAdapter requestMappingHandlerAdapter) {
        requestMappingHandlerAdapter.setWebBindingInitializer(new WebBindingInitializer() {
            @Override
            public void initBinder(WebDataBinder binder) {
                binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {
                    @Override
                    public void setAsText(String text) {
                        // DateUtil.parse是hutool当中的方法
                        setValue(DateUtil.parse(text));
                    }
                });

                // 如果是字符串类型，就去除字符串的前后空格
                binder.registerCustomEditor(String.class,
                        new StringTrimmerEditor(true));
            }
        });
        return requestMappingHandlerAdapter;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

如果定义了全局的，但是个别的使用全局的可能满足不了需求，可以使用@InitBinder修饰controller然后就不走全局的了，@InitBinder修饰的controller要优先于全局的！

四、自定义数据校验器

直接实现org.springframework.validation.Validator，该接口只有两个方法，一个是校验是否支持校验的support(Class<?> clazz)方法，一个是进行具体校验的validate(Object target, Errors errors)方法,源码如下：

public interface Validator {
	boolean supports(Class<?> clazz);
	void validate(Object target, Errors errors);
}
1
2
3
4

（1）参数实体类：

import lombok.Data;

@Data
public class User {
    private String userName;
    private Integer age;
}
1
2
3
4
5
6
7

（2）定义一个校验器：

该校验器校验用户录入的userName长度是否大于8，并给出响应的错误信息，错误信息直接设置到errors中，最终会设置到org.springframework.validation.BindingReuslt，在接口中直接定义该对象则会自动注入对象值，从而可以获取到对应的错误信息。

import com.gzl.cn.demo.entity.User;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

@Component
public class UserValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz) {
        // 只支持User类型对象的校验
        return User.class.equals(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        // 校验name是否为空
        // 在static rejectIfEmpty(..)对方法ValidationUtils类用于拒绝该name属性，如果它是null或空字符串
        ValidationUtils.rejectIfEmpty(errors, "userName", "userName不能为空");
        // 校验年龄只能在0-110之间
        User p = (User) target;
        if (p.getAge() < 1) {
            errors.rejectValue("age", "年龄不能小于1");
        } else if (p.getAge() > 110) {
            errors.rejectValue("age", "年龄不能大于110");
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

（3）定义controller，然后通过WebDataBinder添加userValidator参数校验

不管是get请求params传参还是json传参，都可以进行校验

@RestController
@RequestMapping("/valid")
public class ValidatorController {

    @Autowired
    private UserValidator userValidator;

    @InitBinder
    private void initBinder(WebDataBinder binder) {
        binder.addValidators(userValidator);
    }
	// @Validated相当于开启user的校验，BindingResult是校验的结果
    @PostMapping("/saveUser")
    public User signup(@RequestBody @Validated User user, BindingResult result) {
        // 参数校验
        if (result.hasErrors()) {
            List<FieldError> fieldErrors = result.getFieldErrors();
            fieldErrors.forEach(e -> {
                System.out.println(e.getField() + e.getCode());
            });
            throw new IllegalArgumentException("参数输入错误");
        }
        return user;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

（4）测试

五、参数类型转换器

类型转换器也能解决params传日期类型报错的问题，例如如下：

http://localhost:8080/requestParm7?userName=123&age=1&startDate=2022-10-11

这种类型转换对于post的json传参同样是无济于事，根本不会进入这个方法。所以针对于json传参，我建议直接在日期参数上使用@JsonFormat(pattern = “yyyy-MM-dd HH:mm:ss”, timezone = “GMT+8”)

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

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

@Component
public class DateConverter implements Converter<String, Date> {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

    @Override
    public Date convert(String s) {

        if (s != null && !"".equals(s)) {
            try {
                return sdf.parse(s);
            } catch (ParseException e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24