当前位置：首页 > news >正文

MyBatis（17）MyBatis 如何处理枚举类型

news 2025/7/15 16:03:47

MyBatis 处理枚举类型的机制相对直接，它提供了一种灵活的方式来处理Java枚举（enum）类型和数据库之间的映射。在MyBatis中，你可以通过两种方式处理枚举类型：使用枚举的名称（name）或者枚举的序号（ordinal）。此外，对于更复杂的需求，MyBatis允许你通过实现TypeHandler接口自定义枚举类型的处理器。

使用枚举名称（`name`）或序号（`ordinal`）

默认情况下，MyBatis在处理枚举类型时，会使用枚举的名称（name）与数据库中的字符串值进行匹配和映射。如果你的数据库设计是使用枚举的名称来存储的话，这种方式非常直接和便利。

例如，考虑下面的枚举：

public enum Status {ACTIVE, INACTIVE, DELETED;
}

在MyBatis的映射文件中，如果你有一个返回Status枚举的查询，你可以直接这样写：

<select id="selectStatus" resultType="Status">SELECT status FROM some_table WHERE id = #{id}
</select>

MyBatis会自动将数据库中返回的status字符串值映射到Status枚举的名称上。

如果你倾向于使用枚举的序号（每个枚举常量在声明中的位置，从0开始）进行存储和匹配，你需要自定义TypeHandler来实现这一点。

自定义TypeHandler

当你需要以非标准方式处理枚举类型时（例如，使用枚举的ordinal值，或者枚举中定义的某个字段），你可以通过实现TypeHandler接口来自定义枚举的持久化逻辑。

以下是一个使用枚举序号进行映射的TypeHandler示例：

@MappedTypes(Status.class)
public class StatusTypeHandler extends BaseTypeHandler<Status> {@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, Status parameter, JdbcType jdbcType) throws SQLException {ps.setInt(i, parameter.ordinal());}@Overridepublic Status getNullableResult(ResultSet rs, String columnName) throws SQLException {int ordinal = rs.getInt(columnName);if (rs.wasNull()) {return null;}return Status.values()[ordinal];}@Overridepublic Status getNullableResult(ResultSet rs, int columnIndex) throws SQLException {int ordinal = rs.getInt(columnIndex);if (rs.wasNull()) {return null;}return Status.values()[ordinal];}@Overridepublic Status getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {int ordinal = cs.getInt(columnIndex);if (cs.wasNull()) {return null;}return Status.values()[ordinal];}
}

在这个自定义TypeHandler中，我们覆盖了setNonNullParameter方法来定义如何将Status枚举设置到PreparedStatement中，以及覆盖了getNullableResult方法定义如何从ResultSet中读取数据并转换为Status枚举。

在MyBatis配置中注册TypeHandler

定义了TypeHandler之后，还需要在MyBatis配置文件中进行注册：

<typeHandlers><typeHandler handler="path.to.StatusTypeHandler"/>
</typeHandlers>

深入解析

MyBatis在处理枚举类型时实际上是通过TypeHandler机制来实现的。所有的枚举类型处理最终都是通过相应的TypeHandler来完成数据的转换和映射。

默认枚举处理: 对于枚举类型，MyBatis内部默认使用EnumTypeHandler（基于枚举的name处理）和EnumOrdinalTypeHandler（基于枚举的ordinal处理）。
自定义处理逻辑: 通过实现TypeHandler接口，开发者可以自定义枚举类型的处理逻辑，以适应不同的业务需求。这一机制提供了极高的灵活性。