SpringBoot @InitBinder注解绑定请求参数

已于 2022-12-04 17:39:51 修改
阅读量1.3k 收藏 2
点赞数 2
分类专栏： SpringBoot 文章标签： spring boot
于 2022-12-04 17:21:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/feyehong/article/details/128172035
版权

参考资料

  1. springMVC之@InitBinder 和 Validator
  2. springMVC之@InitBinder的用法1
  3. springMVC之@InitBinder的用法2

目录

一. 作用

作用于Controller层中，在Controller层的方法执行前执行，主要作用是初始化当前Controller层的数据绑定器（或者属性绑定器），帮助完成数据处理和数据绑定。

被该注解修饰的方法会有一个形参WebDataBinder，可以帮我们将request请求中的参数处理绑定到JavaBean中。

在这里插入图片描述

二. 前期准备

import lombok.Data;

import java.math.BigDecimal;
import java.util.Date;

@Data
public class Test16Form {

    private String name;

    private String sex;

    private Date birthday;

    private BigDecimal money;
}

三. Get请求 + URL传值处理

3.1 前台-test16.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div>
    <button id="getBtn">发送get请求</button><br>
</div>
</body>
<script type="text/javascript" th:src="@{/js/public/jquery-3.6.0.min.js}"></script>
<script>
    $("#getBtn").click(function() {
        
        const urlSearchParams = new URLSearchParams();
        // 👉含有空格
        urlSearchParams.append("name", "贾飞天   ");
        urlSearchParams.append("sex", "男");
        // 👉值为yyyy-MM-dd HH:mm:ss格式的日期字符串
        urlSearchParams.append("birthday", "2022-11-11 12:12:12");
        urlSearchParams.append("money", "10000");

        const url = `/test16/receiveGet?${urlSearchParams.toString()}`;
        $.ajax({
            url,
            type: 'GET',
            success: function (data, status, xhr) {
                console.log(data);
            }
        });
    });
</script>
</html>

3.2 Controller层

  • StringTrimmerEditor和CustomDateEditor是框架自带的属性处理器
import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

@Controller
@RequestMapping("/test16")
public class Test16Controller {

    @InitBinder
    public void formBinder(WebDataBinder binder) {

        // 只要是String类型,就去除字符串前后的空格
        binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));

        // 只有当属性名为birthday且为Date类型的才使用使用框架自带的CustomDateEditor编辑器将String处理为Date
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        binder.registerCustomEditor(Date.class, "birthday", new CustomDateEditor(df, true));
    }

    @GetMapping("/init")
    public ModelAndView init() {

        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("test16");
        return modelAndView;
    }

    @GetMapping("/receiveGet")
    @ResponseBody
    public void receiveGet(Test16Form form) {

        System.out.println(form);
    }
}

3.3 效果

  • 字符串两端的空格被去除
  • String格式的日期被转换为Date格式的日期
    在这里插入图片描述

四. Post请求 + 表单传值 + 自定义日期属性绑定器

4.1 前台-test16.html

  • 表单提交的数据若包含List<实体类>这种数据结构
    在前台需要用 form对应的属性名[下标].实体类属性名 这种方式准备数据
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div>
    <button id="postBtn">发送post请求</button><br>
</div>
</body>
<script type="text/javascript" th:src="@{/js/public/jquery-3.6.0.min.js}"></script>
<script>
    $("#postBtn").click(function() {

        const paramObj = {
            name: "贾飞天    ",
            sex: '不明',
            money: "10000",
            // yyyy-MM-dd HH:mm:ss格式
            birthday: '2022-11-11 12:12:12',
            // 后台中的List实体类区域
            "tableList[0].id": 1,
            "tableList[0].address": '测试address    ',
            "tableList[0].hobby": '测试hobby     ',
            // yyyy年MM月dd日 HH:mm:ss格式
            "tableList[0].workDate": '2022年11月11日 14:14:14',
        };

        $.ajax({
            url: `/test16/receivePost`,
            type: 'POST',
            data: paramObj,
            // 表单格式提交
            contentType : 'application/x-www-form-urlencoded;charset=utf-8',
            // 后端返回给前端的数据类型
            dataType: 'json',
            success: function (data, status, xhr) {
                console.log(data);
            }
        });
    });
