首页
/ Mapper框架中自定义Mapper接口的继承与实现问题解析

Mapper框架中自定义Mapper接口的继承与实现问题解析

2025-05-30 08:30:10作者:袁立春Spencer

问题背景

在使用通用Mapper框架(abel533/Mapper)进行开发时,开发者经常会遇到需要扩展基础功能的情况。在5.0.0版本中,框架对自定义Mapper接口的处理方式发生了变化,导致一些在4.2.2版本中能够正常工作的代码在新版本中出现问题。

问题现象

开发者定义了一个基础接口IBaseMapper,它继承了ShardingMapperMySqlMapper,并添加了自定义方法querySumMap。然后通过TestMapper接口继承这个基础接口。在4.2.2版本中,这种设计可以正常工作,但在5.0.0版本中会抛出异常。

技术分析

版本差异

在4.2.2版本中,Mapper框架对未实现的方法有兼容处理机制,会自动忽略那些没有具体实现的方法。这种设计虽然方便,但也可能导致潜在的问题被掩盖。

5.0.0版本对此进行了严格化处理,要求所有声明的方法都必须有对应的实现,否则会抛出异常。这种改变提高了代码的严谨性,但也带来了升级兼容性问题。

问题本质

问题的核心在于@RegisterMapper注解的使用。这个注解告诉Mapper框架需要处理该接口中的方法,但开发者并没有为自定义方法提供实现。

解决方案

推荐方案

最简单的解决方案是从自定义的基础接口IBaseMapper中移除@RegisterMapper注解。这样Mapper框架就不会尝试处理这个接口中的自定义方法。

public interface IBaseMapper<T> extends ShardingMapper<T>, MySqlMapper<T> {
    Map<String, String> querySumMap(@Param("params") Map<String, Object> params);
}

替代方案

如果确实需要在基础接口中使用@RegisterMapper注解,可以为自定义方法提供实现。这通常需要:

  1. 创建一个对应的XML映射文件
  2. 或者使用@SelectProvider等注解提供SQL实现
@RegisterMapper
public interface IBaseMapper<T> extends ShardingMapper<T>, MySqlMapper<T> {
    @SelectProvider(type = BaseMapperProvider.class, method = "querySumMapSQL")
    Map<String, String> querySumMap(@Param("params") Map<String, Object> params);
}

最佳实践

  1. 分层设计:将框架提供的功能接口和自定义功能接口分开定义
  2. 谨慎使用注解:只在必要时使用@RegisterMapper等框架注解
  3. 版本升级检查:升级Mapper框架版本时,特别注意自定义接口的处理
  4. 明确实现:对于自定义方法,要么提供明确实现,要么确保不被框架处理

总结

Mapper框架5.0.0版本对自定义接口的处理更加严格,这既是进步也可能带来升级问题。理解框架的设计意图,合理组织代码结构,可以既享受新版本的优点,又避免兼容性问题。对于大多数场景,简单的移除@RegisterMapper注解就能解决问题,这也是最推荐的解决方案。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
927
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8