在我新书《MyBatis 从入门到精通》中为了介绍 MyBatis 拦截器,提供了一个下画线键值转小写驼峰形式插件,这篇博客使用另一种思路来解决相同的问题。
MyBatis 配置文件中,支持下面这几种配置:
properties?, settings?, typeAliases?, typeHandlers?,
objectFactory?, objectWrapperFactory?, reflectorFactory?,
plugins?, environments?, databaseIdProvider?, mappers?
我们使用 objectWrapperFactory
来解决这个问题。
配置这个属性时,必须遵守上面属性配置的顺序进行配置(在 objectFactory
后面,在reflectorFactory
前面),否则就会出错。
objectWrapperFactory 接口如下:
public interface ObjectWrapperFactory {
boolean hasWrapperFor(Object object);
ObjectWrapper getWrapperFor(MetaObject metaObject, Object object);
}
通过实现这个接口,可以判断当object
是 Map
类型时,返回 true
,然后在下面的 getWrapperFor
中返回一个可以处理 key 为驼峰的 Wrapper 类即可。
首先,参考已有的 MapWrapper
实现自己的 MyWrapper
:
package tk.mybatis;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.wrapper.MapWrapper;
import java.util.Map;
/**
* 驼峰处理
*
* @author liuzh
* @since 2017/6/18.
*/
public class MyMapWrapper extends MapWrapper {
public MyMapWrapper(MetaObject metaObject, Map<String, Object> map) {
super(metaObject, map);
}
@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;
}
/**
* 将下划线风格替换为驼峰风格
*
* @param inputString
* @return
*/
public 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();
}
}
这种方式实现起来很容易。然后提供 ObjectWrapperFactory
实现类:
package tk.mybatis;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.wrapper.ObjectWrapper;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import java.util.Map;
/**
* Map 类型结果转驼峰
*
* @author liuzh
* @since 2017/6/18.
*/
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 MyMapWrapper(metaObject, (Map) object);
}
}
仍然很简单,在 MyBatis 配置文件中配置上 objectWrapperFactory
:
<objectWrapperFactory type="tk.mybatis.MapWrapperFactory"/>
因为代码中判断了useCamelCaseMapping
,所以想要真正能够使用这个功能,还需要在 settings
中增加如下配置:
<settings>
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!-- 其他配置 -->
</settings>
这种方式不需要使用拦截器,而且直接从源头对 Map
的 key 进行处理,不会产生任何额外的消耗,如果你经常设置返回值resultType
为map
,可以尝试该方法。