mybatis Map查詢結果下劃線轉駝峰的實例

更新時間：2020年09月24日 11:29:42 作者：xx_star1204

這篇文章主要介紹了mybatis Map查詢結果下劃線轉駝峰的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

添加一個配置類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返回值下劃線轉峰坨
 * @author xingxing_yuan
 * @since 2020-02-18 13:47
 */
@Configuration
public class MybatisCamelConfig {
 @Bean
 public ConfigurationCustomizer mybatisConfigurationCustomizer() {
//   使用自定義的解析器工廠
  return configuration -> configuration.setObjectWrapperFactory(new MapWrapperFactory());
 }
 
 /**
  * 實現工廠
  */
 static class MapWrapperFactory implements ObjectWrapperFactory {
  @Override
  public boolean hasWrapperFor(Object object) {
//  判斷是Map就使用該解析
   return object instanceof Map;
  }
 
  @Override
  public ObjectWrapper getWrapperFor(MetaObject metaObject, Object object) {
//  將默認的解析器替換成峰坨轉換
   return new CamelWrapper(metaObject, (Map) object);
  }
 }
 
 /**
  * 重寫轉換器；添加轉換方法
  */
 static class CamelWrapper extends MapWrapper {
 
  CamelWrapper(MetaObject metaObject, Map<String, Object> map) {
   super(metaObject, map);
  }
 
  /**
   * mybatis查詢結果下劃線轉峰坨
   *
   * @param name
   * @param useCamelCaseMapping 是否進行轉換。yaml 中配置map-underscore-to-camel-case=true
   * @return
   */
  @Override
  public String findProperty(String name, boolean useCamelCaseMapping) {
   if (useCamelCaseMapping) {
//    使用guava的轉換方法,覆蓋Map的默認返回值
    return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name);
   }
   return name;
  }
 
 }
}

補充知識：關于Springboot+Mybatis中返回結果集為Map時其內的Key轉換為駝峰的命名(2種方法)

使用場景：

使用mybatis的時候,簡單的連表查詢,用Map接收的時候,都是像DB定義的字段一樣,類似以下 student_name,student_id,沒有轉換為駝峰,但是又不能因為這一個定義一個javabean來映射數據庫字段集合,這樣,會有無窮無盡的javabean,完全不是辦法。然后看了下mybatis-spring-boot的配置文檔

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

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

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

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

繼承HashMap,重寫Put函數,將mybatis返回的Map,寫上自定義Map的路徑,自定義的Map,將所有的key內部轉換為駝峰表達式

找到mybatis的Handler,通過Handler來找到轉換映射關系的接口定義,繼承或者實現接口,然后走自定義的轉換規(guī)則來實現Map映射的駝峰轉換

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

下面是使用第二種的兩種在項目中的具體實現

第一種實現方法：

首先,我開始找mybatis的configuration里面的mapUnderscoreToCamelCase屬性調用的地方

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

然后我們在查看屬性傳遞進去后的操作,點進 metaObject.findProperty的實現

接著在看,objectWrapper.findProperty,發(fā)現是個接口,然后我們需要查看,是對應的哪個實現,然后我debug發(fā)現是 MapWrapper的實現,并沒有做任何操作,直接返回了name。

到這里,我們可以看下源碼的目錄結構,發(fā)現了以下

心里大概明白怎么回事了,具體過程應該如下

通過接口ObjectWrapper來定義行為,有默認的一些實現,然后通過工廠ObjectWrapperFactory接口,來創(chuàng)建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,通過包裝工廠來創(chuàng)建自定義的包裝類,通過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里面,我們是通過使用這個來控制是否轉換駝峰的,最后寫個測試用例跑一下,然后會發(fā)現,以前db的字段,下劃線已經轉換成駝峰命名了。

第二種實現方法：

這種方法就比較投機取巧了, 但是可以很簡單的實現Map集合的映射,下面我們來具體看看實現過程。(PS: 推薦使用第一種方法吧, 比較官方!)

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

2.對默認的Map映射的包裝類查找property的findProperty方法進行改造,加入自己的映射轉換規(guī)則, 當然也可以像第一種方法中一樣: “引用的 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配置文件中添加了如下配置: