脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → MyBatis BaseTypeHandler 转换泛型 JSON

MyBatis 扩展BaseTypeHandler 转换泛型 JSON 列表的解决方法

 更新时间：2025年12月18日 08:48:04   作者：Milton  
本文详细介绍了MyBatis中处理JSON转换的bug及其解决方法,文章还介绍了如何处理抽象类和自定义对象的JSON转换,并提供了一个基类AbstractListTypeHandler作为示例,最后,文章附上了MyBatis内建的javaTypeAlias链接,感兴趣的朋友跟随小编一起看看吧

最近发现一个mybatis里面json转换的bug, 写了这么多年Java这方面还是没有理清楚, 把正确的处理方法记录一下.

一. 对象JSON转换

这个是比较简单的情况, 有通用的处理方法, 例如

用Jackson实现一个通用的 TypeHandler

@Slf4j
public class JacksonTypeHandler<T> extends BaseTypeHandler<T> {
private static ObjectMapper OBJECT_MAPPER;
private final Class<T> clazz;
public JacksonTypeHandler(Class<T> clazz) {
if (log.isTraceEnabled()) {
log.trace("JacksonTypeHandler[{}]", clazz);
}
this.clazz = clazz;
}
@Override
public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i, toJson(parameter));
}
@Override
public T getNullableResult(ResultSet rs, String columnName) throws SQLException {
return parse(rs.getString(columnName));
}
@Override
public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
return parse(rs.getString(columnIndex));
}
@Override
public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
return parse(cs.getString(columnIndex));
}
protected T parse(String json) {
if (json == null || json.isEmpty()) return null;
try {
return getObjectMapper().readValue(json, clazz);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
protected String toJson(T obj) {
try {
return getObjectMapper().writeValueAsString(obj);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
}
private static ObjectMapper getObjectMapper() {
if (null == OBJECT_MAPPER) {
OBJECT_MAPPER = new ObjectMapper();
OBJECT_MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
}
return OBJECT_MAPPER;
}
}

使用时直接指定 typeHandler 就行

<result property="groupFilter" column="group_filter" typeHandler="com.somewhere.mybatis.JacksonTypeHandler"/>

以及

#{groupFilter, typeHandler=com.somewhere.mybatis.JacksonTypeHandler},

二. 列表JSON Array转换

字段中更常见的是 List 类型的JSON Array结构, 这种情况通过扩展 BaseTypeHandler 没有通用的处理方法, 有两种实现途径

通用的TypeHandler, 需要指定javaType

用 Jackson 实现一个通用的 TypeHandler, 注意构造函数中的 clazz, 如果不指定, 在默认情况下 mybatis 传进来的是一个不带泛型参数的 List

@Slf4j
public class JacksonListTypeHandler<T> extends BaseTypeHandler<List<T>> {
private static ObjectMapper OBJECT_MAPPER;
private final TypeReference<List<T>> type;
public JacksonListTypeHandler(Class<T> clazz) {
log.info("JacksonListTypeHandler[{}]", clazz);
this.type = new TypeReference<>() {
@Override
public Type getType() {
// 返回参数化类型 List<T>
return new ParameterizedType() {
@Override
public Type[] getActualTypeArguments() {
return new Type[]{clazz};
}
@Override
public Type getRawType() {
return List.class;
}
@Override
public Type getOwnerType() {
return null;
}
};
}
};
}
@Override
public void setNonNullParameter(PreparedStatement ps, int i, List<T> parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i, toJson(parameter));
}
@Override
public List<T> getNullableResult(ResultSet rs, String columnName) throws SQLException {
return parse(rs.getString(columnName));
}
@Override
public List<T> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
return parse(rs.getString(columnIndex));
}
@Override
public List<T> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
return parse(cs.getString(columnIndex));
}
private List<T> parse(String json) {
if (json == null || json.isEmpty()) return null;
try {
return getObjectMapper().readValue(json, type);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
protected String toJson(List<T> obj) {
try {
return getObjectMapper().writeValueAsString(obj);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
}
public static ObjectMapper getObjectMapper() {
if (null == OBJECT_MAPPER) {
OBJECT_MAPPER = new ObjectMapper();
OBJECT_MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
}
return OBJECT_MAPPER;
}
}

除了用 TypeReference, 还可以用 JavaType

@Slf4j
public class ListJacksonTypeHandler<T> extends BaseTypeHandler<List<T>> {
private final JavaType type;
public ListJacksonTypeHandler(Class<T> clazz) {
log.info("ListJacksonTypeHandler[{}]", clazz);
// 创建 List<T> 类型的 JavaType
this.type = JacksonUtil.getObjectMapper()
.getTypeFactory()
.constructCollectionType(List.class, clazz);
}
// 其它一样
}

需要在 mapper 中强制指定javaType, 如果是MyBatis自带的简单类型, 可以直接用 alias(见下面的表格), 如果是自定义的对象, 则需要用对象类的完整包路径

<result property="ips" column="ips" javaType="string" typeHandler="com.somewhere.mybatis.JacksonListTypeHandler"/>

以及

#{users,javaType=string,typeHandler=com.somewhere.mybatis.JacksonListTypeHandler},

这样启动后, 如果初始化的type是正确的string 才能正确解析

2025-12-15T10:33:42.896+08:00 INFO 1 --- [some-service] [main] c.somewhere.mybatis.JacksonListTypeHandler: JacksonListTypeHandler[class java.lang.String]

抽象类, 根据对象类型实现具体的 TypeHandler

如果不在 mapper 中指定类型, 就需要在 TypeHandler 中指定, 这样就不是通用的了

写一个基类 AbstractListTypeHandler

@Slf4j
public abstract class AbstractListTypeHandler<T> extends BaseTypeHandler<List<T>> {
private static ObjectMapper OBJECT_MAPPER;
@Override
public void setNonNullParameter(PreparedStatement ps, int i, List<T> parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i, toJson(parameter));
}
@Override
public List<T> getNullableResult(ResultSet rs, String columnName) throws SQLException {
return parse(rs.getString(columnName));
}
@Override
public List<T> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
return parse(rs.getString(columnIndex));
}
@Override
public List<T> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
return parse(cs.getString(columnIndex));
}
protected List<T> parse(String json) {
if (json == null || json.isEmpty()) return null;
try {
return getObjectMapper().readValue(json, specificType());
} catch (IOException e) {
throw new RuntimeException(e);
}
}
protected String toJson(List<T> obj) {
try {
return getObjectMapper().writeValueAsString(obj);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
}
private static ObjectMapper getObjectMapper() {
if (null == OBJECT_MAPPER) {
OBJECT_MAPPER = new ObjectMapper();
OBJECT_MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
}
return OBJECT_MAPPER;
}
protected abstract TypeReference<List<T>> specificType();
}