</script>
</html>

4.2 form实体类

import lombok.Data;

import java.math.BigDecimal;
import java.util.Date;
import java.util.List;

@Data
public class Test16Form {

    private String name;

    private String sex;
	
	// 待转换类型
    private Date birthday;

    private BigDecimal money;

    private List<Test4Entity> tableList;
}

import lombok.Data;
import java.util.Date;

@Data
public class Test4Entity {

    private String id;

    private String address;

    private String hobby;
	
	// 待转换类型
    private Date workDate;
}

4.3 Controller层

  • 我们可以通过PropertyEditorSupport类来实现我们自己的属性编辑器
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Controller;
import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;
import java.beans.PropertyEditorSupport;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

@Controller
@RequestMapping("/test16")
public class Test16Controller {

    @InitBinder
    public void formBinder(WebDataBinder binder) {

        // 只要是String类型,就去除字符串前后的空格
        binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));

        // 自定义日期转换属性处理器
        binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {

            @Override
            public void setAsText(String dateStr) {
                DateFormat dateFormat = null;
                try {
                    if (ObjectUtils.isEmpty(dateStr)) {
                        setValue(dateStr);
                        return;
                    }

                    // yyyy-MM-dd HH:mm:ss格式
                    if (dateStr.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}:\\d{1,2}$")) {
                        dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                    }
                    // yyyy年MM月dd日 HH:mm:ss格式
                    else if (dateStr.matches("^\\d{4}年\\d{1,2}月\\d{1,2}日 {1}\\d{1,2}:\\d{1,2}:\\d{1,2}$")) {
                        dateFormat = new SimpleDateFormat("yyyy年MM月dd日 HH:mm:ss");
                    }

                    if (ObjectUtils.isEmpty(dateFormat)) {
                        setValue(null);
                        return;
                    }

                    Date parse = dateFormat.parse(dateStr);
                    setValue(parse);

                } catch (Exception ex) {
                    setValue(null);
                }
            }
        });
    }

    @GetMapping("/init")
    public ModelAndView init() {

        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("test16");
        return modelAndView;
    }

    @PostMapping("/receivePost")
    @ResponseBody
    public void receivePost(Test16Form form) {
        System.out.println(form);
    }
}

4.4 效果

  • 可以看到 yyyy-MM-dd HH:mm:ss 和 yyyy年MM月dd日 HH:mm:ss 格式的字符串日期都被转换为Date数类型
  • 因为没有指定转换特定的属性名所对应的数据，所以包括一览中的数据也被成功转换
  • 一览中的字符换的前后空白也被清除，一览中的日期格式的也被成功转换
    在这里插入图片描述

五. 其他自定义属性编辑器实例

5.1 自定义SexPropertyEditor

  • 对性别进行编辑，如果性别为空或者不为男性或者女性，默认设置为男性
import org.springframework.util.ObjectUtils;

import java.beans.PropertyEditorSupport;
import java.util.Arrays;
import java.util.List;

public class SexPropertyEditor extends PropertyEditorSupport {

    private final static List<String> sexList = Arrays.asList("男", "女");

    @Override
    public void setAsText(String sex) {

        // 当性别为空或者不是男或女的时候，默认设置为男性
        if(ObjectUtils.isEmpty(sex) || !sexList.contains(sex)) {
            setValue("男");
            return;
        }

        setValue(sex);
    }
}

5.2 自定义StringToListPropertyEditor

  • 将参数中的属性名=XXX-XXX-XXX的数据转换为数组
import org.springframework.util.ObjectUtils;

import java.beans.PropertyEditorSupport;

public class StringToListPropertyEditor extends PropertyEditorSupport {

    @Override
    public void setAsText(String text){

        if (ObjectUtils.isEmpty(text) || !text.contains("-")) {
            setValue(text);
            return;
        }
        setValue(text.split("-"));
    }
}

5.3 form实体类

  • Test16Form01.java
import lombok.Data;

@Data
public class Test16Form01 {

    private String sex;

    private String[] numList;

    private String[] addList;
}

5.4 前端

const url = `/test16/receiveNumListAndSex?sex=不明&numList=1-2-3&addList=4-5-6`;
$.ajax({
    url,
    type: 'GET',
    success: function (data, status, xhr) {
        console.log(data);
    }
});

