MyBatis處理枚舉類型的方法詳解

更新時間：2024年07月05日 08:26:23 作者：Victor356

MyBatis 處理枚舉類型的機制相對直接,它提供了一種靈活的方式來處理Java枚舉（enum）類型和數(shù)據(jù)庫之間的映射,本文給大家介紹了MyBatis處理枚舉類型的兩種方法,需要的朋友可以參考下

引言

MyBatis 處理枚舉類型的機制相對直接，它提供了一種靈活的方式來處理Java枚舉（enum）類型和數(shù)據(jù)庫之間的映射。在MyBatis中，你可以通過兩種方式處理枚舉類型：使用枚舉的名稱（name）或者枚舉的序號（ordinal）。此外，對于更復雜的需求，MyBatis允許你通過實現(xiàn)TypeHandler接口自定義枚舉類型的處理器。

使用枚舉名稱（name）或序號（ordinal）

默認情況下，MyBatis在處理枚舉類型時，會使用枚舉的名稱（name）與數(shù)據(jù)庫中的字符串值進行匹配和映射。如果你的數(shù)據(jù)庫設計是使用枚舉的名稱來存儲的話，這種方式非常直接和便利。

例如，考慮下面的枚舉：

public enum Status {
  ACTIVE, INACTIVE, DELETED;
}

在MyBatis的映射文件中，如果你有一個返回Status枚舉的查詢，你可以直接這樣寫：

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

MyBatis會自動將數(shù)據(jù)庫中返回的status字符串值映射到Status枚舉的名稱上。

如果你傾向于使用枚舉的序號（每個枚舉常量在聲明中的位置，從0開始）進行存儲和匹配，你需要自定義TypeHandler來實現(xiàn)這一點。

自定義TypeHandler

當你需要以非標準方式處理枚舉類型時（例如，使用枚舉的ordinal值，或者枚舉中定義的某個字段），你可以通過實現(xiàn)TypeHandler接口來自定義枚舉的持久化邏輯。

以下是一個使用枚舉序號進行映射的TypeHandler示例：

@MappedTypes(Status.class)
public class StatusTypeHandler extends BaseTypeHandler<Status> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, Status parameter, JdbcType jdbcType) throws SQLException {
    ps.setInt(i, parameter.ordinal());
  }

  @Override
  public Status getNullableResult(ResultSet rs, String columnName) throws SQLException {
    int ordinal = rs.getInt(columnName);
    if (rs.wasNull()) {
      return null;
    }
    return Status.values()[ordinal];
  }

  @Override
  public Status getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    int ordinal = rs.getInt(columnIndex);
    if (rs.wasNull()) {
      return null;
    }
    return Status.values()[ordinal];
  }

  @Override
  public 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中讀取數(shù)據(jù)并轉(zhuǎn)換為Status枚舉。

在MyBatis配置中注冊TypeHandler

定義了TypeHandler之后，還需要在MyBatis配置文件中進行注冊：

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

深入解析

MyBatis在處理枚舉類型時實際上是通過TypeHandler機制來實現(xiàn)的。所有的枚舉類型處理最終都是通過相應的TypeHandler來完成數(shù)據(jù)的轉(zhuǎn)換和映射。

默認枚舉處理: 對于枚舉類型，MyBatis內(nèi)部默認使用EnumTypeHandler（基于枚舉的name處理）和EnumOrdinalTypeHandler（基于枚舉的ordinal處理）。
自定義處理邏輯: 通過實現(xiàn)TypeHandler接口，開發(fā)者可以自定義枚舉類型的處理邏輯，以適應不同的業(yè)務需求。這一機制提供了極高的靈活性。