建立TypeHandler

我們知道java有java的數據類型，數據庫有數據庫的數據類型，那么我們在往數據庫中插入數據的時候是如何把java類型當做數據庫類型插入數據庫，在從數據庫讀取數據的時候又是如何把數據庫類型當做java類型來處理呢？這中間必然要經過一個類型轉換。在Mybatis中我們可以定義一個叫做TypeHandler類型處理器的東西，通過它可以實現Java類型跟數據庫類型的相互轉換。下面將就如何建立自己的TypeHandler做一個簡要介紹。

TypeHandler接口

???????在Mybatis中要實現自己的TypeHandler就需要實現Mybatis為我們提供的TypeHandler接口。在TypeHandler中定義了四個方法：

public interface TypeHandler<T> { /** * 用于定義在Mybatis設置參數時該如何把Java類型的參數轉換為對應的數據庫類型 * @param ps 當前的PreparedStatement對象 * @param i 當前參數的位置 * @param parameter 當前參數的Java對象 * @param jdbcType 當前參數的數據庫類型 * @throws SQLException */ void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException; /** * 用于在Mybatis獲取數據結果集時如何把數據庫類型轉換為對應的Java類型 * @param rs 當前的結果集 * @param columnName 當前的字段名稱 * @return 轉換后的Java對象 * @throws SQLException */ T getResult(ResultSet rs, String columnName) throws SQLException; /** * 用于在Mybatis通過字段位置獲取字段數據時把數據庫類型轉換為對應的Java類型 * @param rs 當前的結果集 * @param columnIndex 當前字段的位置 * @return 轉換后的Java對象 * @throws SQLException */ T getResult(ResultSet rs, int columnIndex) throws SQLException; /** * 用于Mybatis在調用存儲過程后把數據庫類型的數據轉換為對應的Java類型 * @param cs 當前的CallableStatement執行后的CallableStatement * @param columnIndex 當前輸出參數的位置 * @return * @throws SQLException */ T getResult(CallableStatement cs, int columnIndex) throws SQLException; }

現在假設我們有一個實體對象User，其中有一個屬性interests是String數組類型，如下所示：

public class User { private int id; private String name; private int age; private String[] interests; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public String[] getInterests() { return interests; } public void setInterests(String[] interests) { this.interests = interests; } @Override public String toString() { return "User [age=" + age + ", id=" + id + ", interests=" + Arrays.toString(interests) + ", name=" + name + "]"; } }

我們需要把它以拼接字符串的形式存到數據庫中，然后在取出來的時候又把它還原為一個String數組。這個時候我們就可以給它定義一個TypeHandler專門來處理String數組類型和數據庫VARCHAR類型的相互轉換。在這里我們建立一個名叫StringArrayTypeHandler的TypeHandler，代碼如下所示：

