MyBatis之TypeHandler用法

兩個案例輕松理解MyBatis中的

在做開發時，我們經常會遇到這樣一些問題，比如我有一個Java中的Date數據類型，我想將之存到數據庫的時候存成一個1970年至今的毫秒數，怎么實現？再比如我有一個User類，User類中有一個屬性叫做interest，這個屬性用來描述用戶的愛好，它的數據類型是一個List集合，那么我想在把這個List集合存入數據庫的時候能夠自動的變成{XXX,XXX,XXX}這樣一個字符串然后存起來，當我從數據庫讀取的時候也是讀取到這樣一個字符串，讀取成功之后再自動的將之轉為一個List集合，OK，以上兩種需求用我們傳統的數據庫讀寫操作肯定都是可以實現的，只不過工作量略大，在mybatis中有一個功能略強大的typeHandler專門用來解決數據庫中的數據類型和Java中的數據類型之間的轉化問題，那么我們今天以上面兩種需求為例，來看看typeHandler要怎么使用。如果還有小伙伴對mybatis不太熟悉，建議先閱讀一下前面幾篇博客（初識mybatis/初識mybatis(二)/mybatis常用配置/mybatis映射器配置細則），本文的內容將在前面幾篇博客的基礎上展開，當然如果小伙伴有mybatis基礎，那直接往下看即可。
事實上，mybatis本身已經為我們提供了許多typeHandler了，系統提供的typeHandler能夠滿足我們日常開發中的大部分需求，如上這兩種特殊的需求就需要我們自己去定義typeHandler了。

日期的轉換

先來看日期的轉換，假設我現在創建一張表，如下：

這張表中有一個字段叫做regTime，這個字段表示用戶的注冊時間，它的數據類型為varchar，OK，然后我再在Java中定義一個實體類：

public class User {
    private Long id;
    private String username;
    private String password;
    private Date regTime;
	//省略getter/setter
}

這個JavaBean中也有一個regTime字段，不同的是這里的數據類型是Date，OK，如果我不做任何特殊處理，直接像初識mybatis(二)這篇博客中介紹的那樣向數據庫插入數據，也是可以插入成功的，但是插入成功后是這樣：

這個當然不是我想要的，我希望存到數據庫里的是這樣的：

就是我直接向數據庫寫數據，要寫的是一個Date對象，但是寫到數據庫之后這個Date對象就變成了Date對象所描述的時間到1970年的秒數了，然后當我從數據庫讀取這個秒數之后，系統又會自動幫我將這個秒數轉為Date對象，就是這樣兩個需求。這個時候，我們要做的事情其實很簡單，那就是自定義typeHandler，自定義typeHandler我們有兩種方式，一種是實現TypeHandler接口，還有一種簡化的寫法就是繼承自BaseTypeHandler類，我這里先以第二種為例來進行說明。

自定義typeHandler繼承自BaseTypeHandler

@MappedJdbcTypes({JdbcType.VARCHAR})
@MappedTypes({Date.class})
public class MyDateTypeHandler extends BaseTypeHandler<Date> {
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException {
        preparedStatement.setString(i, String.valueOf(date.getTime()));
    }

    public Date getNullableResult(ResultSet resultSet, String s) throws SQLException {
        return new Date(resultSet.getLong(s));
    }

    public Date getNullableResult(ResultSet resultSet, int i) throws SQLException {
        return new Date(resultSet.getLong(i));
    }

    public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        return callableStatement.getDate(i);
    }
}

關於這個類我說如下幾點：

1.@MappedJdbcTypes定義的是JdbcType類型，這里的類型不可自己隨意定義，必須要是枚舉類org.apache.ibatis.type.JdbcType所枚舉的數據類型。
2.@MappedTypes定義的是JavaType的數據類型，描述了哪些Java類型可被攔截。
3.在我們啟用了我們自定義的這個TypeHandler之后，數據的讀寫都會被這個類所過濾
4.在setNonNullParameter方法中，我們重新定義要寫往數據庫的數據。
5.在另外三個方法中我們將從數據庫讀出的數據類型進行轉換。

在Mapper中進行配置

自定義好了typeHandler之后，接下來我們需要在userMapper.xml中進行簡單的配置，首先我們可以像上文說的，配置resultMap，如下：

