在MyBatis中使用自定義的JsonTypeHandler

在處理數據庫中的JSON字段時，我們經常需要將JSON字符串映射到Java對象，或者將Java對象序列化為JSON字符串以存儲在數據庫中。MyBatis作為一個流行的Java持久層框架，允許我們通過自定義類型處理器（TypeHandler）來實現這種映射。

在本篇博客中，我們將介紹如何創建一個基于Jackson庫的自定義JsonTypeHandler，并將其集成到MyBatis中。

步驟 1: 添加依賴

首先，確保你的項目中已經包含了Jackson庫和MyBatis的依賴。如果你使用Maven，可以在pom.xml文件中添加以下依賴：

<!-- Jackson for JSON processing -->
<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.0</version> <!-- 使用最新版本 -->
</dependency><!-- MyBatis -->
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.9</version> <!-- 使用最新版本 -->
</dependency>

步驟 2: 創建自定義JsonTypeHandler

接下來，創建一個實現了MyBatis TypeHandler接口的自定義類型處理器。我們將使用Jackson的ObjectMapper來進行JSON的序列化和反序列化。

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;import java.io.IOException;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;public class JsonTypeHandler<T> extends BaseTypeHandler<T> {private static final ObjectMapper objectMapper = new ObjectMapper();private final Class<T> type;public JsonTypeHandler(Class<T> type) {if (type == null) throw new IllegalArgumentException("Type argument cannot be null");this.type = type;}@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)throws SQLException {try {ps.setString(i, objectMapper.writeValueAsString(parameter));} catch (JsonProcessingException e) {throw new RuntimeException(e);}}@Overridepublic T getNullableResult(ResultSet rs, String columnName)throws SQLException {String json = rs.getString(columnName);return json == null ? null : parseJson(json);}@Overridepublic T getNullableResult(ResultSet rs, int columnIndex)throws SQLException {String json = rs.getString(columnIndex);return json == null ? null : parseJson(json);}@Overridepublic T getNullableResult(CallableStatement cs, int columnIndex)throws SQLException {String json = cs.getString(columnIndex);return json == null ? null : parseJson(json);}private T parseJson(String json) {try {return objectMapper.readValue(json, type);} catch (IOException e) {throw new RuntimeException("Error parsing JSON", e);}}
}

步驟 3: 在MyBatis配置中注冊自定義類型處理器

要在MyBatis中使用自定義類型處理器，你需要在MyBatis配置文件中注冊它。這可以通過在mybatis-config.xml文件中添加類型處理器，或者在映射器（mapper）的XML文件中直接使用類型處理器來完成。

方法 1: 在mybatis-config.xml中注冊

<configuration><!-- 其他配置 --><typeHandlers><typeHandler handler="com.example.JsonTypeHandler" javaType="com.example.YourJavaType"/></typeHandlers><!-- 其他配置 -->
</configuration>

注意：上面的配置有一個問題，因為JsonTypeHandler是一個泛型類，直接在mybatis-config.xml中注冊可能無法正確指定泛型類型。因此，你可能需要為每個要處理的Java類型創建一個具體的非泛型子類。

方法 2: 在映射器（mapper）的XML文件中使用

更常見的方法是在具體的映射器XML文件中直接使用類型處理器，并通過resultMap或sql標簽中的typeHandler屬性來指定。

<mapper namespace="com.example.YourMapper"><resultMap id="yourResultMap" type="com.example.YourType"><result column="json_column" property="yourProperty" javaType="com.example.YourJavaType"jdbcType="VARCHAR" typeHandler="com.example.specific.YourSpecificJsonTypeHandler"/></resultMap><!-- 其他SQL映射 -->
</mapper>

在這里，com.example.specific.YourSpecificJsonTypeHandler應該是JsonTypeHandler的一個非泛型子類，它指定了要處理的Java類型。

步驟 4: 創建非泛型的特定類型處理器（可選）

由于直接在XML中配置泛型類型處理器可能會遇到問題，你可能需要為每個要處理的特定類型創建一個非泛型的子類。例如：

public class YourSpecificJsonTypeHandler extends JsonTypeHandler<YourJavaType> {public YourSpecificJsonTypeHandler() {super(YourJavaType.class);}
}

然后，你可以在MyBatis的映射器XML文件中使用這個特定的類型處理器。

結論

通過創建自定義的JsonTypeHandler并將其集成到MyBatis中，你可以方便地在Java對象和JSON字符串之間進行映射，從而在處理包含JSON字段的數據庫時更加靈活和高效。記得根據你的具體需求調整類型處理器的實現和配置。