根据具体的使用场景, 创建对应的实现类

public class ListLongTypeHandler extends AbstractListTypeHandler<Long> {
@Override
protected TypeReference<List<Long>> specificType() {
return new TypeReference<>() {};
}
}

使用时, 直接用 typeHandler 指定, 不需要指定类型

#{setIds, typeHandler=com.somewhere.mybatis.ListLongTypeHandler},
...
@Result(column="set_ids", property="setIds", typeHandler= ListLongTypeHandler.class),

附: MyBatis 内建的 javaType Alias

链接: https://mybatis.org/mybatis-3/configuration.html#typeAliases

aliasjavaType
_bytebyte
_char (since 3.5.10)char
_character (since 3.5.10)char
_longlong
_shortshort
_intint
_integerint
_doubledouble
_floatfloat
_booleanboolean
stringString
byteByte
char (since 3.5.10)Character
character (since 3.5.10)Character
longLong
shortShort
intInteger
integerInteger
doubleDouble
floatFloat
booleanBoolean
dateDate
decimalBigDecimal
bigdecimalBigDecimal
bigintegerBigInteger
objectObject
date[]Date[]
decimal[]BigDecimal[]
bigdecimal[]BigDecimal[]
biginteger[]BigInteger[]
object[]Object[]
mapMap
hashmapHashMap
listList
arraylistArrayList
collectionCollection
iteratorIterator

到此这篇关于MyBatis 扩展BaseTypeHandler 转换泛型 JSON 列表的文章就介绍到这了,更多相关java的多线程内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • springboot项目启动的时候,运行main方法报错NoClassDefFoundError问题

    springboot项目启动的时候,运行main方法报错NoClassDefFoundError问题

    这篇文章主要介绍了springboot项目启动的时候,运行main方法报错NoClassDefFoundError问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • springboot使用RedisRepository操作数据的实现

    springboot使用RedisRepository操作数据的实现

    本文主要介绍了springboot使用RedisRepository操作数据的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2022-05-05
  • Geotools实现shape文件的写入功能

    Geotools实现shape文件的写入功能

    Geotools作为开源的Java GIS三方库，已经成为GIS服务器端的主流开源库，其功能非常强大，涉及到GIS业务的方方面面，其中就包括GIS数据的读写，今天小编就借助Geotools来实现shape数据的写入，需要的朋友可以参考下
    2023-08-08
  • Springboot把外部依赖包纳入Spring容器管理的两种方式

    Springboot把外部依赖包纳入Spring容器管理的两种方式

    这篇文章主要给大家介绍了Springboot把外部依赖包纳入Spring容器管理的两种方式，Spring.factories和org.springframework.boot.autoconfigure.AutoConfiguration.imports，有感兴趣的小伙伴可以参考阅读本文
    2023-07-07
  • mybatis-plus配置控制台打印完整带参数SQL语句的实现

    mybatis-plus配置控制台打印完整带参数SQL语句的实现

    这篇文章主要介绍了mybatis-plus配置控制台打印完整带参数SQL语句，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Spring Cloud灰度部署实现过程详解

    Spring Cloud灰度部署实现过程详解

    这篇文章主要为大家介绍了Spring Cloud灰度部署实现过程详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-06-06
  • Java实现Shazam声音识别算法的实例代码

    Java实现Shazam声音识别算法的实例代码

    Shazam算法采用傅里叶变换将时域信号转换为频域信号，并获得音频指纹，最后匹配指纹契合度来识别音频。这篇文章给大家介绍Java实现Shazam声音识别算法的实例代码，需要的朋友参考下吧
    2018-09-09
  • JavaFX程序初次运行创建数据库并执行建表SQL详解

    JavaFX程序初次运行创建数据库并执行建表SQL详解

    这篇文章主要介绍了JavaFX程序初次运行创建数据库并执行建表SQL详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Java中for(;;)和while(true)的区别

    Java中for(;;)和while(true)的区别

    这篇文章主要介绍了 Java中for(;;)和while(true)的区别，文章围绕for(;;)和while(true)的相关自来哦展开详细内容，需要的小伙伴可以参考一下，希望对大家有所帮助
    2021-11-11
  • springboot+vue实现Minio文件存储的示例代码

    springboot+vue实现Minio文件存储的示例代码

    本文主要介绍了springboot+vue实现Minio文件存储的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-02-02

最新评论