Java 中枚举怎么在持久层框架(如 MyBatis)中处理自定义类型转换

大婷同学_6398

大婷同学_6398

2026-07-28

718人浏览

原创

java枚举在mybatis中需通过@enumvalue注解或自定义typehandler实现双向映射,优先使用稳定字段(如code/value)而非name(),并注意数据库类型匹配与非法值兜底处理。

java 中枚举怎么在持久层框架(如 mybatis)中处理自定义类型转换

Java 枚举在 MyBatis 中默认无法直接映射到数据库字段,因为枚举是对象类型,而数据库只存原始值(如字符串或整数)。要正确持久化和读取枚举,需明确告诉 MyBatis “这个枚举该用哪个字段值来存、怎么从数据库值还原成枚举”。核心在于定义**类型转换规则**,而不是依赖默认行为。

使用 @EnumValue 注解(MyBatis 3.4.0+)

如果枚举中已定义一个带 @EnumValue 的属性(比如 code 或 name),MyBatis 会自动识别并用于映射。前提是该属性有 getter 方法,且类型与数据库列一致(如 String 或 Integer)。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 枚举类示例:
public enum OrderStatus {<br>  CREATED("created", 1),<br>  PAID("paid", 2),<br>  SHIPPED("shipped", 3);<br><br>  private final String code;<br>  private final int value;<br><br>  OrderStatus(String code, int value) {<br>    this.code = code;<br>    this.value = value;<br>  }<br><br>  @EnumValue<br>  public String getCode() {<br>    return code;<br>  }<br><br>  public static OrderStatus fromCode(String code) {<br>    // 手动实现反向查找逻辑<br>  }<br>>}
  • MyBatis 会用 getCode() 的返回值写入数据库;查询时,也用该值匹配构造器参数或静态方法(需配合 @EnumType 或自定义 TypeHandler)。

自定义 TypeHandler 实现双向转换

这是最灵活、推荐的方式,尤其适用于复杂映射逻辑(如按数字码存、按中文名查,或需要容错处理空值/非法值)。

  • 继承 BaseTypeHandler<e></e>,重写 setNonNullParameter(写库)和 getNullableResult(读库);
  • 注册方式二选一:
    – 在 mybatis-config.xml 中全局注册:
    <typehandlers><typehandler handler="com.example.OrderStatusTypeHandler"></typehandler></typehandlers>
    – 或在 Mapper XML 的 中局部指定:
    <result property="status" column="status_code" javatype="com.example.OrderStatus" typehandler="com.example.OrderStatusTypeHandler"></result>
  • 建议在 handler 内部使用 Enum.valueOf() 或自定义查找表(HashMap),避免每次反射调用;对 null 和非法值做兜底(如返回 UNKNOWN 枚举项或抛异常)。

在 XML 映射文件中用 typeHandler 属性显式指定

即使有全局 TypeHandler,某些字段仍可能需要覆盖。直接在 / /

  • 插入时指定枚举字段的处理器:
    <insert id="insertOrder"><br>  INSERT INTO orders (status_code) VALUES (#{status, typeHandler=com.example.OrderStatusTypeHandler})<br></insert>
  • 查询时绑定结果:
    <resultmap id="OrderMap" type="Order"><br>  <result property="status" column="status_code" typehandler="com.example.OrderStatusTypeHandler"></result><br></resultmap>

注意事项与常见坑

  • 数据库字段类型要和枚举序列化方式匹配:存字符串就用 VARCHAR,存数字就用 TINYINT/SMALLINT;
  • 不要依赖 name() —— 一旦枚举名重构,历史数据就失效;优先用稳定字段(如 code、value);
  • MyBatis 默认的 EnumTypeHandler 只支持按 name() 映射,且不支持自定义反序列化逻辑,慎用;
  • Spring Boot + MyBatis Starter 下,可通过 @Configuration 类注册 TypeHandler Bean,自动被扫描;
  • 单元测试时务必覆盖非法值场景(如数据库里存了 "unknown"),确保 TypeHandler 不抛 NPE 或 IndexOutOfBoundsException。

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

相关专题

更多
java
java

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

2023.06.15

9317

6

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

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

2023.07.05

6482

9

java自学难吗
java自学难吗

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

2023.07.31

5792

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1216

5

java有什么用
java有什么用

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

2023.08.02

2449

5

java在线网站
java在线网站

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

2023.08.03

19791

3

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

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

2023.08.03

1115

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习