<resultMap id="userResultMap" type="org.sang.bean.User">
        <result typeHandler="org.sang.db.MyDateTypeHandler" column="regTime" javaType="java.util.Date"
                jdbcType="VARCHAR"
                property="regTime"/>
    </resultMap>

配置resultMap的時候我們指定了javaType和jdbcType，同時也指定了處理的typeHandler，然后在select中使用這個resultMap：

<select id="getUser" resultMap="userResultMap">
        select * from user4
    </select>

但是這種方式有一個缺點那就是只適用於查詢操作，即在查詢的過程中系統會啟用我們自定義的typeHandler，會將秒數轉為Date對象，但是在插入的時候卻不會啟用我們自定義的typeHandler，想要在插入的時候啟用自定義的typeHandler，需要我們在insert節點中簡單配置一下，如下：

<insert id="insertUser" parameterType="org.sang.bean.User">
        INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,javaType=Date,jdbcType=VARCHAR,typeHandler=org.sang.db.MyDateTypeHandler})
    </insert>

也可以只配置javaType和jdbcType，如下：

<insert id="insertUser2">
        INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,javaType=Date,jdbcType=VARCHAR})
    </insert>

或者只配置typeHandler：

<insert id="insertUser3">
        INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,typeHandler=org.sang.db.MyDateTypeHandler})
    </insert>

這三種效果都是一樣的，都是在插入的時候將數據Date對象轉為秒數。OK，如此之后，我們就可以實現將Date對象插入數據庫之后變秒數以及將數據庫中的秒數讀取之后自動轉為Date對象了。我們來看一個簡單的測試：

    @Test
    public void test2() {
        SqlSession sqlSession = null;
        try {
            sqlSession = DBUtils.openSqlSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = new User();
            user.setPassword("222222");
            user.setUsername("李四");
            Date regTime = new Date();
            user.setRegTime(regTime);
            userMapper.insertUser(user);
            sqlSession.commit();
        } catch (Exception e) {
            e.printStackTrace();
            sqlSession.rollback();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
        }

    }

插入結果如下：

讀取代碼：

@Test
    public void test1() {
        SqlSession sqlSession = null;
        try {
            sqlSession = DBUtils.openSqlSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            List<User> list = userMapper.getUser();
            for (User user : list) {
                System.out.println(user);
            }
            sqlSession.commit();
        } catch (Exception e) {
            e.printStackTrace();
            sqlSession.rollback();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
        }

    }

讀取結果如下：

OK，結果上面幾步配置我們就完美的解決了讀寫時的數據轉換問題了，讀取時的數據轉換除了我們上面介紹的定義resultMap然后在select節點中引用這種方式之外，也可以使用下面這種方式，注意下面這種方式只能解決讀取時的數據轉換問題

在配置文件中注冊typeHandler

我們需要在我們的mybatis配置文件中注冊typeHandler，注冊有兩種不同的方式，可以像下面這樣一個類一個類的注冊：

<typeHandlers>
        <typeHandler handler="org.sang.db.MyDateTypeHandler"/>
    </typeHandlers>

也可以直接注冊一個包中所有的typeHandler，系統在啟動時會自動掃描包下的所有文件，如下：

<typeHandlers>
        <package name="org.sang.db"/>
    </typeHandlers>

這樣配置完成之后，我們的目的就達到了，當我們進行數據庫的讀取操作的時候，秒數就會自動轉為Date對象。

小結

OK，經過上面的介紹，想必小伙伴對typeHandler的使用已經有一定了解了，總結一下就是讀取時的配置要和插入時的配置分貝來做，讀取時數據轉換我們有兩種配置方式，分別是resultMap和在mybatis配置文件中配置typeHandlers，插入時的配置就是在insert節點中進行配置。

List集合的轉換

OK，如果小伙伴們學會了如何把Date轉為秒數，那么對於List集合的轉換我就不再贅述了，道理都是一樣的，大家可以可以直接在文末下載Demo，Demo中有List集合轉換的案例。
這里給大家看兩張效果圖吧：
List集合存入數據庫之后變成這樣：

讀取出來之后又自動轉為List集合了，下圖是查詢操作，實體類，和查詢結果：

OK，以上就是我們對typeHandler的一個簡單介紹。

本文案例下載：
本文案例GitHub地址https://github.com/lenve/JavaEETest/tree/master/Test27-mybatis6。