深入了解SpringBoot中@InitBinder注解的使用
寫在前面
@InitBinder注解可以作用在被@Controller注解的類的方法上,表示為當前控制器注冊一個屬性編輯器,用于對WebDataBinder進行初始化,且只對當前的Controller有效。@InitBinder標注的方法會被多次執(zhí)行的,也就是說來一次請求就會執(zhí)行一次@InitBinder注解方法的內容。
- @InitBinder注解是在其所標注的方法執(zhí)行之前被解析和執(zhí)行;
- @InitBinder的value屬性,控制的是模型Model里的KEY,而不是方法名;
- @InitBinder標注的方法也不能有返回值;
- @InitBinder對@RequestBody這種基于消息轉換器的請求參數是失效的。
應用場景
用于將前端傳遞過來的數據進行類型轉換或者叫屬性編輯,如:將前端傳遞過來的字符串格式的日期數據,轉化為DATE類型。
作用范圍
@InitBinder是屬于Controller級別的屬性編輯器,并非全局級別(針對所有Controller)的屬性編輯器,也就是一個@InitBinder只對當前所在的Controller有效,對其他Controller無效的
如果項目中有多個Controller中都要進屬性編輯怎么辦呢?
一般我們將@InitBinder標注的方法定義在基礎的控制器上,所有具體的Controller繼承這個基礎的Controller即可。
示例代碼
/** * WEB層通用數據處理 * @author ROCKY */ public class BaseController { /** * 將前端傳遞過來的日期格式的字符串轉化為Date類型,否則無法將數據綁定到實體中。 * 自定義類型轉換器有兩種方式:A. implements Converter<String, Date> 或者 B. extends PropertyEditorSupport; * 在WebDataBinder對象中,可以設置前綴,可以設置允許、禁止的字段、必填字段以及驗證器,可以自定義類型轉換器。 */ @InitBinder public void initBinder(WebDataBinder binder) { // Date 類型轉換 binder.registerCustomEditor(Date.class, new PropertyEditorSupport() { @Override public void setAsText(String text) { setValue(DateUtils.parseDate(text)); } }); } }
常見錯誤
如果后端沒有將日期格式的字符串轉化為DATE類型,則在后端服務接收DATE類型的數據時,報錯如下:
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對@RequestBody的請求參數是失效的?
因為@InitBinder用于初始化DataBinder的數據綁定、類型轉換等場景;
@RequestBody的數據解析、格式轉換是通過消息轉換器來完成的,所以即使自定義了屬性編輯器,對@RequestBody的參數是不生效的,
@RequestBody的數據綁定轉換,如果是JSON格式的數據一般都是交給了JACKSON來完成的。
這就是為什么在整個項目中既有屬性編輯器,也有JACKSON的消息轉換器,同時對應的DO對象中關于日期的屬性,需要使用@JsonFormat()進行標注,如下:
/** * 程序注解配置 * * @author ROCKY */ @Configuration // 表示通過aop框架暴露該代理對象,AopContext能夠訪問 @EnableAspectJAutoProxy(exposeProxy = true) // 指定要掃描的Mapper類的包的路徑 @MapperScan("cn.hadoopx.**.mapper") public class ApplicationConfig { // 1. 時區(qū)配置 @Bean public Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() { return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.timeZone(TimeZone.getDefault()); } }
public class BaseEntity implements Serializable { /** * 創(chuàng)建者 */ private String createBy; /** * 創(chuàng)建時間 */ @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date createTime; /** * 更新者 */ private String updateBy; /** * 更新時間 */ @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date updateTime; }
到此這篇關于深入了解SpringBoot中@InitBinder注解的使用的文章就介紹到這了,更多相關@InitBinder注解詳細解讀內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
static關鍵字有何魔法?竟讓Spring Boot搞出那么多靜態(tài)內部類(推薦)
這篇文章主要介紹了static關鍵字有何魔法?竟讓Spring Boot搞出那么多靜態(tài)內部類,本文通過實例代碼圖文相結合給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-07-07解決運行jar包出錯:ClassNotFoundException問題
這篇文章主要介紹了解決運行jar包出錯:ClassNotFoundException問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-12-12springboot+vue實現SSE服務器發(fā)送事件的示例
本文介紹了使用Spring Boot和Vue實現服務器發(fā)送事件,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2025-01-01