關於Springboot+Mybatis中返回結果集為Map時其內的Key轉換為駝峰的命名(2種方法)
使用場景:
使用mybatis的時候,簡單的連表查詢,用Map接收的時候,都是像DB定義的欄位一樣,類似以下 student_name,student_id,沒有轉換為駝峰,但是又不能因為這一個定義一個javabean來對映資料庫欄位集合,這樣,會有無窮無盡的javabean,完全不是辦法。然後看了下mybatis-spring-boot的配置文件
mybatis.configuration.map-underscore-to-camel-case=true
看著屬性意思,很像是 map 下劃線轉換為駝峰,然後我天真的以為,加個這個,就會將Map裡面的key轉換為駝峰的命名方式, 總歸是太天真了。沒辦法,接著找了了一下,發現官方文件
才發現,這個屬性的作用,是作用於javabean的field的,並不是map。既然 map-underscore-to-camel-case 不能作用於map,那麼只能自己動手了,然後就想到了2個解決方案:
- 繼承HashMap,重寫Put函式,將mybatis返回的Map,寫上自定義Map的路徑,自定義的Map,將所有的key內部轉換為駝峰表示式
- 找到mybatis的Handler,通過Handler來找到轉換對映關係的介面定義,繼承或者實現介面,然後走自定義的轉換規則來實現Map對映的駝峰轉換
最終決定,採用第二種,方便以後擴充套件
下面是使用第二種的兩種在專案中的具體實現
第一種實現方法:
首先,我開始找mybatis的configuration裡面的mapUnderscoreToCamelCase屬性呼叫的地方
有兩個地方呼叫了,然後我們看第一個呼叫的地方,發現名稱是createAutomaticMappings,應該是map的對映欄位建立,如下程式碼,游標顯示的地方,就是呼叫的地方
然後我們在檢視屬性傳遞進去後的操作,點進 metaObject.findProperty的實現
接著在看,objectWrapper.findProperty,發現是個介面,然後我們需要檢視,是對應的哪個實現,然後我debug發現是 MapWrapper的實現,並沒有做任何操作,直接返回了name。
到這裡,我們可以看下原始碼的目錄結構,發現了以下
心裡大概明白怎麼回事了,具體過程應該如下
通過介面ObjectWrapper來定義行為,有預設的一些實現,然後通過工廠ObjectWrapperFactory介面,來建立ObjectWrapper介面,最後來進行對方的自動對映跟包裝,至此,心裡已經想到怎麼改動了
1.首先,我們先繼承類 MapWrapper,重寫findProperty,通過useCamelCaseMapping來判斷是否開啟使用駝峰。
public class CustomWrapper extends MapWrapper{
public CustomWrapper(MetaObject metaObject, Map<String, Object> map) {
super(metaObject, map);
}
@Override
public String findProperty(String name, boolean useCamelCaseMapping) {
if(useCamelCaseMapping){
//CaseFormat是引用的 guava庫,裡面有轉換駝峰的,免得自己重複造輪子,pom新增
/**
** <dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>24.1-jre</version>
</dependency>
**/
return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL,name);
}
return name;
}
}
2. 然後,我們在實現介面 ObjectWrapperFactory,通過包裝工廠來建立自定義的包裝類,通過hasWrapperFor判斷引數不為空,並且型別是Map的時候才使用自己擴充套件的ObjectWrapper。
public class MapWrapperFactory implements ObjectWrapperFactory {
@Override
public boolean hasWrapperFor(Object object) {
return object != null && object instanceof Map;
}
@Override
public ObjectWrapper getWrapperFor(MetaObject metaObject, Object object) {
return new CustomWrapper(metaObject,(Map)object);
}
}
3. 做完以上操作後,我們需要替換下,以前預設的實現,剛好,mybatis-spring-boot上面有告訴我們怎麼做,返回一個 ConfigurationCustomizer 的bean,通過匿名內部類實現覆蓋預設的MapWrapper的findProperty函式。
@Configuration
public class MybatisConfig {
@Bean
public ConfigurationCustomizer mybatisConfigurationCustomizer(){
return new ConfigurationCustomizer() {
@Override
public void customize(org.apache.ibatis.session.Configuration configuration) {
configuration.setObjectWrapperFactory(new MapWrapperFactory());
}
};
}
}
做了以上操作後,我們就將預設的Map對映的包裝類查詢property的部分,變成了自己想要的樣子;最後,我們在 properties或者yml裡面加上
mybatis.configuration.map-underscore-to-camel-case=true ,畢竟在CustomerWrapper裡面,我們是通過使用這個來控制是否轉換駝峰的,最後寫個測試用例跑一下,然後會發現,以前db的欄位,下劃線已經轉換成駝峰命名了。
第二種實現方法:
這種方法就比較投機取巧了, 但是可以很簡單的實現Map集合的對映,下面我們來具體看看實現過程。(PS: 推薦使用第一種方法吧, 比較官方!)
1.首先mybatis-3.4.5.jar中一個MapWrapper類, 現在我把這個MapWrapper類直接複製一份,然後建立相應的包, 這個包路徑跟在jar包中的包路徑完全一樣的(位於根路徑下的: ), 然後將複製的該MapWrapper檔案直接貼上至該包下, 那麼這個就是我們自己的MapWrapper類。
2.對預設的Map對映的包裝類查詢property的findProperty方法進行改造,加入自己的對映轉換規則, 當然也可以像第一種方法中一樣: “引用的 guava庫,裡面有轉換駝峰的,免得自己重複造輪子,pom新增依賴即可。” 這裡我們自己嘗試的實現, 程式碼如下:
@Override
public String findProperty(String name, boolean useCamelCaseMapping) {
if (useCamelCaseMapping
&& ((name.charAt(0) >= 'A' && name.charAt(0) <= 'Z')
|| name.indexOf("_") >= 0)) {
return underlineToCamelhump(name);
}
return name;
}
private String underlineToCamelhump(String inputString) {
StringBuilder sb = new StringBuilder();
boolean nextUpperCase = false;
for (int i = 0; i < inputString.length(); i++) {
char c = inputString.charAt(i);
if (c == '_') {
if (sb.length() > 0) {
nextUpperCase = true;
}
} else {
if (nextUpperCase) {
sb.append(Character.toUpperCase(c));
nextUpperCase = false;
} else {
sb.append(Character.toLowerCase(c));
}
}
}
return sb.toString();
}
做了以上操作後,我們就將預設的Map對映的包裝類查詢property的部分,變成了自己想要的樣子;
最後, 我們同樣在Mybatis配置檔案中添加了如下配置:
畢竟在CustomerWrapper裡面,我們是通過使用這個來控制是否轉換駝峰的。
當然最主要可以這樣實現的原因還是基於類載入機制允許的基礎上的,瞭解過相應的類載入原理及載入順序後我們可以知道:“位於WEB-INF目錄下自定義的class類優先與該目錄下的lib下jar包中的類載入; 同一個JVM裡面,判斷兩個類是否相同的依據是類的全路徑名稱和類載入器名稱是否完全相同。但由於委派機制的存在,每個類只要在父類載入器哪裡被找到,子類載入器就不會再嘗試載入了,因此,同名的類只能被載入一次,這被稱為單一原則。”
到此文章結束了
以上,如有不正之處,歡迎指正