tk.mybatis扩展通用接口使用详解
一.tk.mybatis已经为我们封装好了许多拆箱即用的通用mapper,但在实际的项目开发中想必不少小伙伴在数据库设计中都会采用逻辑删除这种方案，再去使用通用的mapper接口就不行了。
这时候就需要我们封装一些扩展的通用Mapper接口。
二.项目中提供了大量现成的方法，这些方法可以作为扩展时的参考。
例如selectAll方法。
首先定义接口：
@RegisterMapper publicinterfaceSelectAllMapper{ /** *查询全部结果 * *@return */ @SelectProvider(type=MySelectProvider.class,method="dynamicSQL") List selectAll(); }
其中MySelectProvider是你要实现的一个类，该类需要继承MapperTemplate。@RegisterMapper注解可以避免mappers参数配置，通用Mapper检测到该接口被继承时，会自动注册。
importorg.apache.ibatis.mapping.MappedStatement;
importtk.mybatis.mapper.mapperhelper.MapperHelper;
importtk.mybatis.mapper.mapperhelper.MapperTemplate;
importtk.mybatis.mapper.mapperhelper.SqlHelper;
publicclassMySelectProviderextendsMapperTemplate{
publicBaseSelectProvider(ClassmapperClass,MapperHelpermapperHelper){
super(mapperClass,mapperHelper);
}
/**
*查询全部结果
*
*@paramms
*@return
*/
publicStringselectAll(MappedStatementms){
finalClassentityClass=getEntityClass(ms);
//修改返回值类型为实体类型
setResultType(ms,entityClass);
StringBuildersql=newStringBuilder();
sql.append(SqlHelper.selectAllColumns(entityClass));
sql.append(SqlHelper.fromTable(entityClass,tableName(entityClass)));
sql.append(SqlHelper.orderByDefault(entityClass));
returnsql.toString();
}
}
其中selectAll方法名要和接口中定义的方法名一致。其次就是该方法的参数为MappedStatement类型。
在selectAll方法中，首先是获取了当前接口的实体类型：
finalClassentityClass=getEntityClass(ms);
因为接口返回值类型为List
setResultType(ms,entityClass);
注意，只有返回T或者List时需要设置，返回int类型时不需要设置。
接下来就是纯粹的拼接XML形式的SQL了。
/selectcol1,col2... sql.append(SqlHelper.selectAllColumns(entityClass)); //fromtablename-支持动态表名 sql.append(SqlHelper.fromTable(entityClass,tableName(entityClass))); //orderbyxxx sql.append(SqlHelper.orderByDefault(entityClass));
当你想要实现某种方法时，可以从已有的例子中找一个最接近的方法，在此基础上进行修改
三.例：根据主键查询单个实体对象（过滤掉逻辑删除的实体，注：我的数据表逻辑删除字段定义为enabled_status）
首先定义mapper
@RegisterMapper publicinterfaceSelectByKeyAndNotDeletedMapper{ /** *根据主键查询没有被逻辑删除的实体 * *@return */ @SelectProvider(type=SelectByKeyNotDeletedProvider.class,method="dynamicSQL") TselectByKeyNotDeleted(Objectkey); }
其次定义SelectByKeyNotDeletedProvider
publicclassSelectByKeyNotDeletedProviderextendsMapperTemplate{
publicSelectByKeyNotDeletedProvider(ClassmapperClass,MapperHelpermapperHelper){
super(mapperClass,mapperHelper);
}
publicStringselectByKeyNotDeleted(MappedStatementms){
finalClassentityClass=getEntityClass(ms);
//将返回值修改为实体类型
setResultType(ms,entityClass);
StringBuildersql=newStringBuilder();
sql.append(SqlHelper.selectAllColumns(entityClass));
sql.append(SqlHelper.fromTable(entityClass,tableName(entityClass)));
sql.append(wherePKColumns(entityClass,false));
returnsql.toString();
}
privateStringwherePKColumns(ClassentityClass,booleanuseVersion){
StringBuildersql=newStringBuilder();
sql.append("");
//获取全部列
SetcolumnSet=EntityHelper.getPKColumns(entityClass);
//当某个列有主键策略时，不需要考虑他的属性是否为空，因为如果为空，一定会根据主键策略给他生成一个值
for(EntityColumncolumn:columnSet){
sql.append("AND"+column.getColumnEqualsHolder());
}
if(useVersion){
sql.append(whereVersion(entityClass));
}
//过滤被逻辑删除的数据
sql.append("ANDenabled_status=1");
sql.append(" ");
returnsql.toString();
}
}
然后定义BasicMapper,让其继承通用Mapper接口以及上面自定义的SelectByKeyAndNotDeletedMapper接口。
@tk.mybatis.mapper.annotation.RegisterMapperpublicinterfaceBasicMapper
最后在通用service中引入，
@AutowiredprivateBasicMapper
自定义*.Mapper都去继承BasicMapper
publicinterfaceUserPOMapperextendsBasicMapper
注意：最新版本的tk已经支持根据注解@LogicDelete实现逻辑删除
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。