RuoYi模块功能分析：第六章BaseController的@InitBinder分析

文章目录

前言
一、参数转换处理（日期转换）
二、指定参数前缀
三、排除接收属性

前言

在若依项目中，定义了一个BaseController类位于package com.ruoyi.common.core.controller;包下。大部分的controller都继承了这个类。而这个类中有一个被@InitBinder描述的方法，被@InitBinder描述的方法当接口请求过来的时候会先走声明@InitBinder的方法然后才会走接口。那么就衍生出来常用的三种用法

参数转换处理（日期转换）
指定参数前缀
排除接收属性

一、参数转换处理（日期转换）

我们都知道，前端传递过来的数据类型只可能是字符串或者数值类型，文件类型。js没有java中的long，date...这些类型，那么当前端传递过来2024-02-10 04:52:23我们直接用Date time接收会报错。

shell 复制代码

04:52:49.090 [http-nio-18100-exec-1] WARN  o.s.w.s.m.s.DefaultHandlerExceptionResolver - [logException,208] - Resolved [org.springframework.web.method.annotation.MethodArgumentTypeMismatchException: Failed to convert value of type 'java.lang.String' to required type 'java.util.Date'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [java.util.Date] for value [2024-02-10 04:52:23]; nested exception is java.lang.IllegalArgumentException]

这个时候我们就需要对前端传递过来的字符串进行日期转换

java 复制代码

@InitBinder
public void initBinder(WebDataBinder binder)
{
    // Date 类型转换
    binder.registerCustomEditor(Date.class, new PropertyEditorSupport()
    {
        @Override
        public void setAsText(String text)
        {	// 格式化参数
            setValue(DateUtils.parseDate(text));
        }
    });
}

二、指定参数前缀

首先我们先定义俩个类来接收参数

java 复制代码

@Data
class Test1{
    String name;
}

@Data
class Test2{
    String name;
    Long age;
}

定义一个接口，我们都知道当前端传递name=zhangsan，age=18。那么test1和test2的name会被同时附上值，这并不是我们想要的结果

java 复制代码

@PostMapping("text")
public AjaxResult test(Test1 test1,Test2 test2){
    ArrayList<Object> arrayList = new ArrayList<>();
    System.out.println(String.format("test1 %s",test1));
    System.out.println(String.format("test2 %s",test2));
    return success(null);
}

可以看到，我们就传递了一个name但是test1和test2被同时附上了值

这个时候我们就可以通过@InitBinder来给参数加上前缀，来指定要被赋值的参数

java 复制代码

    // 拦截当前接口参数名为test1的接口
    @InitBinder("test1")
    public void init(WebDataBinder binder){
        // 对参数名为test1的参数全部加上test1.前缀
        binder.setFieldDefaultPrefix("test1.");
    }

    @PostMapping("text")
    public AjaxResult test(Test1 test1,Test2 test2){
        ArrayList<Object> arrayList = new ArrayList<>();
        System.out.println(String.format("test1 %s",test1));
        System.out.println(String.format("test2 %s",test2));
        return null;
    }

这个时候咋发送请求就可以看到我们想要的结果

三、排除接收属性

我们也可以使用InitBinder来指定我们要排除接收的参数

java 复制代码

 // 拦截当前接口参数名为test1的接口
 @InitBinder("test1")
 public void init(WebDataBinder binder){
     // 排除test1.name
     binder.setDisallowedFields("name");
 }

 @PostMapping("text")
 public AjaxResult test(Test1 test1,Test2 test2){
     ArrayList<Object> arrayList = new ArrayList<>();
     System.out.println(String.format("test1 %s",test1));
     System.out.println(String.format("test2 %s",test2));
     return null;
 }