TypeHandler 是 MyBatis 中用于處理 Java 類型與 JDBC 類型之間轉(zhuǎn)換的接口。它在 MyBatis 的參數(shù)綁定和結(jié)果映射過(guò)程中起著至關(guān)重要的作用。

為什么需要 TypeHandler？

Java 和 數(shù)據(jù)庫(kù)（JDBC）使用不同的類型系統(tǒng)。例如：

• Java 中有 String、Integer、Date、Boolean、enum 等類型。
• JDBC 中有 VARCHAR、INTEGER、DATE、BOOLEAN、TIMESTAMP、BLOB 等類型。

當(dāng) MyBatis 執(zhí)行 SQL 語(yǔ)句時(shí)，需要將 Java 對(duì)象中的數(shù)據(jù)設(shè)置到 JDBC 的 PreparedStatement 中（參數(shù)綁定），以及將 JDBC 的 ResultSet 中的數(shù)據(jù)轉(zhuǎn)換為 Java 對(duì)象（結(jié)果映射）。TypeHandler 就負(fù)責(zé)處理這兩種情況下的類型轉(zhuǎn)換。

TypeHandler 的作用

參數(shù)綁定 (Java 類型 -> JDBC 類型):

• 當(dāng) MyBatis 將 Java 對(duì)象中的數(shù)據(jù)設(shè)置到 PreparedStatement 的占位符（#{}）時(shí)，TypeHandler 會(huì)將 Java 類型轉(zhuǎn)換為對(duì)應(yīng)的 JDBC 類型。
• 例如，將 Java 的 String 類型轉(zhuǎn)換為 JDBC 的 VARCHAR 類型，將 Java 的 Date 類型轉(zhuǎn)換為 JDBC 的 TIMESTAMP 類型。

結(jié)果映射 (JDBC 類型 -> Java 類型):

• 當(dāng) MyBatis 從 ResultSet 中讀取數(shù)據(jù)并將其映射為 Java 對(duì)象時(shí)，TypeHandler 會(huì)將 JDBC 類型轉(zhuǎn)換為對(duì)應(yīng)的 Java 類型。
• 例如，將 JDBC 的 VARCHAR 類型轉(zhuǎn)換為 Java 的 String 類型，將 JDBC 的 INTEGER 類型轉(zhuǎn)換為 Java 的 Integer 類型。

TypeHandler 的接口定義

public interface TypeHandler<T> {

  // 參數(shù)綁定：將 Java 類型轉(zhuǎn)換為 JDBC 類型，并設(shè)置到 PreparedStatement 中
  void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;

  // 結(jié)果映射：從 ResultSet 中獲取指定列的數(shù)據(jù)，并將其轉(zhuǎn)換為 Java 類型
  T getResult(ResultSet rs, String columnName) throws SQLException;

  // 結(jié)果映射：從 ResultSet 中獲取指定列索引的數(shù)據(jù)，并將其轉(zhuǎn)換為 Java 類型
  T getResult(ResultSet rs, int columnIndex) throws SQLException;
  
    // 結(jié)果映射：從 CallableStatement 中獲取指定列索引的數(shù)據(jù),將其轉(zhuǎn)換為java類型
  T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}

• setParameter(): 將 Java 類型的參數(shù) parameter 設(shè)置到 PreparedStatement 的第 i 個(gè)占位符，并指定 JDBC 類型 jdbcType（jdbcType 可以為空，MyBatis 會(huì)嘗試自動(dòng)推斷）。
• getResult(): 有三個(gè)重載方法，分別根據(jù)列名、列索引從 ResultSet 中獲取數(shù)據(jù)，或從CallableStatement獲取數(shù)據(jù)，并將其轉(zhuǎn)換為 Java 類型。

MyBatis 內(nèi)置的 TypeHandler

MyBatis 內(nèi)置了許多常用的 TypeHandler，用于處理常見(jiàn)的類型轉(zhuǎn)換。例如：

• StringTypeHandler: 處理 String 類型。
• IntegerTypeHandler: 處理 Integer 類型。
• LongTypeHandler: 處理 Long 類型。
• DateTypeHandler: 處理 java.util.Date 類型。
• BooleanTypeHandler: 處理 Boolean 類型。
• EnumTypeHandler: 處理枚舉類型（默認(rèn)使用枚舉的名稱）。
• EnumOrdinalTypeHandler: 處理枚舉類型（使用枚舉的序數(shù)）。
• BlobTypeHandler: 處理二進(jìn)制大對(duì)象 (BLOB)。
• ClobTypeHandler: 處理字符大對(duì)象 (CLOB)。
• SqlDateTypeHandler:處理java.sql.Date類型
• SqlTimeTypeHandler:處理java.sql.Time類型
• SqlTimestampTypeHandler:處理java.sql.Timestamp類型
• …

