Java 中枚举怎么在 MyBatis 中配置自定义类型处理器

雨敏同学_9467

雨敏同学_9467

2026-08-11

960人浏览

原创

mybatis 中 java 枚举与数据库整型字段的无感转换需通过 typehandler 实现:核心是自定义继承 basetypehandler 的泛型处理器(如 enumcodetypehandler),利用枚举的 getcode() 和 of(int) 方法完成双向转换,并支持空值容错与全局/局部注册。

java 中枚举怎么在 mybatis 中配置自定义类型处理器

Java 枚举在 MyBatis 中不能直接存取数据库,必须通过类型处理器(TypeHandler)明确告诉框架“怎么把枚举转成数据库值、怎么从数据库值还原枚举”。核心不是写一堆反射代码,而是选对方式、写清逻辑、注册到位。

用 @EnumValue 注解快速映射(适合简单场景)

MyBatis 3.4.0+ 支持在枚举里用 @EnumValue 标记一个 getter 方法,框架会自动用它的返回值做读写。前提是这个方法返回类型和数据库字段类型一致(比如 String 对应 VARCHAR,int 对应 TINYINT)。

  • 枚举中必须有带 @EnumValue 的 public getter,例如 getCode() 或 getValue()
  • 反向查找需手动提供静态方法(如 fromCode(String)),MyBatis 不自动调用它,只靠构造器参数匹配——所以推荐枚举构造器参数顺序与 @EnumValue 方法返回值一致
  • 不支持 null 值或非法值兜底,出错时直接抛 IllegalArgumentException

写自定义 TypeHandler 实现双向控制(推荐主流做法)

继承 BaseTypeHandler 是最稳妥的方式,尤其当你需要处理整型码、容错空值、或统一管理多个枚举时。

Gradle 9.8.0
Gradle 9.8.0

Gradle 9.8.0 官方二进制分发包,适用于 Windows、macOS 与 Linux 的 Java、Kotlin 和 Android 项目构建。

下载
  • setNonNullParameter():把枚举的码值(如 status.getCode())设进 PreparedStatement
  • getNullableResult()(两个重载):从 ResultSet 读出数据库值,用枚举自带的查找方法(如 OrderStatus.of(2))转成枚举对象
  • 务必在 getNullableResult 中判断 null 和非法值,返回默认项(如 UNKNOWN)或抛定制异常,避免运行时崩溃
  • 泛型写法可复用,比如 EnumCodeTypeHandler<orderstatus></orderstatus> 能减少重复代码

注册 TypeHandler 的三种方式

写了处理器还不算完,得让 MyBatis “看见”它。三种注册方式按优先级递减:

  • 局部指定最清晰:在 Mapper XML 的 <resultmap></resultmap> 或 SQL 标签里用 typeHandler 属性,例如:
    <result property="status" column="status_code" typehandler="com.example.OrderStatusTypeHandler"></result>
  • 包扫描最省事:在 application.yml 或 mybatis-config.xml 中配置 type-handlers-package,MyBatis 自动扫描该包下所有 TypeHandler
  • 全局注册最彻底:在 MyBatis 配置中显式声明 <typehandler handler="xxx.TypeHandler"></typehandler>,适用于跨模块复用

避坑要点

实际开发中容易忽略但影响稳定的几个细节:

  • 别用 ordinal() 映射——枚举顺序一变,数据库数据就错乱;优先用稳定字段如 code 或 value
  • 数据库字段类型要匹配:String 枚举对应 VARCHAR,int 枚举对应 TINYINT/INT,类型不一致会报 JDBC 异常
  • TypeHandler 类必须有无参构造函数,否则 Spring 无法注入
  • 如果用了 MyBatis-Plus,它自带 EnumTypeHandler,但仅支持 name() 或 ordinal(),复杂业务仍建议自己写

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java 处理器

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11017

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8122

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7032

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1184

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

968

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1436

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2909

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20171

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1275

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习