5.5 Controller层

@Controller
@RequestMapping("/test16")
public class Test16Controller {

    @InitBinder
    public void formBinder(WebDataBinder binder) {

        // 当数据类型为String[],且 属性名为 numList 的时候才会起作用
        // 虽然addList也是String[]格式的数据，但是我们并没有指定转换此属性
        binder.registerCustomEditor(String[].class, "numList", new StringToListPropertyEditor());
        
        // 当数据类型为String 且 属性名为 sex 的时候才会起作用
        binder.registerCustomEditor(String.class, "sex", new SexPropertyEditor());
    }
    
    @GetMapping("/receiveNumListAndSex")
    @ResponseBody
    public void receiveNumList(Test16Form01 form) {
        System.out.println(form);
    }
}

5.6 效果

在这里插入图片描述

六. 多个@InitBinder注解修饰的方法

  • 如果@InitBinder注解没有添加value值，则每个请求都会走被其修饰的方法
  • 如果@InitBinder注解有value值，则只有参数的名称与其相同才会走此方法
import com.example.jmw.common.bindEditor.SexPropertyEditor;
import com.example.jmw.common.bindEditor.StringToListPropertyEditor;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

@Controller
@RequestMapping("/test16")
public class Test16Controller {

    // 注解没有添加value值，每个请求都会走此方法
    @InitBinder
    public void init(WebDataBinder binder) {
        binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));
    }

    // 指定只有参数名称为test16Form01的，才会走此方法
    @InitBinder("test16Form01")
    public void formBinder(WebDataBinder binder) {
        // 当数据类型为String 且 属性名为 sex 的时候才会起作用
        binder.registerCustomEditor(String.class, "sex", new SexPropertyEditor());
    }

    // 指定只有参数名称为test16Form的，才会走此方法
    @InitBinder("test16Form")
    public void receiveGetBinder(WebDataBinder binder) {
        // 当数据类型为String[],且 属性名为 numList 的时候才会起作用
        binder.registerCustomEditor(String[].class, "numList", new StringToListPropertyEditor());
    }

    @GetMapping("/receiveGet")
    @ResponseBody
    public void receiveGet(Test16Form form) {

        System.out.println(form);
    }

    @GetMapping("/receiveNumListAndSex")
    @ResponseBody
    public void receiveNumList(Test16Form01 form) {
        System.out.println(form);
    }
}

在这里插入图片描述

七. 其他用法

  1. 当前Controller继承父类，在父类中使用@InitBinder注解来修饰的方法
  2. 配合@ControllerAdvice注解作用于全局，具体用法请参考 顶部的参考资料
