mybatis Map實(shí)現(xiàn)查詢結(jié)果下劃線轉(zhuǎn)駝峰

本篇文章為大家展示了mybatis Map實(shí)現(xiàn)查詢結(jié)果下劃線轉(zhuǎn)駝峰，內(nèi)容簡(jiǎn)明扼要并且容易理解，絕對(duì)能使你眼前一亮，通過(guò)這篇文章的詳細(xì)介紹希望你能有所收獲。

添加一個(gè)配置類MybatisCamelConfig 即可

package com.fpi.notify.config;
 
import com.google.common.base.CaseFormat;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.wrapper.MapWrapper;
import org.apache.ibatis.reflection.wrapper.ObjectWrapper;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; 
import java.util.Map;
 
/**
 * mybatis查詢Map返回值下劃線轉(zhuǎn)峰坨
 * @author xingxing_yuan
 * @since 2020-02-18 13:47
 */
@Configuration
public class MybatisCamelConfig {
 @Bean
 public ConfigurationCustomizer mybatisConfigurationCustomizer() {
//   使用自定義的解析器工廠
  return configuration -> configuration.setObjectWrapperFactory(new MapWrapperFactory());
 }
 
 /**
  * 實(shí)現(xiàn)工廠
  */
 static class MapWrapperFactory implements ObjectWrapperFactory {
  @Override
  public boolean hasWrapperFor(Object object) {
//  判斷是Map就使用該解析
   return object instanceof Map;
  }
 
  @Override
  public ObjectWrapper getWrapperFor(MetaObject metaObject, Object object) {
//  將默認(rèn)的解析器替換成峰坨轉(zhuǎn)換
   return new CamelWrapper(metaObject, (Map) object);
  }
 }
 
 /**
  * 重寫(xiě)轉(zhuǎn)換器；添加轉(zhuǎn)換方法
  */
 static class CamelWrapper extends MapWrapper {
 
  CamelWrapper(MetaObject metaObject, Map<String, Object> map) {
   super(metaObject, map);
  }
 
  /**
   * mybatis查詢結(jié)果下劃線轉(zhuǎn)峰坨
   *
   * @param name
   * @param useCamelCaseMapping 是否進(jìn)行轉(zhuǎn)換。yaml 中配置map-underscore-to-camel-case=true
   * @return
   */
  @Override
  public String findProperty(String name, boolean useCamelCaseMapping) {
   if (useCamelCaseMapping) {
//    使用guava的轉(zhuǎn)換方法,覆蓋Map的默認(rèn)返回值
    return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name);
   }
   return name;
  }
 
 }
}

補(bǔ)充知識(shí)：關(guān)于Springboot+Mybatis中返回結(jié)果集為Map時(shí)其內(nèi)的Key轉(zhuǎn)換為駝峰的命名(2種方法)

使用場(chǎng)景：

使用mybatis的時(shí)候,簡(jiǎn)單的連表查詢,用Map接收的時(shí)候,都是像DB定義的字段一樣,類似以下 student_name,student_id,沒(méi)有轉(zhuǎn)換為駝峰,但是又不能因?yàn)檫@一個(gè)定義一個(gè)javabean來(lái)映射數(shù)據(jù)庫(kù)字段集合,這樣,會(huì)有無(wú)窮無(wú)盡的javabean,完全不是辦法。然后看了下mybatis-spring-boot的配置文檔

http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/, 發(fā)現(xiàn)有這么個(gè)屬性

mybatis.configuration.map-underscore-to-camel-case=true

看著屬性意思,很像是 map 下劃線轉(zhuǎn)換為駝峰,然后我天真的以為,加個(gè)這個(gè),就會(huì)將Map里面的key轉(zhuǎn)換為駝峰的命名方式, 總歸是太天真了。沒(méi)辦法,接著找了了一下,發(fā)現(xiàn)官方文檔http://www.mybatis.org/mybatis-3/configuration.html#properties, 描述過(guò)這個(gè)的作用, 如下

才發(fā)現(xiàn),這個(gè)屬性的作用,是作用于javabean的field的,并不是map。既然 map-underscore-to-camel-case 不能作用于map,那么只能自己動(dòng)手了,然后就想到了2個(gè)解決方案:

繼承HashMap,重寫(xiě)Put函數(shù),將mybatis返回的Map,寫(xiě)上自定義Map的路徑,自定義的Map,將所有的key內(nèi)部轉(zhuǎn)換為駝峰表達(dá)式

找到mybatis的Handler,通過(guò)Handler來(lái)找到轉(zhuǎn)換映射關(guān)系的接口定義,繼承或者實(shí)現(xiàn)接口,然后走自定義的轉(zhuǎn)換規(guī)則來(lái)實(shí)現(xiàn)Map映射的駝峰轉(zhuǎn)換

最終決定,采用第二種,方便以后擴(kuò)展

下面是使用第二種的兩種在項(xiàng)目中的具體實(shí)現(xiàn)

第一種實(shí)現(xiàn)方法：

首先,我開(kāi)始找mybatis的configuration里面的mapUnderscoreToCamelCase屬性調(diào)用的地方

有兩個(gè)地方調(diào)用了,然后我們看第一個(gè)調(diào)用的地方,發(fā)現(xiàn)名稱是createAutomaticMappings,應(yīng)該是map的映射字段創(chuàng)建,如下代碼,光標(biāo)顯示的地方,就是調(diào)用的地方