自定義 TypeHandler

當(dāng) MyBatis 內(nèi)置的 TypeHandler 不能滿足需求時(shí)，我們可以自定義 TypeHandler。例如：

• 處理特殊類型: 例如，將數(shù)據(jù)庫(kù)中的 JSON 字符串轉(zhuǎn)換為 Java 對(duì)象，或者將 Java 對(duì)象轉(zhuǎn)換為 JSON 字符串存儲(chǔ)到數(shù)據(jù)庫(kù)中。
• 自定義類型轉(zhuǎn)換邏輯: 例如，對(duì)日期類型進(jìn)行特殊的格式化，或者對(duì)枚舉類型使用自定義的轉(zhuǎn)換規(guī)則。

自定義 TypeHandler 的步驟

1.實(shí)現(xiàn) TypeHandler 接口: 創(chuàng)建一個(gè)類，實(shí)現(xiàn) TypeHandler 接口，并實(shí)現(xiàn)接口中的方法。

2.注冊(cè) TypeHandler: 有兩種方式注冊(cè)自定義的 TypeHandler：

• XML 配置: 在 mybatis-config.xml 文件中，使用 <typeHandlers> 標(biāo)簽注冊(cè) TypeHandler。

<typeHandlers>
  <typeHandler handler="com.example.MyTypeHandler" javaType="com.example.MyType" jdbcType="VARCHAR"/>
</typeHandlers>

• 或者使用包掃描：

 <typeHandlers>
     <package name="com.example.typehandler"/>
 </typeHandlers>

• 注解配置: 在自定義的 TypeHandler 類上使用 @MappedTypes 和 @MappedJdbcTypes 注解。

@MappedTypes(MyType.class) // 指定 Java 類型
@MappedJdbcTypes(JdbcType.VARCHAR) // 指定 JDBC 類型
public class MyTypeHandler implements TypeHandler<MyType> {
    // ... 實(shí)現(xiàn) TypeHandler 接口的方法 ...
}

3.指定jdbcType(可選): 如果MyBatis無(wú)法推斷，則必須通過(guò)jdbcType屬性為null值指定數(shù)據(jù)庫(kù)列的類型

• 示例：
• 自定義一個(gè)將數(shù)據(jù)庫(kù)中的 VARCHAR 類型轉(zhuǎn)換為 Java 中的枚舉類型的 TypeHandler:

// 假設(shè)有一個(gè)枚舉類型
public enum Status {
    ACTIVE, INACTIVE, PENDING
}

// 自定義 TypeHandler
@MappedTypes(Status.class)
@MappedJdbcTypes(JdbcType.VARCHAR)
public class StatusTypeHandler implements TypeHandler<Status> {

    @Override
    public void setParameter(PreparedStatement ps, int i, Status parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null) {
            ps.setString(i, null);
        } else {
            ps.setString(i, parameter.name()); // 將枚舉的名稱存儲(chǔ)到數(shù)據(jù)庫(kù)
        }
    }

    @Override
    public Status getResult(ResultSet rs, String columnName) throws SQLException {
        String value = rs.getString(columnName);
        return getStatus(value);
    }

    @Override
    public Status getResult(ResultSet rs, int columnIndex) throws SQLException {
        String value = rs.getString(columnIndex);
         return getStatus(value);
    }

    @Override
    public Status getResult(CallableStatement cs, int columnIndex) throws SQLException {
        String value = cs.getString(columnIndex);
        return getStatus(value);
    }
    
    private Status getStatus(String value){
         if (value == null) {
            return null;
        }
        try {
            return Status.valueOf(value); // 根據(jù)名稱從數(shù)據(jù)庫(kù)中獲取枚舉值
        } catch (IllegalArgumentException e) {
            return null; // 或者拋出異常
        }
    }
}

// 在 mybatis-config.xml 中注冊(cè) TypeHandler
<typeHandlers>
  <typeHandler handler="com.example.StatusTypeHandler"/>
</typeHandlers>

// 或者在 Mapper XML 文件中使用
<resultMap id="userResultMap" type="User">
    <result property="status" column="status" javaType="com.example.Status" jdbcType="VARCHAR" typeHandler="com.example.StatusTypeHandler"/>
</resultMap>

總結(jié)

TypeHandler 是 MyBatis 中用于處理 Java 類型與 JDBC 類型之間轉(zhuǎn)換的關(guān)鍵組件。

MyBatis 內(nèi)置了許多常用的 TypeHandler，在大多數(shù)情況下，我們可以直接使用內(nèi)置的 TypeHandler。

當(dāng)需要處理特殊類型或自定義類型轉(zhuǎn)換邏輯時(shí)，我們可以自定義 TypeHandler，并通過(guò) XML 配置或注解的方式注冊(cè)自定義的 TypeHandler。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論