Java中 枚举类怎么在 MyBatis 中配置 EnumTypeHandler 映射数据库

千丽大大_8539

千丽大大_8539

2026-07-18

232人浏览

原创

MyBatis 默认不支持枚举与数据库字段自动转换,需通过 TypeHandler 显式映射;推荐定义含 code 和 desc 字段的枚举类,并配合自定义 OrderStatusTypeHandler 实现 code 与 INT 字段双向转换,或全局配置 EnumTypeHandler 映射 name 到 VARCHAR。

java中 枚举类怎么在 mybatis 中配置 enumtypehandler 映射数据库

Java 枚举类在 MyBatis 中默认无法自动与数据库字段(如 INT 或 VARCHAR)互相转换,需通过 EnumTypeHandler 显式配置映射规则。核心是让 MyBatis 知道:枚举的哪个字段(如 code 或 name)对应数据库中的值。

定义带属性的枚举类

推荐枚举实现业务语义明确的字段,例如用 code 存数据库值,desc 作描述:

public enum OrderStatus {
    INIT(0, "初始化"),
    PAID(1, "已支付"),
    SHIPPED(2, "已发货"),
    COMPLETED(3, "已完成");
<pre class="brush:php;toolbar:false;">private final int code;
private final String desc;

OrderStatus(int code, String desc) {
    this.code = code;
    this.desc = desc;
}

public int getCode() { return code; }
public String getDesc() { return desc; }

// 提供根据 code 反查枚举的静态方法(MyBatis 反向映射必需)
public static OrderStatus fromCode(int code) {
    for (OrderStatus status : OrderStatus.values()) {
        if (status.code == code) {
            return status;
        }
    }
    throw new IllegalArgumentException("Unknown code: " + code);
}

}

注册 EnumTypeHandler(两种方式)

MyBatis 提供了内置的 EnumOrdinalTypeHandler(按序号)和 EnumTypeHandler(按 name),但更常用的是自定义 handler 或直接使用 EnumTypeHandler 配合枚举的 getter 方法。

  • 方式一:全局配置(推荐) —— 在 mybatis-config.xml 中注册为默认枚举处理器:
<configuration><typehandlers><typehandler handler="org.apache.ibatis.type.EnumTypeHandler" javatype="com.example.OrderStatus"></typehandler></typehandlers></configuration>

此时 MyBatis 默认使用枚举的 name()(即 INIT、PAID)与数据库 VARCHAR 字段映射。若数据库存的是数字(如 0、1),则不适用。

  • 方式二:指定字段映射(最常用) —— 使用 EnumOrdinalTypeHandler(存序号)或自定义 handler(存自定义字段):

若数据库字段是 TINYINT 存 code 值,建议写一个轻量自定义 handler:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
public class OrderStatusTypeHandler extends BaseTypeHandler<orderstatus> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, OrderStatus parameter, JdbcType jdbcType) 
            throws SQLException {
        ps.setInt(i, parameter.getCode());
    }
<pre class="brush:php;toolbar:false;">@Override
public OrderStatus getNullableResult(ResultSet rs, String columnName) throws SQLException {
    int code = rs.getInt(columnName);
    return rs.wasNull() ? null : OrderStatus.fromCode(code);
}

// 其余两个 getNullableResult 重载方法类似,可调用上面逻辑

}

然后在 XML 映射文件中显式指定:

<resultmap id="OrderResultMap" type="Order"><id property="id" column="id"></id><result property="status" column="status_code" typehandler="com.example.OrderStatusTypeHandler"></result></resultmap>

注解方式(Mapper 接口 + @Select/@Insert)

使用 @Select 等注解时,可在参数或结果上直接指定 handler:

@Select("SELECT * FROM orders WHERE status_code = #{status.code}")
List<order> selectByStatus(@Param("status") OrderStatus status);
<p>@Results({
@Result(property = "status", column = "status_code", 
typeHandler = OrderStatusTypeHandler.class)
})
@Select("SELECT * FROM orders")
List<order> findAll();
</order></p></order>

注意事项

  • 数据库字段类型要与 handler 写入/读取的类型一致(如 handler 写 int,字段就得是 INT/TINYINT)
  • 必须提供从数据库值反查枚举实例的静态方法(如 fromCode),否则反序列化会失败
  • 若枚举字段名不是 code,而是 value 或 id,handler 中相应调整 getter 调用即可
  • Spring Boot 项目可在 application.yml 中配置全局 type-handlers:
mybatis:
  configuration:
    type-handlers-package: com.example.handler

这样包下所有继承 BaseTypeHandler 的类会被自动注册。

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

10357

6

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

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

2023.07.05

7482

9

java自学难吗
java自学难吗

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

2023.07.31

6552

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2729

5

java在线网站
java在线网站

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

2023.08.03

20031

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习