然后我們?cè)诓榭磳傩詡鬟f進(jìn)去后的操作,點(diǎn)進(jìn) metaObject.findProperty的實(shí)現(xiàn)

接著在看,objectWrapper.findProperty,發(fā)現(xiàn)是個(gè)接口,然后我們需要查看,是對(duì)應(yīng)的哪個(gè)實(shí)現(xiàn),然后我debug發(fā)現(xiàn)是 MapWrapper的實(shí)現(xiàn),并沒(méi)有做任何操作,直接返回了name。

到這里,我們可以看下源碼的目錄結(jié)構(gòu),發(fā)現(xiàn)了以下

心里大概明白怎么回事了,具體過(guò)程應(yīng)該如下

通過(guò)接口ObjectWrapper來(lái)定義行為,有默認(rèn)的一些實(shí)現(xiàn),然后通過(guò)工廠ObjectWrapperFactory接口,來(lái)創(chuàng)建ObjectWrapper接口,最后來(lái)進(jìn)行對(duì)方的自動(dòng)映射跟包裝,至此,心里已經(jīng)想到怎么改動(dòng)了

1.首先,我們先繼承類 MapWrapper,重寫(xiě)findProperty,通過(guò)useCamelCaseMapping來(lái)判斷是否開(kāi)啟使用駝峰。

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庫(kù),里面有轉(zhuǎn)換駝峰的,免得自己重復(fù)造輪子,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. 然后,我們?cè)趯?shí)現(xiàn)接口 ObjectWrapperFactory,通過(guò)包裝工廠來(lái)創(chuàng)建自定義的包裝類,通過(guò)hasWrapperFor判斷參數(shù)不為空,并且類型是Map的時(shí)候才使用自己擴(kuò)展的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. 做完以上操作后,我們需要替換下,以前默認(rèn)的實(shí)現(xiàn),剛好,mybatis-spring-boot上面有告訴我們?cè)趺醋?返回一個(gè) ConfigurationCustomizer 的bean,通過(guò)匿名內(nèi)部類實(shí)現(xiàn)覆蓋默認(rèn)的MapWrapper的findProperty函數(shù)。

@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());
 }
 };
 }
}

做了以上操作后,我們就將默認(rèn)的Map映射的包裝類查找property的部分,變成了自己想要的樣子;最后,我們?cè)?properties或者yml里面加上 mybatis.configuration.map-underscore-to-camel-case=true ,畢竟在CustomerWrapper里面,我們是通過(guò)使用這個(gè)來(lái)控制是否轉(zhuǎn)換駝峰的,最后寫(xiě)個(gè)測(cè)試用例跑一下,然后會(huì)發(fā)現(xiàn),以前db的字段,下劃線已經(jīng)轉(zhuǎn)換成駝峰命名了。

第二種實(shí)現(xiàn)方法：

這種方法就比較投機(jī)取巧了, 但是可以很簡(jiǎn)單的實(shí)現(xiàn)Map集合的映射,下面我們來(lái)具體看看實(shí)現(xiàn)過(guò)程。(PS: 推薦使用第一種方法吧, 比較官方!)

1.首先mybatis-3.4.5.jar中一個(gè)MapWrapper類, 現(xiàn)在我把這個(gè)MapWrapper類直接復(fù)制一份,然后創(chuàng)建相應(yīng)的包, 這個(gè)包路徑跟在jar包中的包路徑完全一樣的(位于根路徑下的: ), 然后將復(fù)制的該MapWrapper文件直接粘貼至該包下, 那么這個(gè)就是我們自己的MapWrapper類。

2.對(duì)默認(rèn)的Map映射的包裝類查找property的findProperty方法進(jìn)行改造,加入自己的映射轉(zhuǎn)換規(guī)則, 當(dāng)然也可以像第一種方法中一樣: “引用的 guava庫(kù),里面有轉(zhuǎn)換駝峰的,免得自己重復(fù)造輪子,pom添加依賴即可?！?這里我們自己嘗試的實(shí)現(xiàn), 代碼如下:

@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();
 }

做了以上操作后,我們就將默認(rèn)的Map映射的包裝類查找property的部分,變成了自己想要的樣子;

最后, 我們同樣在Mybatis配置文件中添加了如下配置:

畢竟在CustomerWrapper里面,我們是通過(guò)使用這個(gè)來(lái)控制是否轉(zhuǎn)換駝峰的。

當(dāng)然最主要可以這樣實(shí)現(xiàn)的原因還是基于類加載機(jī)制允許的基礎(chǔ)上的，了解過(guò)相應(yīng)的類加載原理及加載順序后我們可以知道:“位于WEB-INF目錄下自定義的class類優(yōu)先與該目錄下的lib下jar包中的類加載; 同一個(gè)JVM里面，判斷兩個(gè)類是否相同的依據(jù)是類的全路徑名稱和類加載器名稱是否完全相同。

但由于委派機(jī)制的存在，每個(gè)類只要在父類加載器哪里被找到，子類加載器就不會(huì)再嘗試加載了，因此，同名的類只能被加載一次，這被稱為單一原則?！?/p>

上述內(nèi)容就是mybatis Map實(shí)現(xiàn)查詢結(jié)果下劃線轉(zhuǎn)駝峰，你們學(xué)到知識(shí)或技能了嗎？如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備，歡迎關(guān)注億速云行業(yè)資訊頻道。