前言
使用MyBatis-Plus的字段类型处理器，只需一个注解，就可以很方便的将数组、对象等数据直接映射到实体类中。
@Data
@Accessors(chain = true)
@TableName(autoResultMap = true)
public class User {
private Long id;
...
/**
* 注意！！ 必须开启映射注解
*
* @TableName(autoResultMap = true)
*
* 以下两种类型处理器，二选一 也可以同时存在
*
* 注意！！选择对应的 JSON 处理器也必须存在对应 JSON 解析依赖包
*/
@TableField(typeHandler = JacksonTypeHandler.class)
// @TableField(typeHandler = FastjsonTypeHandler.class)
private OtherInfo otherInfo;
}
该注解对应了 XML 中写法为
<result column="other_info" jdbcType="VARCHAR" property="otherInfo" typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler" />
实现的原理可以参考TableInfo的源码initResultMapIfNeed方法：
/**
* 自动构建 resultMap 并注入(如果条件符合的话)
*/
void initResultMapIfNeed() {
if (autoInitResultMap && null == resultMap) {
String id = currentNamespace + DOT + MYBATIS_PLUS + UNDERSCORE + entityType.getSimpleName();
List<ResultMapping> resultMappings = new ArrayList<>();
if (havePK()) {
ResultMapping idMapping = new ResultMapping.Builder(configuration, keyProperty, keyColumn, keyType)
.flags(Collections.singletonList(ResultFlag.ID)).build();
resultMappings.add(idMapping);
}
if (CollectionUtils.isNotEmpty(fieldList)) {
fieldList.forEach(i -> resultMappings.add(i.getResultMapping(configuration)));
}
ResultMap resultMap = new ResultMap.Builder(configuration, id, entityType, resultMappings).build();
configuration.addResultMap(resultMap);
this.resultMap = id;
}
}
存在的问题
当使用autoResultMap=true时, MP会做以下事情：
- 如果字段的Java类型不是基本类型，则会强制提示你设置
typeHandler属性，比如这么写是不行的：
/**
* IN 查询
*/
public static final String IN = "%s IN <foreach item=\"item\" collection=\"%s\" separator=\",\" open=\"(\" close=\")\" index=\"\">#{item}</foreach>";
@TableField(value="code",select=false, condition=IN )
private Strinng[] codes;
- 如果字段比较复杂，比如包含函数，带有表别名限定等，那么自动生成的resultMap对应的column属性则会变得很奇怪：
@TableField(value = "array_agg(distinct code)",jdbcType = JdbcType.VARCHAR, typeHandler = ArrayTypeHandler.class)
private String[] codes;
上面的代码中，生成的resultMap的column属性是 rray_agg(distinct code , （value属性前后各截取一位），具体的逻辑可以查看MP的源码：
TableFieldInfo.java
/**
* 获取 ResultMapping
*
* @param configuration MybatisConfiguration
* @return ResultMapping
*/
ResultMapping getResultMapping(final Configuration configuration) {
ResultMapping.Builder builder = new ResultMapping.Builder(configuration, property,
StringUtils.getTargetColumn(column), propertyType);
TypeHandlerRegistry registry = configuration.getTypeHandlerRegistry();
if (jdbcType != null && jdbcType != JdbcType.UNDEFINED) {
builder.jdbcType(jdbcType);
}
if (typeHandler != null && typeHandler != UnknownTypeHandler.class) {
TypeHandler<?> typeHandler = registry.getMappingTypeHandler(this.typeHandler);
if (typeHandler == null) {
typeHandler = registry.getInstance(propertyType, this.typeHandler);
// todo 这会有影响 registry.register(typeHandler);
}
builder.typeHandler(typeHandler);
}
return builder.build();
}
StringUtils.java
/**
* 验证字符串是否是数据库字段
*/
private static final Pattern P_IS_COLUMN = Pattern.compile("^\\w\\S*[\\w\\d]*$");
/**
* 判断字符串是否符合数据库字段的命名
*
* @param str 字符串
* @return 判断结果
*/
public static boolean isNotColumnName(String str) {
return !P_IS_COLUMN.matcher(str).matches();
}
/**
* 获取真正的字段名
*
* @param column 字段名
* @return 字段名
*/
public static String getTargetColumn(String column) {
if (isNotColumnName(column)) {
return column.substring(1, column.length() - 1);
}
return column;
}
是的，就是这么简单粗暴，这里吐槽一下国内开源软件的毛病，逻辑莫名其妙，而且git上对于开发者提出的疑问视而不见。
优化思路
其实如果一个字段存在typeHander属性，那就必须要建一个ResultMap来处理类型映射了，根本不需要再画蛇添足的指定autoResultMap=true, 不过也好在有这个属性，MP才会自动生成一个ResultMap，这样我们就可以在不指定这个属性的时候，生成自己的ResultMap了。
直接修改官方源代码不是我的风格，好在MP提供了Sql注入器，在往Mapper中注入方法之前，我们把ResultMap生成就可以了。
优化步骤
- 创建抽象注入方法的子类：BetterAutoResultMap.java
import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.metadata.TableFieldInfo;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.caspe.base.support.mybatisplus.toolkit.ConstantsX;
import lombok.SneakyThrows;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ResultMap;
import org.apache.ibatis.mapping.ResultMapping;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.apache.ibatis.type.UnknownTypeHandler;
import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;
/**
* 优化的AutoResultMap生成策略
* 只要字段中指定了TypeHandler即自动生成ResultMap, 而不需要指定autoResultMap=true
* 且只对设置了TypeHandler的字段生成ResultMapping, 而不是所有的字段
*
* @author yongfeng_meng
*/
public class BetterAutoResultMap extends AbstractMethod {
/**
* 强制重设TableInfo的resultMap属性
*/
static Field ResultMapOfTableInfo;
/**
* 强制重设TableInfo的autoInitResultMap属性
*/
static Field AutoInitResultMapOfTableInfo;
static {
try {
ResultMapOfTableInfo = TableInfo.class.getDeclaredField("resultMap");
ResultMapOfTableInfo.setAccessible(true);
AutoInitResultMapOfTableInfo = TableInfo.class.getDeclaredField("autoInitResultMap");
AutoInitResultMapOfTableInfo.setAccessible(true);
} catch (NoSuchFieldException e) {
e.printStackTrace();
}
}
/**
* 注入自定义 MappedStatement
* <p>
* 当实体类没有指定autoResultMap和resultMap时, 即可使用该方法自动注入ResultMap
*
* @param mapperClass mapper 接口
* @param modelClass mapper 泛型
* @param tableInfo 数据库表反射信息
* @return MappedStatement
*/
@SneakyThrows
@Override
public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
if (!tableInfo.isAutoInitResultMap() && tableInfo.getResultMap() == null) {
// 只要字段中指定了TypeHandler即自动生成ResultMap
if (tableInfo.getFieldList().stream().filter(this::needToAutoMap).findAny().isPresent()) {
// 生成ResultMap
ResultMap resultMap = generatorResultMap(tableInfo);
configuration.addResultMap(resultMap);
// 将ResultMap属性设置到TableInfo
ResultMapOfTableInfo.set(tableInfo, resultMap.getId());
AutoInitResultMapOfTableInfo.set(tableInfo, true);
}
}
return null;
}
/**
* 构建 resultMap
*/
ResultMap generatorResultMap(TableInfo tableInfo) {
String resultMapId = tableInfo.getCurrentNamespace() + DOT + ConstantsX.MYBATIS_PLUS_X + UNDERSCORE + tableInfo.getEntityType().getSimpleName();
List<ResultMapping> resultMappings = tableInfo.getFieldList().stream().filter(this::needToAutoMap)
.map(this::getResultMapping).collect(Collectors.toList());
return new ResultMap.Builder(configuration, resultMapId, tableInfo.getEntityType(), resultMappings).build();
}
boolean needToAutoMap(TableFieldInfo f) {
return f.getTypeHandler() != null && f.getTypeHandler() != UnknownTypeHandler.class;
}
/**
* 构建 resultMapping （只针对typeHandler的字段）
*
* @param tableFieldInfo
* @return
*/
ResultMapping getResultMapping(TableFieldInfo tableFieldInfo) {
String column = tableFieldInfo.getColumn();
String property = tableFieldInfo.getProperty();
if (!StringUtils.underlineToCamel(column).equals(property)) {
column = property;
}
ResultMapping.Builder builder = new ResultMapping.Builder(configuration, property, column, tableFieldInfo.getPropertyType());
TypeHandlerRegistry registry = configuration.getTypeHandlerRegistry();
JdbcType jdbcType = tableFieldInfo.getJdbcType();
if (jdbcType != null && jdbcType != JdbcType.UNDEFINED) {
builder.jdbcType(jdbcType);
}
TypeHandler<?> typeHandlerMapped = registry.getMappingTypeHandler(tableFieldInfo.getTypeHandler());
if (typeHandlerMapped == null) {
typeHandlerMapped = registry.getInstance(tableFieldInfo.getPropertyType(), tableFieldInfo.getTypeHandler());
}
builder.typeHandler(typeHandlerMapped);
return builder.build();
}
}
- 创建SQL注入器的自定义类：SqlInjectorX.java
import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
import com.caspe.base.support.mybatisplus.injector.methods.BetterAutoResultMap;
import com.caspe.base.support.mybatisplus.injector.methods.DeleteByMultiId;
import com.caspe.base.support.mybatisplus.injector.methods.SelectByMultiId;
import com.caspe.base.support.mybatisplus.injector.methods.UpdateByMultiId;
import java.util.ArrayList;
import java.util.List;
public class SqlInjectorX extends DefaultSqlInjector {
@Override
public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
List<AbstractMethod> methodList = new ArrayList<>();
// 优先注入AutoResultMap生成方法
methodList.add(new BetterAutoResultMap());
methodList.addAll(super.getMethodList(mapperClass));
return methodList;
}
}
- 将自定义Sql注入器加入到容器中
@Configuration
@Import({SqlInjectorX.class})
public class MybatisPlusAutoConfiguration {
}
验证
首先按照优化思路，肯定先要将autoResultMap=true这个属性删掉。
问题1将不复存在，问题2使用了我们自定义的ResultMap，column属性和property属性将一致，一切变得简单而自然。