fengyehongWorld
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Sping : @InitBinder注解
九师兄
01-12 573
1.美图 2.概述 @InitBinder用于在@Controller中标注于方法上，表示为当前控制器注册一个属性编辑器，只对当前的Controller有效。@InitBinder标注的方法必须有一个参数WebDataBinder。所谓的属性编辑器可以理解就是帮助我们完成参数绑定。 @ResponseBody @RequestMapping(value = "/test") pu...
Springboot @Configuration @bean注解作用解析
08-25
主要介绍了springboot @Configuration @bean注解作用解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
爆破专栏丨SpringBoot2.x系列教程之利用InitBinder处理请求参数的绑定(一)
关注我！带你一路 "狂飙" 到底！
12-24 531
前言 我们在开发项目时，前后端之间需要密切配合，才能确保项目的稳定高效。前端通过URL接口给后端传递请求参数，后端根据这些不同的请求参数返回对应的响应信息。那么在这个传参和返回响应信息的过程中，会发生什么事情呢？我们能不能在这个过程中做一些干预操作呢？比如我们要添加一个学生的年龄信息，前端传递过来一个负数作为年龄参数，这个明显不合法，那么后端能不能对这个非法的参数做出一些处理呢？ 所以今天壹哥就带大家在SpringBoot中，学习一些可以处理请求参数的技巧，确保我们的后端接口更加的安全健壮。 一...
详细分析@InitBinder注解的使用和原理
m0_73311735的博客
03-17 140
由@InitBinder注解修饰的方法用于初始化对象，能够实现：从request获取到handler方法中由@注解或@注解修饰的参数后，假如获取到的参数类型与handler方法上的参数类型不匹配，此时可以使用初始化好的对获取到的参数进行类型处理。一个经典的例子就是handler方法上的参数类型为Date，而从request中获取到的参数类型是字符串，SpringMVC在默认情况下无法实现字符串转Date，此时可以在由@InitBinder注解修饰的方法中为对象注册，从而使得能将从request。
springMVC之@InitBinder的用法
怪咖@的博客
10-17 1万+
@InitBinder从字面意思可以看出这个的作用是给Binder做初始化的`@InitBinder主要用在@Controller中标注于方法上（@RestController也算），表示初始化当前控制器的数据绑定器（或者属性绑定器），只对当前的Controller有效。@InitBinder标注的方法必须有一个参数WebDataBinder。所谓的属性编辑器可以理解就是帮助我们完成`参数绑定`，然后是在请求到达controller要执行方法前执行！
SpringBoot - @InitBinder注解详解
记录并分享
08-18 4616
@InitBinder注解可以作用在被@Controller注解的类的方法上，表示为当前控制器注册一个属性编辑器，用于对WebDataBinder进行初始化，且只对当前的Controller有效。@InitBinder标注的方法会被多次执行的，也就是说来一次请求就会执行一次@InitBinder注解方法的内容。.........
@InitBinder
ZERO
05-27 1万+
转载自： 　　https://blog.csdn.net/ai_xiangjuan/article/details/79842385 　　https://blog.csdn.net/ai_xiangjuan/article/details/79696639 　　@InitBinder用于在@Controller中标注于方法上，表示为当前控制器注册一个属性编辑器，只对当前的Controller...
SpringMVC中的@InitBinder注解【记录】
单枪匹码
04-28 3300
一、Spring请求参数绑定流程： 1、请求参数绑定流程： 我们在开发的时候，经常会从html，jsp中将请求参数通过request对象传递到后台，可是经常会遇到这么一种情况，那就是传过来的数据到后台后，还要再组装成一种对象的格式。 2、Spring中请求参数绑定： Spring可以自动将request中的请求参数数据绑定到对象的每个property上，但是只会绑定一些简单数据类型（比如Strings，int，float）到对应的对象中。可是如果面对复杂的对象，那就要借助PropertyEditor接口来
springboot @Valid注解对嵌套类型的校验功能
08-27
主要介绍了springboot~@Valid注解对嵌套类型的校验,主要介绍 @Valid在项目中的使用，需要的朋友可以参考下
详解SpringMVC注解@initbinder解决类型转换问题
08-27
本篇文章主要介绍了详解SpringMVC注解@initbinder解决类型转换问题，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
springboot @ComponentScan注解原理解析
08-25
主要介绍了springboot @ComponentScan注解原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
springboot @ConditionalOnMissingBean注解的作用详解
08-18
主要介绍了springboot @ConditionalOnMissingBean注解的作用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot 跨域配置
热门推荐
菜鸟记录
08-14 1万+
⏹ SpringBoot 跨域配置
SpringBoot Mybatis多数据源配置
菜鸟记录
09-01 9432
⏹SpringBoot Mybatis多数据源配置
SpringBoot @RequestHeader注解接收请求头
菜鸟记录
03-23 9310
⏹@RequestHeader注解接收请求头
SpringBoot 读取项目中静态资源文件
菜鸟记录
08-14 6976
⏹SpringBoot 读取项目中静态资源文件
Springboot redirect重定向传递参数
菜鸟记录
12-11 6862
⏹RedirecAtrributes ⏹FlashMap ⏹DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE ⏹RequestContextUtils.getOutputFlashMap ⏹FlashMapManager
SpringBoot 使用lombok的@RequiredArgsConstructor注解进行Bean注入
菜鸟记录
09-27 6737
⏹SpringBoot 使用lombok的@RequiredArgsConstructor注解进行Bean注入
@initbinder注解
最新发布
05-26
在 Spring MVC 中，当客户端提交请求时，Spring MVC 会自动将请求中的参数绑定到控制器方法的参数上，这个过程就是数据绑定。`@InitBinder` 可以用来注册自定义的数据编辑器或属性编辑器，从而控制数据绑定的过程。 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值