package com.tiantian.mybatis.handler; import java.sql.CallableStatement; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Types; import org.apache.ibatis.type.JdbcType; import org.apache.ibatis.type.TypeHandler; public class StringArrayTypeHandler implements TypeHandler<String[]> { public String[] getResult(ResultSet rs, String columnName) throws SQLException { String columnValue = rs.getString(columnName); return this.getStringArray(columnValue); } public String[] getResult(ResultSet rs, int columnIndex) throws SQLException { String columnValue = rs.getString(columnIndex); return this.getStringArray(columnValue); } public String[] getResult(CallableStatement cs, int columnIndex) throws SQLException { // TODO Auto-generated method stub String columnValue = cs.getString(columnIndex); return this.getStringArray(columnValue); } public void setParameter(PreparedStatement ps, int i, String[] parameter, JdbcType jdbcType) throws SQLException { if (parameter == null) ps.setNull(i, Types.VARCHAR); else { StringBuffer result = new StringBuffer(); for (String value : parameter) result.append(value).append(","); result.deleteCharAt(result.length()-1); ps.setString(i, result.toString()); } } private String[] getStringArray(String columnValue) { if (columnValue == null) return null; return columnValue.split(","); } }

BaseTypeHandler抽象類

???????在實現自己的TypeHandler時，除了上面提到的實現最原始的接口之外，Mybatis還為我們提供了一個實現了TypeHandler接口的抽象類BaseTypeHandler。所以我們也可以通過繼承BaseTypeHandler來實現自己的TypeHandler。

???????我們先來看一下BaseTypeHandler類的定義：

public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> { protected Configuration configuration; public void setConfiguration(Configuration c) { this.configuration = c; } public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException { if (parameter == null) { if (jdbcType == null) { throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters."); } try { ps.setNull(i, jdbcType.TYPE_CODE); } catch (SQLException e) { throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . " + "Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. " + "Cause: " + e, e); } } else { setNonNullParameter(ps, i, parameter, jdbcType); } } public T getResult(ResultSet rs, String columnName) throws SQLException { T result = getNullableResult(rs, columnName); if (rs.wasNull()) { return null; } else { return result; } } public T getResult(ResultSet rs, int columnIndex) throws SQLException { T result = getNullableResult(rs, columnIndex); if (rs.wasNull()) { return null; } else { return result; } } public T getResult(CallableStatement cs, int columnIndex) throws SQLException { T result = getNullableResult(cs, columnIndex); if (cs.wasNull()) { return null; } else { return result; } } public abstract void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException; public abstract T getNullableResult(ResultSet rs, String columnName) throws SQLException; public abstract T getNullableResult(ResultSet rs, int columnIndex) throws SQLException; public abstract T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException; }

我們可以看到BaseTypeHandler對TypeHandler接口的四個方法做了一個簡單的選擇，把null值的情況都做了一個過濾，核心的取值和設值的方法還是抽象出來了供子類來實現。使用BaseTypeHandler還有一個好處是它繼承了另外一個叫做TypeReference的抽象類，通過TypeReference的getRawType()方法可以獲取到當前TypeHandler所使用泛型的原始類型。這對Mybatis在注冊TypeHandler的時候是非常有好處的。在沒有指定javaType的情況下，Mybatis在注冊TypeHandler時可以通過它來獲取當前TypeHandler所使用泛型的原始類型作為要注冊的TypeHandler的javaType類型，這個在講到Mybatis注冊TypeHandler的方式時將講到。

???????當通過繼承BaseTypeHandler來實現自己的TypeHandler時，我們的StringArrayTypeHandler應該這樣寫：

public class StringArrayTypeHandler extends BaseTypeHandler<String[]> { @Override public String[] getNullableResult(ResultSet rs, String columnName) throws SQLException { return getStringArray(rs.getString(columnName)); } @Override public String[] getNullableResult(ResultSet rs, int columnIndex) throws SQLException { return this.getStringArray(rs.getString(columnIndex)); } @Override public String[] getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { return this.getStringArray(cs.getString(columnIndex)); } @Override public void setNonNullParameter(PreparedStatement ps, int i, String[] parameter, JdbcType jdbcType) throws SQLException { //由于BaseTypeHandler中已經把parameter為null的情況做了處理，所以這里我們就不用再判斷parameter是否為空了，直接用就可以了 StringBuffer result = new StringBuffer(); for (String value : parameter) result.append(value).append(","); result.deleteCharAt(result.length()-1); ps.setString(i, result.toString()); } private String[] getStringArray(String columnValue) { if (columnValue == null) return null; return columnValue.split(","); } }

?

?

?

?

?

注冊TypeHandler

???????建立了自己的TypeHandler之后就需要把它注冊到Mybatis的配置文件中，讓Mybatis能夠識別并使用它。注冊TypeHandler主要有兩種方式，一種是通過在Mybatis配置文件中定義typeHandlers元素的子元素typeHandler來注冊；另一種是通過在Mybatis配置文件中定義typeHandlers元素的子元素package來注冊。使用typeHandler子元素注冊時一次只能注冊一個TypeHandler，而使用package子元素注冊時，Mybatis會把指定包里面的所有TypeHandler都注冊為TypeHandler。使用typeHandler子元素注冊時我們需要通過它的handler屬性來指明當前要注冊的TypeHandler的全名稱，這個屬性是必須要的。另外還有兩個附加屬性可以指定，一個是javaType，用以指定對應的java類型；另一個是jdbcType，用以指定對應的jdbc類型。使用package子元素注冊時需要我們通過它的name屬性來指定要掃描的包，如果這個時候我們也需要指定對應TypeHandler的javaType和jdbcType的話就需要我們在TypeHandler類上使用注解來定義了。Mybatis注冊TypeHandler最基本的方式就是建立一個javaType、jdbcType和TypeHandler的對應關系。在使用typeHandler子元素進行注冊的時候，有三種類型的注冊方式：

1.如果我們指定了javaType和jdbcType，那么Mybatis會注冊一個對應javaType和jdbcType的TypeHandler。

2.如果我們只指定了javaType屬性，那么這個時候又分兩種情況：

（1）如果我們通過注解的形式在TypeHandler類上用@MappedJdbcTypes指定了對應的jdbcType，那么Mybatis會一一注冊指定的javaType、jdbcType和TypeHandler的組合，也包括使用這種形式指定了jdbcType為null的情況?，F假設我們有如下這樣一個StringArrayTypeHandler：

?

@MappedJdbcTypes({JdbcType.VARCHAR}) public class StringArrayTypeHandler implements TypeHandler<String[]> { //..中間的實現代碼省略了 //.. }

然后我們在Mybatis的配置文件中這樣注冊它：

<typeHandlers> <typeHandler handler="com.tiantian.mybatis.handler.StringArrayTypeHandler" javaType="[Ljava.lang.String;"/> </typeHandlers>

則Mybatis在實際注冊的時候是以javaType為String數組，jdbcType為VARCHAR來注冊StringArrayTypeHandler的。

?

轉載于:https://www.cnblogs.com/Dhouse/p/5977039.html

總結

以上是生活随笔為你收集整理的mybatis typehandler的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。