寫(xiě)在前面

@InitBinder注解可以作用在被@Controller注解的類的方法上，表示為當(dāng)前控制器注冊(cè)一個(gè)屬性編輯器，用于對(duì)WebDataBinder進(jìn)行初始化，且只對(duì)當(dāng)前的Controller有效。@InitBinder標(biāo)注的方法會(huì)被多次執(zhí)行的，也就是說(shuō)來(lái)一次請(qǐng)求就會(huì)執(zhí)行一次@InitBinder注解方法的內(nèi)容。

• @InitBinder注解是在其所標(biāo)注的方法執(zhí)行之前被解析和執(zhí)行；
• @InitBinder的value屬性，控制的是模型Model里的KEY，而不是方法名；
• @InitBinder標(biāo)注的方法也不能有返回值；
• @InitBinder對(duì)@RequestBody這種基于消息轉(zhuǎn)換器的請(qǐng)求參數(shù)是失效的。

應(yīng)用場(chǎng)景

用于將前端傳遞過(guò)來(lái)的數(shù)據(jù)進(jìn)行類型轉(zhuǎn)換或者叫屬性編輯，如：將前端傳遞過(guò)來(lái)的字符串格式的日期數(shù)據(jù)，轉(zhuǎn)化為DATE類型。

作用范圍

@InitBinder是屬于Controller級(jí)別的屬性編輯器，并非全局級(jí)別(針對(duì)所有Controller)的屬性編輯器，也就是一個(gè)@InitBinder只對(duì)當(dāng)前所在的Controller有效，對(duì)其他Controller無(wú)效的

如果項(xiàng)目中有多個(gè)Controller中都要進(jìn)屬性編輯怎么辦呢？

一般我們將@InitBinder標(biāo)注的方法定義在基礎(chǔ)的控制器上，所有具體的Controller繼承這個(gè)基礎(chǔ)的Controller即可。

示例代碼

/**
 * WEB層通用數(shù)據(jù)處理
 * @author ROCKY
 */
public class BaseController {
    /**
     * 將前端傳遞過(guò)來(lái)的日期格式的字符串轉(zhuǎn)化為Date類型，否則無(wú)法將數(shù)據(jù)綁定到實(shí)體中。
     * 自定義類型轉(zhuǎn)換器有兩種方式：A. implements Converter<String, Date> 或者 B. extends PropertyEditorSupport;
     * 在WebDataBinder對(duì)象中，可以設(shè)置前綴，可以設(shè)置允許、禁止的字段、必填字段以及驗(yàn)證器，可以自定義類型轉(zhuǎn)換器。
     */
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // Date 類型轉(zhuǎn)換
        binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) {
                setValue(DateUtils.parseDate(text));
            }
        });
    }
}

常見(jiàn)錯(cuò)誤

如果后端沒(méi)有將日期格式的字符串轉(zhuǎn)化為DATE類型，則在后端服務(wù)接收DATE類型的數(shù)據(jù)時(shí)，報(bào)錯(cuò)如下：

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 '2022-08-09 11:15:58';
nested exception is java.lang.IllegalArgumentException

為什么@InitBinder對(duì)@RequestBody的請(qǐng)求參數(shù)是失效的？

因?yàn)锧InitBinder用于初始化DataBinder的數(shù)據(jù)綁定、類型轉(zhuǎn)換等場(chǎng)景；

@RequestBody的數(shù)據(jù)解析、格式轉(zhuǎn)換是通過(guò)消息轉(zhuǎn)換器來(lái)完成的，所以即使自定義了屬性編輯器，對(duì)@RequestBody的參數(shù)是不生效的，

@RequestBody的數(shù)據(jù)綁定轉(zhuǎn)換，如果是JSON格式的數(shù)據(jù)一般都是交給了JACKSON來(lái)完成的。

這就是為什么在整個(gè)項(xiàng)目中既有屬性編輯器，也有JACKSON的消息轉(zhuǎn)換器，同時(shí)對(duì)應(yīng)的DO對(duì)象中關(guān)于日期的屬性，需要使用@JsonFormat()進(jìn)行標(biāo)注，如下：

/**
 * 程序注解配置
 *
 * @author ROCKY
 */
@Configuration
// 表示通過(guò)aop框架暴露該代理對(duì)象,AopContext能夠訪問(wèn)
@EnableAspectJAutoProxy(exposeProxy = true)
// 指定要掃描的Mapper類的包的路徑
@MapperScan("cn.hadoopx.**.mapper")
public class ApplicationConfig {
    // 1. 時(shí)區(qū)配置
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() {
        return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.timeZone(TimeZone.getDefault());
    }
}

public class BaseEntity implements Serializable {
    /**
     * 創(chuàng)建者
     */
    private String createBy;
    /**
     * 創(chuàng)建時(shí)間
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;
    /**
     * 更新者
     */
    private String updateBy;
    /**
     * 更新時(shí)間
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;
}

到此這篇關(guān)于深入了解SpringBoot中@InitBinder注解的使用的文章就介紹到這了,更多相關(guān)@InitBinder注解詳細(xì)解讀內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論